참조 주제 유형

참조 정보는 쉽게 스캔할 수 있는 형식으로 제공되어야 하며,

테이블이나 목록과 같은 형식입니다. 사전이나 백과사전 항목과 유사합니다.

형식

참조 주제는 다음 형식이어야 합니다:

# 제목 (명사, 예: "파이프라인 설정" 또는 "관리자 옵션")

소개 문장입니다.

| 설정 | 설명 |
|---------|-------------|
| **이름** | 설정에 대한 설명 문장입니다. |

참조 주제 제목

참조 주제 제목은 일반적으로 명사입니다.

다음과 같은 주제 제목은 피하십시오:

  • 중요한 노트. 대신 이 정보를 해당 내용에 더 가깝게 통합하세요. 예를 들어, 이 정보는 작업에 대한 전제 조건이거나 개념에 대한 정보일 수 있습니다.
  • 제한 사항. 대신 유사한 정보 근처로 내용을 이동하세요. 반드시 필요한 경우 알려진 문제라는 제목을 사용할 수 있습니다.