공통 문서 원칙

최적의 사용자 경험과 명확성을 위해 새 콘텐츠를 작성할 때 docs.ton.org의 모든 문서에 적용하려는 하는 일반적이고 중요한 요구 사항 목록을 염두에 두시기 바랍니다.

전문가를 위한 문서 작성

문서 페이지는 주로 문서화 목적을 위한 것이며 튜토리얼이 아니므로, 텍스트에서 개인적인 예시나 비유의 사용을 최소화하는 것이 중요합니다. 전문가는 물론 비전문가에게도 유용한 정보를 제공하면서 적합한 내용을 담는 것이 중요합니다.

일관된 형식 사용

독자가 문서를 쉽게 탐색할 수 있도록 문서 전체에 일관된 형식을 사용하는 것이 중요합니다. 제목, 부제목, 글머리 기호, 번호 목록 등을 사용하여 텍스트를 구분하고 읽기 쉽게 만드십시오.

특별 섹션에 예제 제공

예제는 독자가 내용을 더 잘 이해하고 적용할 수 있도록 도와줍니다. 문서 페이지를 작성할 때 여러 예제를 참조해야 한다면, '참고 자료'와 '더 보기' 섹션 바로 전에 '예제'라는 특별 섹션을 만드십시오. 문서 설명과 예제를 혼합하지 마십시오. 코드 스니펫, 스크린샷 또는 다이어그램을 사용하여 요점을 설명하고 문서를 더 흥미롭게 만드십시오.

최신 상태 유지

기술 문서는 기술이나 소프트웨어 업데이트의 변화로 인해 금방 오래될 수 있습니다. 문서를 정기적으로 검토하고 업데이트하여 현재 버전의 소프트웨어와 정확하고 관련성이 있는지 확인하는 것이 중요합니다.

피드백 받기

문서를 게시하기 전에 다른 기여자나 사용자로부터 피드백을 받는 것이 좋습니다. 이를 통해 혼란스럽거나 불분명한 부분을 파악하여 문서가 공개되기 전에 개선할 수 있습니다.