BazelCon 2025 등록 및 CFP가 시작되었습니다.

이 페이지는 Cloud Translation API를 통해 번역되었습니다.

Bazel 문서 스타일 가이드

문제 신고 소스 보기 나이틀리 빌드 · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

Bazel 문서에 기여해 주셔서 감사합니다. 이 가이드는 시작하는 데 도움이 되는 간단한 문서 스타일 가이드입니다. 이 가이드에서 답변하지 않는 스타일 관련 질문은 Google 개발자 문서 스타일 가이드를 따르세요.

원칙 정의

Bazel 문서는 다음 원칙을 준수해야 합니다.

간결성. 단어를 최대한 적게 사용합니다.
명확함 쉬운 언어를 사용하세요. 5학년 수준의 독자를 위해 전문 용어를 사용하지 않고 작성해 줘.
일관성 문서 전체에서 반복되는 개념에 동일한 단어나 문구를 사용합니다.
정답입니다. 시간 기반 정보와 미래에 대한 약속을 피하여 콘텐츠가 최대한 오랫동안 정확하게 유지되도록 작성합니다.

쓰기

이 섹션에는 기본적인 글쓰기 도움말이 포함되어 있습니다.

제목

페이지 수준 제목은 H2부터 시작합니다. (H1 제목은 페이지 제목으로 사용됩니다.)
헤더는 적절한 수준으로 짧게 만듭니다. 이렇게 하면 래핑 없이 목차에 맞게 표시됩니다.
- 예: 권한
- 아니요: 권한에 관한 간략한 참고사항
제목에는 문장 첫 글자를 대문자로 표기하는 규칙을 사용합니다.
- 예: 작업공간 설정
- 아니요: 작업공간 설정
제목을 작업 기반 또는 실행 가능한 제목으로 만드세요. 제목이 개념적인 경우 이해를 기반으로 할 수 있지만 사용자가 하는 일에 맞춰 작성하세요.
- 예: 그래프 순서 유지
- 아니요: 그래프 순서 유지

이름

Bazel, Starlark와 같은 고유 명사는 대문자로 시작합니다.
- 예: 빌드가 끝나면 Bazel이 요청된 타겟을 출력합니다.
- 아니요: 빌드가 끝나면 bazel이 요청된 타겟을 출력합니다.
일관성을 유지하세요. 기존 개념에 새로운 이름을 도입하지 마세요. 해당하는 경우 용어집에 정의된 용어를 사용합니다.
- 예를 들어 터미널에서 명령어를 실행하는 것에 대해 작성하는 경우 페이지에서 터미널과 명령줄을 모두 사용하지 마세요.

페이지 범위

각 페이지에는 하나의 목적이 있어야 하며 이는 시작 부분에 정의되어야 합니다. 이를 통해 독자는 필요한 정보를 더 빠르게 찾을 수 있습니다.
- 예: 이 페이지에서는 Windows에 Bazel을 설치하는 방법을 설명합니다.
- 아니요: (소개 문장이 없습니다.)
페이지 끝에서 독자에게 다음으로 할 일을 알려줍니다. 명확한 작업이 없는 페이지의 경우 유사한 개념, 예시 또는 탐색을 위한 기타 방법을 링크로 포함할 수 있습니다.

제목

Bazel 문서에서 잠재고객은 주로 사용자, 즉 Bazel을 사용하여 소프트웨어를 빌드하는 사람이어야 합니다.

독자를 'you'로 지칭합니다. (어떤 이유로든 'you'를 사용할 수 없는 경우 'they'와 같은 중성적인 표현을 사용하세요.)
- 예: Bazel을 사용하여 Java 코드를 빌드하려면 JDK를 설치해야 합니다.
- MAYBE: 사용자가 Bazel로 Java 코드를 빌드하려면 JDK를 설치해야 합니다.
- 아니요: 사용자가 Bazel로 Java 코드를 빌드하려면 JDK를 설치해야 합니다.
잠재고객이 일반 Bazel 사용자가 아닌 경우 페이지 또는 섹션 시작 부분에 잠재고객을 정의합니다. 기타 대상에는 유지관리자, 기여자, 이전자 또는 기타 역할이 포함될 수 있습니다.
'저희'를 사용하지 마세요. 사용자 문서에는 작성자가 없습니다. 가능한 작업을 설명하기만 하면 됩니다.
- 예: Bazel이 발전함에 따라 호환성을 유지하려면 코드베이스를 업데이트해야 합니다.
- 아니요: Bazel은 진화하고 있으며, 때로는 호환되지 않아 Bazel 사용자의 변경이 필요한 Bazel 변경사항이 적용될 예정입니다.

Temporal

가능한 경우 특정 날짜 (2022년 2분기)를 언급하거나 '지금', '현재', '곧'과 같이 시간과 관련된 용어는 사용하지 마세요. 이러한 데이터는 빠르게 오래되어 미래 예측인 경우 정확하지 않을 수 있습니다. 대신 'Bazel X.x 이상에서 <기능>을 지원합니다'와 같은 버전 수준을 지정하거나 GitHub 문제 링크를 지정하세요.

예: Bazel 0.10.0 이상에서는 원격 캐싱을 지원합니다.
아니요: Bazel은 곧 원격 캐싱을 지원할 예정입니다(2017년 10월 예정).

긴장감 있는 음악

현재 시제를 사용하세요. 명확성을 위해 꼭 필요한 경우가 아니라면 과거 또는 미래 시제는 사용하지 마세요.
- 예: 이 규칙을 준수하지 않는 종속 항목이 발견되면 Bazel에서 오류를 발생시킵니다.
- 아니요: Bazel이 이 규칙을 준수하지 않는 종속 항목을 찾으면 Bazel에서 오류를 발생시킵니다.
가능한 경우 수동태 (주체가 객체에 의해 행동을 받는 경우)가 아닌 능동태 (주체가 객체에 대해 행동하는 경우)를 사용하세요. 일반적으로 능동태는 책임자를 보여주기 때문에 문장을 더 명확하게 만듭니다. 능동태를 사용하면 명확성이 떨어지는 경우 수동태를 사용합니다.
- 예: Bazel이 X를 시작하고 출력을 사용하여 Y를 빌드합니다.
- 아니요: X는 Bazel에 의해 시작되고 이후 Y는 출력을 사용하여 빌드됩니다.

어조

비즈니스 친화적인 어조로 작성해 줘.

구어체는 피하세요. 영어에만 있는 구문은 번역하기가 더 어렵습니다.
- 예: 좋은 규칙 집합
- 아니요: 그렇다면 좋은 규칙 세트란 무엇인가요?
지나치게 격식 있는 표현은 피하세요. 기술에 관심이 있지만 세부사항은 모르는 사람에게 개념을 설명하는 것처럼 작성하세요.

형식 지정

파일 형식

가독성을 위해 80자에서 줄을 바꿉니다. 긴 링크나 코드 스니펫은 더 길어도 되지만 새 줄에서 시작해야 합니다. 예를 들면 다음과 같습니다.

링크

'여기' 또는 '아래' 대신 설명이 포함된 링크 텍스트를 사용합니다. 이렇게 하면 문서를 더 쉽게 살펴볼 수 있고 화면 리더에도 더 좋습니다.
- 예: 자세한 내용은 [Bazel 설치]를 참고하세요.
- 아니요: 자세한 내용은 [여기]를 참고하세요.
가능하면 링크로 문장을 끝내세요.
- 예: 자세한 내용은 [링크]를 참고하세요.
- 아니요: 자세한 내용은 [링크] 를 참고하세요.

순서가 지정된 목록을 사용하여 단계를 통해 작업을 완료하는 방법을 설명합니다.
할 일 기반이 아닌 항목을 나열할 때는 순서가 지정되지 않은 목록을 사용합니다. (알파벳순, 중요도 등과 같은 순서가 있어야 함)
병렬 구조로 작성합니다. 예를 들면 다음과 같습니다.
1. 모든 목록 항목을 문장으로 만드세요.
2. 동일한 시제의 동사로 시작합니다.
3. 따라야 할 단계가 있는 경우 순서가 지정된 목록을 사용합니다.

자리표시자

사용자가 변경해야 하는 변수를 나타내려면 꺾쇠 괄호를 사용하세요. 마크다운에서는 꺾쇠 괄호를 백슬래시(\<example\>)로 이스케이프 처리합니다.
- 예: bazel help <command>: <command>의 도움말과 옵션을 출력합니다.
- 아니요: bazel help command: 'command'의 도움말과 옵션을 출력합니다.
특히 복잡한 코드 샘플의 경우 컨텍스트에 적합한 자리표시자를 사용하세요.

코드

코드 샘플은 개발자에게 가장 유용한 리소스입니다. 이러한 코드를 작성하는 방법을 이미 알고 계실 수도 있지만 몇 가지 팁을 알려드리겠습니다.

작은 코드 스니펫을 참조하는 경우 문장에 삽입할 수 있습니다. 독자가 명령어를 복사하는 등 코드를 사용하도록 하려면 코드 블록을 사용하세요.

코드 블록

간략하게 만듭니다. 코드 샘플에서 중복되거나 불필요한 텍스트를 모두 삭제합니다.
마크다운에서 샘플의 언어를 추가하여 코드 블록의 유형을 지정합니다.

```shell
...

명령어와 출력을 서로 다른 코드 블록으로 구분합니다.

인라인 코드 서식

파일 이름, 디렉터리, 경로, 작은 코드 조각에는 코드 스타일을 사용합니다.
이탤릭체, '따옴표' 또는 굵은 글씨 대신 인라인 코드 스타일을 사용합니다.
- 예: bazel help <command>: <command>의 도움말과 옵션을 출력합니다.
- 아니요: bazel help command: 'command'의 도움말과 옵션을 출력합니다.