Skip to main content

GitHub의 설명서 기본 사항 정보

GitHub Docs에 게시된 모든 콘텐츠는 이러한 기본 요구 사항을 충족해야 합니다.

GitHub의 설명서 기본 사항 정보

이러한 기본 사항은 GitHub 설명서에 필요합니다. 아래 목록을 사용하여 기여가 정확하고, 접근 가능하고, 포괄적이고, 일관되도록 합니다.

정확함

설명서는 정확하고 올바릅니다.

  • 콘텐츠에 사실 오류가 없는지 확인합니다.
  • 콘텐츠에 맞춤법 및 서식 오류가 없는지 확인합니다.

접근성 및 포괄성

설명서는 최신 접근성 표준으로 최신 상태이며 포괄적이고 번역 친화적으로 작성되었습니다.

  • 콘텐츠가 접근성 및 스크린샷 지침을 준수하는지 확인합니다. 자세한 내용은 스크린샷 만들기을(를) 참조하세요.
  • 콘텐츠를 성공적으로 번역할 수 있는지 확인합니다. 자세한 내용은 번역할 콘텐츠 작성을(를) 참조하세요.

지속적인 문제

설명서는 전체적으로 일관된 음성, 톤, 스타일을 유지하여 독자를 위한 응집력 있는 환경을 만듭니다.

  • 콘텐츠가 GitHub Docs 스타일 가이드를 준수하는지 확인합니다. 자세한 내용은 스타일 가이드을(를) 참조하세요.
  • 일관된 용어 및 명명 규칙을 적용합니다.
  • 콘텐츠에서 브랜딩 요소(예: 제품 및 기능 이름, 로고, 색 구성표)를 일관되게 사용합니다.