Reference 정보는 테이블이나 목록처럼 쉽게 훑어볼 수 있는 형식으로 작성해야 합니다. 사전이나 백과사전 항목과 유사합니다.

형식#

Reference 토픽은 다음 형식을 따라야 합니다:

title: 제목 (명사 형태, 예: "Pipeline settings" 또는 "Administrator options")
---

소개 문장.

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

Reference 토픽 제목#

Reference 토픽 제목은 일반적으로 명사입니다.

다음과 같은 토픽 제목은 사용하지 마세요:

• Important notes. 대신, 이 정보를 해당 내용이 속하는 위치 가까이에 포함시키세요. 이 정보는 작업의 전제 조건이거나 개념에 대한 정보일 수 있습니다.

• Limitations. 대신, 관련된 다른 정보 근처로 내용을 옮기세요. 제한 사항으로 나열된 내용은 기능의 작동 방식에 대한 전제 조건 정보로 볼 수 있는 경우가 많습니다. 꼭 필요하다면 Known issues라는 제목을 사용할 수 있습니다.

예시#

변경 전#

이 토픽은 다양한 정보가 혼합되어 있어 훑어보기 어려웠습니다.

[

](/19.1/development/documentation/topic_types/img/reference_example1_v17_10.png)

변경 후#

Overview 토픽의 정보가 이제 훑어보기 쉬운 테이블로 정리되었습니다. 또한 검색하기 더 쉬운 제목이 붙었습니다.

[

](/19.1/development/documentation/topic_types/img/reference_example2_v17_10.png)