공통 문서 원칙

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

전문가를 위해 제작된 문서

문서 페이지는 주로 튜토리얼이 아닌 문서화 목적으로 작성되었으므로 텍스트에 개인적인 예시나 비유를 최소화하는 것이 중요합니다. 중요한 정보를 제공하면서도 전문가와 비전문가 모두에게 적합한 콘텐츠를 만드는 것이 중요합니다.

일관된 형식 사용

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

특별 섹션에서 예제 제공

예제를 제공하면 독자가 내용과 적용 방법을 더 잘 이해하는 데 도움이 될 수 있습니다. 문서 페이지를 작성할 때 여러 예제를 참조해야 하는 경우에는 참조 및 참고 섹션 바로 앞에 예제 섹션을 따로 만들어 주세요. 문서 페이지에 설명과 예제를 혼용하지 마세요. 코드 스니펫, 스크린샷 또는 다이어그램을 사용하여 요점을 설명하고 문서를 더욱 매력적으로 만드세요.

최신 상태로 유지

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

피드백 받기

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