GitHub のドキュメントの基本について
これらの基本は、GitHub ドキュメントに必要です。 以下の一覧を参考に、コントリビューションが正確であり、アクセスしやすく、包括的で一貫性があることを確認してください。
正確である
ドキュメントは正しく正確です。
- コンテンツに事実誤認がないことを確認します。
- コンテンツにスペルミスや書式設定エラーがないことを確認します。
アクセシビリティと包括性
ドキュメントは最新のアクセシビリティ標準に準拠しており、包括的で翻訳しやすいように書かれています。
- コンテンツがアクセシビリティとスクリーンショットのガイドラインに準拠していることを確認します。 詳しくは、「スクリーンショットの作成」をご覧ください。
- コンテンツを正常に翻訳できることを確認します。 詳しくは、「翻訳するコンテンツの記述」をご覧ください。
常に
ドキュメントは、一貫性のある口調、トーン、スタイルを維持し、読者にとって一貫性のあるエクスペリエンスを提供しています。
- コンテンツが GitHub Docs スタイル ガイドに準拠していることを確認します。 詳しくは、「スタイル ガイド」をご覧ください。
- 一貫性のある用語と名前付け規則を適用します。
- コンテンツにはブランド化要素 (製品名や機能名、ロゴ、配色など) を一貫して使用します。