문서 토픽 유형(CTRT)

GitLab 문서 작성 시 사용하는 Concept, Task, Reference, Troubleshooting 네 가지 토픽 유형과 관련 페이지 유형, 작성 지침을 설명합니다.

페이지의 각 토픽은 다음 토픽 유형 중 하나여야 합니다: 개념(Concept) 작업(Task) 참조(Reference) 문제 해결(Troubleshooting) 페이지가 짧더라도 일반적으로 개념으로 시작한 다음 작업 또는 참조 토픽을 포함합니다. 기술 문서 작성 팀에서는 토픽 유형을 지칭할 때 CTRT 라는 약어를 사용하기도 합니다. 이 약어는 각 토픽 유형의 첫 글자를 나타냅니다. 개요를 보려면 스타일 및 토픽 유형에 맞는 편집 을 참조하세요. 기타 페이지 및 토픽 유형 # 네 가지 기본 토픽 유형 외에 다음을 사용할 수 있습니다: 페이지 유형: 튜토리얼(Tutorial) 페이지 유형: 시작하기(Get started) 페이지 유형: 최상위 페이지(Top-level) 페이지 유형: 프롬프트 예시(Prompt example) 토픽 유형: 관련 토픽(Related topics) 페이지 또는 토픽 유형: 용어집(Glossaries) 피해야 할 페이지와 토픽 # 다음은 피해야 합니다: 다른 페이지로의 링크만으로 구성된 페이지. 유일한 예외는 탐색을 돕는 최상위 페이지입니다. 한두 문장만 있는 토픽. 이 경우: 다른 토픽에 정보를 통합하세요. 해당 문장이 다른 페이지로 연결되는 링크인 경우, 대신 관련 토픽 링크를 사용하세요. 토픽 제목 가이드라인 # 일반적으로 토픽 제목에 대해: 명확하고 직접적으로 작성하세요. 모든 단어가 의미를 가져야 합니다. 가능한 경우 70자 미만으로 유지하세요. markdownlint 규칙: line-length (MD013) 관사와 전치사를 사용하세요. 대소문자 표기 가이드라인을 따르세요. 이전 토픽 제목의 텍스트를 반복하지 마세요. 예를 들어, 페이지가 머지 리퀘스트에 관한 내용이라면 Troubleshooting merge requests 대신 Troubleshooting 만 사용하세요. 토픽 유형에 대한 구체적인 지침을 검토하세요. 예를 들어, 개념 토픽 제목 에는 Overview 또는 Introduction 을 사용하지 마세요. 정보를 구분하는 데 하이픈 사용을 피하세요. 예를 들어, Internal analytics - Architecture 대신 Internal analytics architecture 또는 Architecture of internal analytics 를 사용하세요. Markdown의 헤딩 수준 가이드라인 도 참조하세요. 관련 토픽 # 인라인 링크로 충분하지 않은 경우, Related topics 라는 섹션을 만들고 관련 토픽의 순서 없는 목록을 포함할 수 있습니다. 이 토픽은 Troubleshooting 섹션 위에 위치해야 합니다. 링크 텍스트는 간결하고 훑어보기 쉬워야 합니다. 토픽 제목(완전한 문장이 아닌)을 사용하고 마침표로 끝내지 마세요. ## Related topics - [CI/CD variables](link-to-topic.md) - [Environment variables](link-to-topic.md)