GitHub のコンテンツ設計原則について
GitHub を使用するすべてのユーザーの役に立ち、理解を深め、参加を促進する製品ドキュメントが作成されています。 この作業の 1 つのステップは、作成するコンテンツを設計することです。 コンテンツの設計と計画は、次のような原則に従って行われています。
- コンテンツは、ユーザー中心でありインクルーシブです。 ドキュメントを利用するすべてのユーザーを尊重し、戦略、設計、スタイルの選択に役立つコンテンツにしています。
- コンテンツでは製品が役に立つ理由が説明されており、ユーザーが目標と優先事項を達成するのに役立ちます。
- GitHub のコミュニティ向けに高品質で価値のあるドキュメントを作成するためにリソースを投入しています。
- 必要なドキュメントだけを作成します。コンテンツが増えると必要なものが見つけ難くなり、余計なものが追加されると内容が薄くなります (GitHub Zen)。
- 学習を繰り返し、それをお届けします。経験、業界の専門知識、GitHub Docs コミュニティと連携からさらに多くのことを学習し、プロセス、プラクティス、ガイドラインを調整します。
すべてのユーザーがドキュメントを設計および作成するための構成要素とガイドラインとして、スタイル ガイドとコンテンツ モデルを提供します。
- スタイル ガイドとコンテンツ モデルは、さまざまなシナリオに適用されます。
- 決定は、文法やスタイルの規則に従って正しいか間違っているかだけでなく、ドキュメントを使用するユーザーにとって最適なものに基づいて行われます。 一貫性を保ちながら、変化に対しても柔軟かつ寛容に対応しています。
- GitHub の多くの製品と機能に対して考えられるすべてのユース ケースを網羅するのではなく、影響が大きく価値の高いシナリオのドキュメントを作成することに重点を置きます。
- 最も優先されるのは、明確さ、意味、正確さ、一貫性です。
- スタイルや構成に関する決定を行うときは、ユーザーがその情報を使って何をしようとしているか、およびどのようなコンテンツにすれば目標を最適にサポートできるかを検討します。
- ドキュメントに固有の質問がスタイル ガイドまたはコンテンツ モデルでカバーされていない場合は、これらの原則を使って評価し、決定します。