문서 주제 유형 (CTRT)

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

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

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

다른 페이지 및 주제 유형

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

피해야 할 페이지 및 주제

다음을 피해야 합니다:

  • 다른 페이지로의 링크만 있는 페이지. 예외는 네비게이션을 돕는 최상위 페이지입니다.
  • 한 두 문장만 있는 주제. 이러한 경우에는:
    • 정보를 다른 주제에 통합합니다.
    • 문장이 다른 페이지로 연결된 경우 관련 주제 링크를 사용합니다.

주제 제목 지침

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

  • 명확하고 직접적이어야 합니다. 모든 단어가 중요해야 합니다.
  • 관사와 전치사를 사용합니다.
  • 대문자 사용 지침을 따릅니다.
  • 이전 주제 제목에서 텍스트를 반복하지 않습니다. 예를 들어, 페이지가 Merge Request에 관한 것이라면 Merge Request 문제 해결 대신에 문제 해결만 사용합니다.
  • 정보를 구분하기 위해 하이픈을 사용하지 않습니다. 예를 들어 내부 분석 - 아키텍처 대신 내부 분석 아키텍처 또는 내부 분석 아키텍처를 사용합니다.

또한 마크다운에서 제목 레벨 지침을 참조하십시오.

관련 주제

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

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

## 관련 주제

- [CI/CD 변수](주제로의 링크)
- [환경 변수](주제로의 링크)