GitLab 문서 작성 스타일 가이드

GitLab 문서 작성 시 따라야 할 음성 및 어조, 작성 스타일, 서식, 목록, 링크, 제목, 구두점, 탐색 단계, 표, 알림, 공통 실수 등 전반적인 스타일 규칙을 설명합니다.

GitLab 문서 작성 스타일 가이드 # 출력 요구사항 # 완전한 문서를 작성하세요. 다음 스타일 가이드라인을 준수하세요. 음성 및 어조 # 기능 자체를 설명하는 것이 아니라, 사용자가 완료하려는 작업을 중심으로 작성하세요. 예를 들어, “API 키를 안전하게 저장하려면 변수를 사용하세요”와 같이 작성하고, “이 기능은 API 키를 안전하게 저장할 수 있도록 설계되었습니다”와 같이 작성하지 마세요. 마케팅 언어를 사용하지 마세요. 예를 들어 “손쉽게”, “강력하게”, “간단하게” 등의 표현은 사용하지 마세요. 작성 스타일 # 현재 시제를 사용하세요. “The system manages”와 같이 사용하고 “The system will manage”와 같이 사용하지 마세요. 능동태를 사용하세요. “The developer writes code”와 같이 사용하고 “Code is written by the developer”와 같이 사용하지 마세요. 미국식 철자법을 사용하세요. 직접적으로 표현하세요. “Use this feature to…”와 같이 사용하고 “This allows you to…” 또는 “This enables you to…”와 같이 사용하지 마세요. 간결하게 작성하세요. 불필요한 단어를 제거하세요. 줄 길이는 약 100자로 나누세요. 링크는 나누지 마세요. 가능하면 문장은 20단어 이하로 작성하세요. 복잡한 개념은 여러 문장으로 나누세요. 8학년 수준의 가독성을 목표로 하세요. GitLab 제품명 # 소유격을 사용하지 마세요. “GitLab policies”와 같이 사용하고 “GitLab’s policies”와 같이 사용하지 마세요. “GitLab Duo”로 표기하고 “Duo”로만 표기하지 마세요. “GitLab Duo Agent Platform”으로 표기하고 “DAP” 또는 “Duo Agent Platform”으로 표기하지 마세요. 오퍼링: “GitLab.com”으로 표기하고 “GitLab SaaS”로 표기하지 마세요. “GitLab Self-Managed”로 표기하고 “Self-managed”로만 표기하지 마세요. “GitLab Dedicated”로 표기하고 “Dedicated”로만 표기하지 마세요. “GitLab Dedicated for Government”로 표기하고 “Dedicated for Government”로만 표기하지 마세요. 대문자 표기 # 주제 제목: 문장 형식(Sentence case)을 사용하세요. UI 텍스트: 인터페이스에 표시된 정확한 대문자 표기를 따르세요. 기능명: 소문자를 사용하세요. 텍스트 서식 # 볼드체( 텍스트 )는 UI 요소(버튼, 메뉴, 페이지, 설정)에만 사용하세요. 인라인 코드( 텍스트 )는 명령어, 파일명, 매개변수, 키워드에 사용하세요. 키보드 입력은 다음 형식을 사용하세요: Control+C. CLI 명령어 및 여러 줄 코드에는 코드 블록을 사용하세요. 적절한 언어 식별자를 사용하세요. git commit -m "message" 목록 # 순서 없는 목록에는 “-”를 사용하고, 순