문서 주제 유형 (CTRT)

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

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

기술 문서 팀은 때때로 주제 유형을 나타내기 위해 ‘CTRT’ 라는 약어를 사용합니다. 이 약어는 각 주제 유형의 첫 글자를 참조합니다.

다른 페이지 및 주제 유형

네 가지 주요 주제 유형 이외에도 다음을 사용할 수 있습니다:

피해야 할 페이지 및 주제

다음을 피해야 합니다:

  • 다른 페이지로의 링크만 있는 페이지. 탐색을 돕는 최상위 페이지를 제외한 모든 예외.
  • 두 문장 이하인 주제. 이러한 경우:
    • 정보를 다른 주제에 통합합니다.
    • 문장이 다른 페이지로 연결되는 경우, 관련 주제 링크를 대신 사용합니다.

주제 제목 지침

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

  • 명확하고 직접적으로 작성하십시오. 각 단어가 의미를 가져야 합니다.
  • 가능한 경우 70자 미만으로 작성합니다. markdownlint 규칙: line-length (MD013)
  • 조사 및 전치사를 사용합니다.
  • 대문자 사용 지침을 따릅니다.
  • 이전 주제 제목에서 텍스트를 반복하지 마십시오. 예를 들어, 페이지가 병합 요청에 관한 경우 Troubleshooting merge requests 대신에 Troubleshooting 만 사용합니다.
  • 정보를 구분하는 데 하이픈을 사용하지 않습니다. 예를 들어 내부 분석 - 구조 대신 내부 분석 구조 또는 내부 분석의 구조를 사용합니다.

Markdown에서 제목 레벨에 대한 가이드라인도 참조하십시오.

관련 주제

인라인 링크가 충분하지 않은 경우 관련 주제라는 주제를 생성하고 관련 주제의 정렬되지 않은 목록을 포함할 수 있습니다. 이 주제는 문제 해결 섹션 위에 있어야 합니다.

이 섹션의 링크는 간결하고 스캔하기 쉬워야 합니다. 일반적으로 문장이 아니므로 마침표로 끝나지 않아야 합니다. 

## 관련 주제

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