문서 주제 유형 (CTRT)

각 페이지의 주제는 다음 주제 유형 중 하나여야 합니다:

페이지가 짧더라도 일반적으로 페이지는 개념으로 시작하여 작업 또는 참조 주제를 포함합니다.

기술 서술팀은 가끔 주제 유형을 가리키기 위해 약어 CTRT를 사용합니다. 이 약어는 각 주제 유형의 첫 글자를 나타내는 것입니다.

다른 페이지 및 주제 유형

기본적인 네 가지 주제 유형 외에도 다음을 사용할 수 있습니다:

피해야 할 페이지 및 주제

다음을 피해야 합니다:

  • 다른 페이지로의 단순 링크만 있는 페이지. 유일한 예외는 네비게이션을 돕는 최상위 페이지입니다.
  • 하나 또는 두 문장만 있는 주제. 이러한 경우:
    • 정보를 다른 주제에 통합하세요.
    • 문장이 다른 페이지로 연결되는 경우, 관련 주제 링크를 대신 사용하세요.

주제 제목 가이드라인

일반적으로 주제 제목에 대해:

  • 명확하고 직접적이어야 합니다. 모든 단어가 중요해야 합니다.
  • 기사 및 전치사를 사용하세요.
  • 대문자 사용을 지침을 따르세요.
  • 이전 주제 제목에서 텍스트를 반복하지 마세요. 예를 들어, 페이지가 병합 요청에 관한 것이라면 Troubleshooting merge requests 대신 Troubleshooting만 사용하세요.
  • 정보를 분리하기 위해 하이픈을 사용하지 마세요. 예를 들어, 내부 분석 - 아키텍처 대신 내부 분석 아키텍처 또는 내부 분석 아키텍처를 사용하세요.

또한 마크다운의 제목 수준 가이드라인도 참조하세요.

관련 주제

인라인 링크만으로 충분하지 않은 경우 관련 주제라는 주제를 만들고 관련 주제의 순서 없는 목록을 포함할 수 있습니다. 이 주제는 문제 해결 섹션 위에 있어야 합니다.

이 섹션의 링크는 간결하고 쉽게 찾을 수 있어야 합니다. 일반적으로 완전한 문장이 아니므로 마침표로 끝나지 않아야 합니다. 

## 관련 주제

- [CI/CD 변수](link-to-topic)
- [환경 변수](link-to-topic)