Bazel 문서에 참여해 주셔서 감사합니다. 이 가이드는 시작하는 데 도움이 되는 간단한 문서 스타일 가이드 역할을 합니다. 이 가이드에서 답변하지 못한 스타일 관련 질문은 Google 개발자 문서 스타일 가이드를 따르세요.
원칙 정의
Bazel 문서는 다음 원칙을 준수해야 합니다.
- 간결함 최대한 적은 단어를 사용합니다.
- 지우기 평이한 언어를 사용하세요. 전문 용어 없이 5학년 수준으로 작성합니다.
- 일관성. 문서 전체에서 반복되는 개념에 동일한 단어 또는 문구를 사용합니다.
- 정답입니다. 시간 기반 정보와 향후 약속을 피하여 콘텐츠가 최대한 오랫동안 정확하게 유지되도록 작성합니다.
쓰기
이 섹션에는 기본적인 작성 도움말이 포함되어 있습니다.
제목
- 페이지 수준의 제목은 H2부터 시작합니다. H1 제목은 페이지 제목으로 사용됩니다.
헤더는 합리적인 수준으로 짧게 만듭니다. 이렇게 하면 래핑 없이 목차에 맞게 표시됩니다.
- 예: 권한
- 아니요: 권한에 관한 간략한 참고사항
제목에는 문장 첫 글자를 대문자로 표기합니다.
- 예: 작업공간 설정
- 아니요: Workspace 설정
제목을 작업 기반 또는 실행 가능한 형식으로 지정하세요. 제목이 개념적인 경우 이해를 기반으로 할 수 있지만 사용자가 하는 작업에 관해 작성합니다.
- 예: 그래프 순서 유지
- 아니요: 그래프 순서 유지
이름
Bazel, Starlark와 같은 고유 명사는 대문자로 작성합니다.
- 예: 빌드가 끝나면 Bazel이 요청된 타겟을 출력합니다.
- 아니요: 빌드가 끝나면 bazel이 요청된 타겟을 출력합니다.
일관성을 유지해야 합니다. 기존 개념에 새로운 이름을 도입하지 마세요. 해당하는 경우 용어집에 정의된 용어를 사용하세요.
- 예를 들어 터미널에서 명령어를 실행하는 방법을 설명하는 경우 페이지에서 터미널과 명령줄을 모두 사용하지 마세요.
페이지 범위
각 페이지에는 하나의 목적이 있어야 하며 이 목적은 처음에 정의되어야 합니다. 이를 통해 독자가 필요한 정보를 더 빠르게 찾을 수 있습니다.
- 예: 이 페이지에서는 Windows에 Bazel을 설치하는 방법을 설명합니다.
- 아니요: (서론 문구 없음)
페이지 끝에서 다음으로 할 일을 독자에게 알려줍니다. 명확한 작업이 없는 페이지의 경우 유사한 개념, 예시 또는 탐색할 수 있는 다른 방법에 대한 링크를 포함할 수 있습니다.
제목
Bazel 문서의 대상은 주로 Bazel을 사용하여 소프트웨어를 빌드하는 사용자여야 합니다.
독자를 '당신'이라고 지칭합니다. (어떤 이유로든 'you'를 사용할 수 없는 경우 'they'와 같은 성 중립적인 표현을 사용하세요.)
- 예: Bazel을 사용하여 Java 코드를 빌드하려면 JDK를 설치해야 합니다.
- 가능: 사용자가 Bazel로 Java 코드를 빌드하려면 JDK를 설치해야 합니다.
- 아니요: 사용자가 Bazel로 Java 코드를 빌드하려면 JDK를 설치해야 합니다.
일반 Bazel 사용자가 아닌 경우 페이지 시작 부분이나 섹션에서 잠재고객을 정의합니다. 다른 대상에는 유지보수자, 참여자, 이전자 또는 기타 역할이 포함될 수 있습니다.
'저희'를 사용하지 마세요. 사용자 문서에는 저자가 없습니다. 사용자에게 가능한 작업을 알려주세요.
- 예: Bazel이 발전함에 따라 호환성을 유지하기 위해 코드베이스를 업데이트해야 합니다.
- 아니요: Bazel은 계속 발전하고 있으며, Bazel을 변경할 때는 호환되지 않고 Bazel 사용자가 일부 변경해야 하는 경우가 있습니다.
시간적
가능하면 특정 날짜 (2022년 2분기)를 언급하거나 '지금', '현재', '곧'과 같이 시간에 관한 용어를 사용하지 마세요. 이러한 데이터는 빠르게 비활성화되며 향후 예측인 경우 잘못될 수 있습니다. 대신 'Bazel X.x 이상에서 <기능>을 지원합니다'와 같은 버전 수준을 지정하거나 GitHub 문제 링크를 지정하세요.
- 예: Bazel 0.10.0 이상에서는 원격 캐싱을 지원합니다.
- 아니요: Bazel은 곧 원격 캐싱을 지원할 예정입니다(2017년 10월 예정).
긴장감 있는 음악
현재 시제를 사용하세요. 명확성을 위해 꼭 필요한 경우가 아니라면 과거 시제나 미래 시제는 피하세요.
- 예: Bazel은 이 규칙을 준수하지 않는 종속 항목을 발견하면 오류를 발생시킵니다.
- 아니요: Bazel에서 이 규칙을 준수하지 않는 종속 항목을 발견하면 오류가 발생합니다.
가능하면 수동태 (주어가 객체에 작용하는 경우)가 아닌 능동태 (주어가 객체에 작용하는 경우)를 사용하세요. 일반적으로 능동태는 책임자가 누구인지를 보여주므로 문장을 더 명확하게 만듭니다. 능동태를 사용하면 명확성이 떨어지는 경우 수동태를 사용하세요.
- 예: Bazel이 X를 시작하고 출력을 사용하여 Y를 빌드합니다.
- 아니요: X는 Bazel에서 시작되고 나중에 Y가 출력으로 빌드됩니다.
분위기
비즈니스 친화적인 어조로 작성하세요.
구어체는 피하세요. 영어에만 해당하는 구문은 번역하기가 더 어렵습니다.
- 예: 올바른 규칙 집합
- 아니요: 그렇다면 좋은 규칙 집합이란 무엇인가요?
지나치게 격식 있는 표현은 피하세요. 기술에 관심이 있지만 세부정보를 모르는 사용자에게 개념을 설명하는 것처럼 작성합니다.
형식 지정
파일 형식
가독성을 위해 줄을 80자(영문 기준)로 끊습니다. 긴 링크나 코드 스니펫은 더 길 수 있지만 새 줄에서 시작해야 합니다. 예를 들면 다음과 같습니다.
링크
'여기' 또는 '아래' 대신 설명적인 링크 텍스트를 사용하세요. 이렇게 하면 문서를 더 쉽게 스캔할 수 있고 스크린 리더에 더 적합합니다.
- 예: 자세한 내용은 [Bazel 설치]를 참고하세요.
- 아니요: 자세한 내용은 [여기]를 참고하세요.
가능하면 문장을 링크로 끝맺습니다.
- 예: 자세한 내용은 [링크]를 참고하세요.
- 아니요: 자세한 내용은 [링크] 를 참고하세요.
목록
- 순서가 지정된 목록을 사용하여 단계별로 작업을 완료하는 방법을 설명합니다.
- 순서 없는 목록을 사용하여 작업 기반이 아닌 항목을 나열합니다. (알파벳순, 중요도 등과 같은 순서가 있어야 합니다.)
- 평행 구조로 작성합니다. 예를 들면 다음과 같습니다.
- 모든 목록 항목을 문장으로 만듭니다.
- 동사가 동일한 시제인 것으로 시작합니다.
- 따라야 할 단계가 있는 경우 순서가 지정된 목록을 사용하세요.
자리표시자
사용자가 변경해야 하는 변수를 나타내려면 각괄호를 사용하세요. 마크다운에서는 백슬래시(
\<example\>)를 사용하여 각괄호를 이스케이프 처리합니다.- 예:
bazel help <command>:<command>의 도움말 및 옵션을 출력합니다. - 아니요: bazel help command: 'command'의 도움말 및 옵션을 출력합니다.
- 예:
특히 복잡한 코드 샘플의 경우 맥락에 적합한 자리표시자를 사용하세요.
목차
사이트에서 지원하는 자동 생성 목차를 사용합니다. 수동 목차를 추가하지 마세요.
코드
코드 샘플은 개발자에게 최고의 친구입니다. 이미 작성하는 방법을 알고 계시겠지만 몇 가지 팁을 알려드리겠습니다.
작은 코드 스니펫을 참조하는 경우 문장에 삽입할 수 있습니다. 독자가 명령어를 복사하는 등 코드를 사용하도록 하려면 코드 블록을 사용하세요.
코드 블록
- 간략하게 만듭니다. 코드 샘플에서 중복되거나 불필요한 텍스트를 모두 삭제합니다.
- Markdown에서는 샘플의 언어를 추가하여 코드 블록의 유형을 지정합니다.
```shell
...
- 명령어와 출력을 다른 코드 블록으로 구분합니다.
인라인 코드 형식 지정
- 파일 이름, 디렉터리, 경로, 작은 코드 조각에는 코드 스타일을 사용합니다.
- 기울임꼴, '따옴표' 또는 bolding 대신 인라인 코드 스타일을 사용하세요.
- 예:
bazel help <command>:<command>의 도움말 및 옵션을 출력합니다. - 아니요: bazel help command: 'command'의 도움말 및 옵션을 출력합니다.
- 예: