문서화 주제 유형 (CTRT)
각 페이지의 주제는 다음 주제 유형 중 하나여아 합니다:
페이지가 짧더라도, 페이지는 보통 개념으로 시작하여 작업 또는 참고 주제를 포함합니다.
기술 문서 팀은 때때로 주제 유형을 가리키기 위해 머릿글 CTRT
를 사용합니다. 이 머릿글은 각 주제 유형의 첫 글자를 가리킵니다.
다른 페이지 및 주제 유형
기본 주제 유형 4가지 외에도 다음을 사용할 수 있습니다:
피해야 할 페이지 및 주제
다음을 피해야 합니다:
- 다른 페이지로의 전용 링크만 있는 페이지. 네비게이션을 돕는 최상위 페이지를 제외하고.
- 한 두 문장으로 이루어진 주제. 이러한 경우:
- 정보를 다른 주제에 통합합니다.
- 문장이 다른 페이지로 연결되는 경우, 관련 주제 링크를 대신 사용하세요.
주제 제목 가이드라인
일반적으로, 주제 제목은 다음과 같아야 합니다:
- 명확하고 직접적이어야 합니다. 모든 단어가 중요해야 합니다.
- 가능한 한 70자 미만.
- 기사 및 전치사를 사용하세요.
- 대문자 사용 가이드라인을 따르세요.
- 이전 주제 제목에서 텍스트를 반복하지 마세요. 예를 들어, 페이지가 Merge Request에 관한 경우,
Merge Request 문제 해결
이 아니라문제 해결
만 사용하세요. - 정보를 구분하기 위해 하이픈을 사용하지 마세요.
예를 들어,
내부 분석 - 아키텍처
대신내부 분석 아키텍처
또는내부 분석의 아키텍처
를 사용하세요.
Markdown에서 제목 수준 가이드라인을 참조하세요.
관련 주제
인라인 링크가 충분하지 않은 경우, 관련 주제라고 불리는 주제를 만들고 관련 주제의 순서 없는 디렉터리을 포함할 수 있습니다. 이 주제는 문제 해결 섹션 위에 있어야 합니다.
이 섹션의 링크는 간결하고 빠르게 스캔할 수 있어야 합니다. 일반적으로 문장이 아니기 때문에 마침표로 끝나지 않아야 합니다.
## 관련 주제
- [CI/CD 변수](link-to-topic)
- [환경 변수](link-to-topic)