콘텐츠 디자인 원칙

GitHub의 콘텐츠 디자인 원칙 정보

GitHub을(를) 사용하는 모든 사용자를 돕고, 가르치고, 참여시키는 제품 설명서를 만듭니다. 이 작업의 한 단계가 작성하는 콘텐츠를 디자인하는 것입니다. 콘텐츠를 디자인하고 계획할 때 다음의 원칙을 따릅니다.

• 우리 콘텐츠는 사용자 중심적이고 포괄적입니다. 우리는 Docs를 방문하는 모든 사람을 존중하고 전략, 디자인 및 스타일 선택으로 그들에게 도움이 되는 콘텐츠를 만듭니다.
• 우리 콘텐츠는 우리 제품이 유용한 이유를 설명하고 사람들이 자신의 목표와 우선 순위를 달성하는 데 도움이 됩니다.
• GitHub의 커뮤니티에 대한 고품질의 귀중한 설명서를 만드는 데 리소스를 씁니다.
• 우리는 충분한 문서를 만듭니다. 더 많은 콘텐츠는 모든 것을 찾기 어렵게 만들고, 추가된 모든 항목은 다른 모든 것을 희석합니다(GitHub Zen).
• Microsoft는 경험, 업계 전문 지식 및 GitHub Docs 커뮤니티를 통해 더 많은 것을 배우면서 프로세스, 사례 및 지침을 조정하여 학습을 반복하고 제공합니다.

구성 요소와 지침으로서 스타일 가이드와 콘텐츠 모델을 제공해서 누구나 설명서를 디자인하고 만들 수 있도록 합니다.

• 스타일 가이드 및 콘텐츠 모델은 다양한 시나리오에 적용됩니다.
• 판단은 단순히 문법이나 스타일 규칙에 따라 옳고 그름이 아니라, 문서를 사용하는 사람들에게 가장 적합한 것을 기반으로 합니다. 일관성을 유지하는 동시에 변화에 유연하고 개방적으로 대응합니다.
• 많은 GitHub 제품 및 기능에 대해 가능한 모든 사용 사례를 포괄적으로 다루기보다는 영향력이 크고 값이 높은 시나리오를 문서화하는 데 집중합니다.
• 가장 높은 우선 순위는 명확성, 의미, 정확성 그리고 일관성입니다.
• 스타일 또는 구조적 결정을 내릴 때, 사람들이 정보를 사용하여 무엇을 하려고 하는지, 그리고 콘텐츠가 목표를 가장 잘 지원할 수 있는 방법을 고려합니다.
• 도움말 설명서와 관련된 질문을 스타일 가이드에서 다루지 않은 경우, 이러한 원칙을 고려해 평가한 후 결정합니다.