문서 스타일 가이드

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

이 문서는 문법, 서식 등 GitLab 문서의 표준을 정의합니다. 특정 단어에 대한 지침은 단어 목록 을 참고합니다. GitLab 보이스 # GitLab 브랜드 가이드라인은 조직 전체에서 사용하는 보이스 를 정의합니다. 이 지침을 바탕으로 GitLab 문서의 보이스는 간결하고, 직접적이며, 정확하고자 합니다. 검색하고 훑어보기 쉬운 정보를 제공하는 것이 목표입니다. 문서의 보이스는 대화하듯 자연스러우면서도 짧아야 하고, 친근하면서도 간결해야 합니다. 문서는 단일 진실 공급원(SSoT)입니다 # GitLab 문서는 구현, 사용, 문제 해결과 관련된 모든 제품 정보의 SSoT입니다. 문서는 계속 발전합니다. 새로운 제품과 기능이 추가될 때마다, 그리고 명확성, 정확성, 완결성을 높이기 위해 갱신됩니다. 이 정책은 다음과 같은 효과가 있습니다. 정보 사일로를 방지하고 GitLab 제품에 대한 정보를 더 쉽게 찾을 수 있게 합니다. 문서의 여러 위치에 콘텐츠를 중복해서 둘 수 없다는 뜻은 아닙니다. 주제 유형 # GitLab은 주제 유형 을 사용해 제품 문서를 구성합니다. 주제 유형은 사용자가 정보를 더 빠르게 이해하도록 돕습니다. 또한 다음과 같은 문제를 해결하는 데 도움이 됩니다. 콘텐츠를 찾기 어렵습니다. GitLab 문서는 방대하며 유용한 정보를 많이 담고 있습니다. 주제 유형은 반복되는 패턴을 만들어 콘텐츠를 훑어보고 파악하기 쉽게 합니다. 콘텐츠가 기여자의 관점에서 작성되는 경우가 많습니다. GitLab 문서는 다양한 기여자가 작성합니다. 주제 유형(특히 작업)은 기능이 어떻게 구현되었는지를 기록하는 대신, 다른 사람을 돕는 데 맞춘 형식으로 정보를 정리하도록 돕습니다. 문서 우선 방법론 # 제품 문서는 완전하고 신뢰할 수 있는 자료여야 합니다. 질문의 답이 문서에 있다면 정보를 다시 풀어 쓰지 말고 문서 링크를 공유합니다. GitLab 문서에 없는 정보를 발견하면 머지 리퀘스트(MR)를 만들어 문서에 그 정보를 추가합니다. 그런 다음 MR을 공유해 정보를 전달합니다. 문서에 정보를 반사적으로 더 많이 추가할수록 문서는 다른 사람이 작업을 효율적으로 수행하고 문제를 해결하는 데 더 큰 도움이 됩니다. 현지화를 위한 글쓰기 # GitLab은 글로벌 독자를 위해 글을 쓰는 데 도움이 되는 지침을 따릅니다. GitLab 보이스 는 번역을 염두에 두고 명확하고 직접적으로 쓰도록 요구합니다. 스타일 가이드, 단어 목록 , Vale 규칙 은 문서의 일관성을 보장합니다. 문서를 다른 언어로 번역할 때는 각 단어의 의미가 분명해야 합니다. 기계 번역, GitLab Duo Chat, 기타 AI 도구의 사용이 늘어나면서 일관성은 더욱 중요해졌습니다. 다음 규칙은 문서를 더 효율적으로 번역하는 데 도움이 됩니다. 피해야 할 표현은 다음과 같습니다. there is 및 there are 처럼 주어를 숨기는 표현. it 처럼 모호한 대명사. -ing 로 끝나는 단어. since 와 because 처럼 서로 혼동될 수 있는 단어. e.g. , i.e. 같은