Skip to main content

GitHub のドキュメント哲学について

ドキュメント哲学は、作成するコンテンツとその作成方法を指南するものです。

GitHub ドキュメント哲学について

世界最大の開発者コミュニティにとって拠り所となるため、ドキュメントは正確で役に立ち、包括的で使いやすいものになるよう、GitHub は努めております。 GitHub のドキュメント哲学はそうした目標の道しるべになるものです。

  • 利用者の声が反映されます。 これは、計画から作成を経て発行まで、文書化プロセスのあらゆる時点で行われます。 フィードバックに応え、GitHub Docs サイトで可能な限り最良のユーザー エクスペリエンスが得られるよう、事前予防に努めます。
  • ドキュメントの対象読者には世界中の人を想定しています。それにより、コンテンツは翻訳され、すべての人に読んでもらえます。
  • 幅広い利用者に使ってもらえるコンテンツを作ります。 GitHub コンテンツ ツールキットには、障碍者にとっての障壁を減らすためのリソースとガイダンスが含まれています。最新のアクセシビリティ基準でドキュメントを常に最新の状態に維持することを優先事項としています。
  • タスクベースのコンテンツを作成します。 ある人が GitHub を使うとき、その人が成し遂げようとしていることを GitHub は考慮します。その人が目標を達成し、新しい可能性を発見できるようなコンテンツを作成します。
  • GitHub は GitHub の各チームおよびオープン ソース コミュニティと共同作業し、高品質のコンテンツを作成します。
  • GitHub を使って人に最良のエクスペリエンスを与えられるよう、GitHub は常に学び、向上します。