스타일 가이드 및 콘텐츠 모델

이 가이드에 따라 GitHub의 설명서가 독자가 이해할 수 있도록 일관성을 유지하고 명확한 패턴을 따르도록 합니다.

콘텐츠 모델은 게시하는 콘텐츠의 구조와 형식을 설명합니다.

모든 문서에는 몇 가지 표준 요소가 포함되어 있으며 조건부 또는 선택적 요소가 포함될 수 있습니다. 또한 문서 내의 콘텐츠에 대해 표준 순서를 사용합니다.

토픽을 사용하여 문서를 검색할 수 있도록 합니다.

새로운 것에 대해 배울 때 개념 콘텐츠를 가장 자주 사용합니다.

참조 콘텐츠는 기능을 적극적으로 사용하는 동안 필요로 하는 자세한 정보를 제공합니다.

절차 콘텐츠는 작업이 다른 사람의 더 큰 목표에 어떻게 부합하는지에 대한 컨텍스트를 알려줍니다.

콘텐츠 문제 해결은 사용자가 예상하는 기본 제공 오류, 지원하도록 보고되는 일반적인 문제 및 작업을 완료하는 동안 발생할 수 있는 상황을 포함합니다.

릴리스 정보를 통해 독자는 GitHub의 버전이 지정된 기업 제품의 각 릴리스에서 사용자 관련 변경 내용을 이해하고 준비할 수 있습니다.

빠른 시작은 작동 방식이나 사용하려는 이유에 대한 긴 설명 없이 신속하게 지침을 원하는 사용자에게 가장 좋습니다.

자습서는 누군가가 제품에 대한 기본적인 이해를 가지고 있으며 특정 문제를 해결하기 위해 이해를 확장하는 데 관심이 있는 경우에 유용합니다

단일 문서에서 여러 콘텐츠 형식을 결합하여 복잡한 작업을 완료하는 데 도움이 될 수 있습니다.