InfoGrab DocsInfoGrab Docs

문서 스타일 가이드

GitLab 문서의 작성 스타일, 마크업, 서식 및 기타 표준을 설명합니다.

이 문서는 GitLab 문서의 표준을 정의합니다. 구조 # 문서 스타일 가이드는 다음 페이지로 나뉩니다. 작성 # 페이지 내용 언어 GitLab 문서의 문법, 보이스, 대소문자, 단어 선택 규칙입니다. 제품, 기능 및 표준 섹션 GitLab 문서의 제품 이름과 표준 섹션 규칙입니다. 권장 단어 목록 GitLab 문서에서 권장하는 단어 선택입니다. 텍스트 및 서식 GitLab 문서의 문장부호, 줄 길이, 굵게, 코드 등 텍스트 서식 규칙입니다. UI 요소 및 탐색 경로 GitLab 문서에서 쇼트코드로 UI 요소를 표시하는 방법입니다. 페이지 요소 # 페이지 내용 이미지, 다이어그램 및 아이콘 GitLab 문서의 스크린샷, 다이어그램, 아이콘 규칙입니다. 링크 및 비디오 GitLab 문서의 링크, 링크 텍스트, 비디오, 클릭형 데모 규칙입니다. Markdown 및 목록 GitLab 문서의 Markdown, 제목 수준, 목록 규칙입니다. 메타데이터 GitLab 문서 페이지의 프런트 매터 메타데이터입니다. 쇼트코드 및 콘텐츠 블록 GitLab 문서의 쇼트코드, 경고 상자, 탭 등 콘텐츠 블록입니다. 표 GitLab 문서에서 표를 만들고 서식을 지정하는 규칙입니다. 관련 지침 # 기능 상태와 버전 : 제공 여부 세부 정보, 기능 플래그, 실험 및 베타 기능, 지원 중단, 업그레이드 참고 사항입니다. API 및 CLI 참조 : REST API, GraphQL, GitLab CLI(glab) 문서입니다. 기타 지침 # GitLab 핸드북은 다음에 대한 지침을 제공합니다. 자주 잘못 쓰이는 용어 제3자 상표 사용 문서 스타일 가이드에 없는 지침은 다음 스타일 가이드를 따릅니다. Microsoft Writing Style Guide Google Developer Documentation Style Guide GitLab 보이스 # GitLab 브랜드 가이드라인은 조직 전체에서 사용하는 보이스 를 정의합니다. 이 지침을 바탕으로 GitLab 문서의 보이스는 간결하고, 직접적이며, 정확하고자 합니다. 검색하고 훑어보기 쉬운 정보를 제공하는 것이 목표입니다. 문서의 보이스는 대화하듯 자연스러우면서도 짧아야 하고, 친근하면서도 간결해야 합니다. 문서는 단일 진실 공급원(SSoT)입니다 # GitLab 문서는 구현, 사용, 문제 해결과 관련된 모든 제품 정보의 SSoT입니다. 문서는 계속 발전합니다. 새로운 제품과 기능이 추가될 때마다, 그리고 명확성, 정확성, 완결성을 높이기 위해 갱신됩니다. 이 정책은 다음과 같은 효과가 있습니다. 정보 사일로를 방지하고 GitLab 제품에 대한 정보를 더 쉽게 찾을 수 있게 합니다. 문서의 여러 위치에 콘텐츠를 중복해서 둘 수 없다는 뜻은 아닙니다. 주제 유형 # GitLab은 주제 유형 을 사용해 제품 문서를 구성합니다. 주제 유형은 사용자가 정보를 더 빠르게 이해하도록 돕습니다. 또한 다음과 같은 문제를 해결하는 데 도움이 됩니다. 콘텐츠를 찾기 어렵습니다. GitLab 문서는 방대하며 유용한 정보를 많이 담고 있습니다