참조 주제 유형
참조 정보는 테이블이나 목록과 유사한 쉽게 검토할 수 있는 형식이어야 합니다. 사전이나 백과사전 항목과 유사합니다.
형식
참조 주제는 다음 형식을 따라야 합니다:
# 제목 (파이프라인 설정 또는 관리자 옵션과 같은 명사)
도입문.
| 설정 | 설명 |
|---------|-------------|
| **이름** | 설정에 대한 서술적인 문장. |
참조 주제 제목
참조 주제 제목은 일반적으로 명사입니다.
다음과 같은 주제 제목을 피하세요:
-
중요한 참고 사항
. 대신에 이 정보를 해당하는 위치에 가깝게 통합하세요. 예를 들어, 이 정보는 작업의 선행 조건이 될 수 있거나 개념에 대한 정보일 수 있습니다. -
제한 사항
. 대신, 다른 유사한 정보 근처로 이동하세요. 필요한 경우알려진 문제
라는 제목을 사용할 수 있습니다.