참조 주제 유형
참조 정보는 표나 디렉터리과 유사한 형식으로 쉽게 검토할 수 있어야 합니다. 사전이나 백과사전 항목과 유사합니다.
형식
참조 주제는 다음 형식을 따라야 합니다.
# 제목 (파이프라인 설정이나 관리자 옵션과 같은 명사)
소개 문장.
| 설정 | 설명 |
|---------|-------------|
| **이름** | 해당 설정에 대한 설명 문장. |
참조 주제 제목
참조 주제 제목은 일반적으로 명사입니다.
다음과 같은 주제 제목을 피하세요:
-
중요 노트
. 대신, 이 정보를 해당 위치에 가까운 곳에 통합하세요. 예를 들어, 이 정보는 작업의 선행 조건이거나 개념에 대한 정보일 수 있습니다. -
제한 사항
. 대신, 유사한 정보 근처로 이동하세요. 반드시 필요하다면,알려진 문제
라는 제목을 사용할 수 있습니다.