문서 스타일 가이드

문서 스타일 가이드 관련 내용을 설명합니다.

문서 스타일 가이드 # 이 문서는 문법, 서식 등 GitLab 문서의 표준을 정의합니다. 특정 단어에 대한 가이드라인은 단어 목록 을 참조하세요. GitLab의 목소리 # GitLab 브랜드 가이드라인은 조직 전체에서 사용하는 목소리 를 정의합니다. 이 가이드라인을 바탕으로, GitLab 문서의 목소리는 간결하고 직접적이며 정확하게 작성하려 합니다. 목표는 검색하고 훑어보기 쉬운 정보를 제공하는 것입니다. 문서의 목소리는 대화체이되 간략하고, 친근하되 간명해야 합니다. 문서는 단일 진실 공급원(Single Source Of Truth, SSOT) # GitLab 문서는 구현, 사용, 트러블슈팅과 관련된 모든 제품 정보의 SSOT입니다. 문서는 지속적으로 발전합니다. 새로운 제품과 기능이 추가되고, 명확성·정확성·완전성을 위한 개선이 이루어집니다. 이 정책은: 정보 사일로를 방지하고 GitLab 제품 정보를 더 쉽게 찾을 수 있도록 합니다. 문서의 여러 위치에 콘텐츠가 중복될 수 없다는 의미가 아닙니다. 주제 유형 # GitLab은 주제 유형 을 사용하여 제품 문서를 구성합니다. 주제 유형은 사용자가 정보를 더 빠르게 이해하는 데 도움이 됩니다. 또한 다음 문제를 해결하는 데 도움이 됩니다: 콘텐츠를 찾기 어렵습니다. GitLab 문서는 방대하며 유용한 정보를 대량으로 포함합니다. 주제 유형은 콘텐츠를 더 쉽게 훑어보고 파악할 수 있도록 반복 가능한 패턴을 만들어냅니다. 콘텐츠가 기여자의 관점에서 작성되는 경우가 많습니다. GitLab 문서는 다양한 기여자들이 작성합니다. 주제 유형(특히 task)은 기능이 어떻게 구현되었는지를 문서화하는 것이 아니라, 다른 사람들을 돕는 데 초점을 맞춘 형식으로 정보를 구성하는 데 도움을 줍니다. Docs-first 방법론 # 제품 문서는 완전하고 신뢰할 수 있는 리소스여야 합니다. 질문에 대한 답변이 문서에 있는 경우, 정보를 다시 설명하는 대신 문서 링크를 공유하세요. GitLab 문서에서 제공되지 않는 정보를 발견한 경우, 해당 정보를 문서에 추가하는 머지 리퀘스트(MR)를 생성하세요. 그런 다음 MR을 공유하여 정보를 전달하세요. 정보를 문서에 반사적으로 추가할수록, 문서는 다른 사람들이 효율적으로 작업을 완수하고 문제를 해결하는 데 더 많은 도움이 됩니다. 현지화를 위한 작성 # 우리는 글로벌 독자를 위해 작성하는 데 도움이 되는 가이드라인을 따릅니다. GitLab의 목소리 는 번역을 고려하여 명확하고 직접적으로 작성할 것을 요구합니다. 스타일 가이드, 단어 목록 , Vale 규칙 은 문서의 일관성을 보장합니다. 문서가 다른 언어로 번역될 때는 각 단어의 의미가 명확해야 합니다. 기계 번역, GitLab Duo Chat, 기타 AI 도구의 사용이 증가함에 따라 일관성은 더욱 중요해졌습니다. 다음 규칙은 문서를 더 효율적으로 번역하는 데 도움이 됩니다. 피해야 할 사항: there is 및 there are 와 같이 주어를 숨기는 표현. it 과 같은 모호한 대명사. -ing 으로 끝나는 단어.