문서 주제 유형 (CTRT)

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

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

기술 작문 팀은 때때로 주제 유형을 지칭하기 위해 약어 CTRT를 사용합니다.
이 약어는 각 주제 유형의 첫 글자를 따온 것입니다.

기타 페이지 및 주제 유형

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

피해야 할 페이지 및 주제

다음은 피해야 할 내용입니다:

  • 다른 페이지에 대한 링크만 있는 페이지. 유일한 예외는 탐색을 지원하는 최상위 페이지입니다.
  • 문장이 하나 또는 두 개만 있는 주제. 이 경우:
    • 정보를 다른 주제에 통합합니다.
    • 문장이 다른 페이지에 링크된 경우, 대신 관련 주제 링크를 사용합니다.

주제 제목 가이드라인

일반적으로 주제 제목의 경우:

  • 명확하고 직접적이어야 합니다. 모든 단어를 소중히 여기세요.
  • 가능하면 70자 이하로 사용하세요. markdownlint 규칙: line-length (MD013)
  • 관사와 전치사를 사용하세요.
  • 대문자 사용 가이드라인을 따르세요.
  • 이전 주제 제목의 텍스트를 반복하지 마세요. 예를 들어, 페이지가 병합 요청에 대한 것이라면 병합 요청 문제 해결 대신 문제 해결만 사용하세요.
  • 정보를 구분하기 위해 하이픈을 사용하는 것을 피하세요.
    예를 들어 내부 분석 - 아키텍처 대신 내부 분석 아키텍처 또는 내부 분석의 아키텍처를 사용하세요.

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

관련 주제

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

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

## 관련 주제

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