スタイル ガイドと コンテンツモード

GitHub のドキュメントが一貫性を保ち、読者にとってわかりやすい明確なパターンに沿うように、このガイドに従ってください。

コンテンツ モデルでは、公開するコンテンツの構造と種類が記述されています。

すべての記事にはいくつかの標準的な要素が含まれており、条件付きまたは省略可能な要素を含めることができます。 また、記事内のコンテンツには標準的な順序を使用します。

トピックにトピックを適用することで、記事が検索可能になります。

概念コンテンツは、ユーザーが何か新しいことを学ぶときに最もよく使われます。

参照コンテンツでは、ユーザーが機能を積極的に使用している間に必要な詳細情報が提供されます。

手続き型コンテンツでは、タスクが他のユーザーのより大きなゴールにどのように適合するかについてのコンテキストが提供されます。

トラブルシューティング コンテンツには、ユーザーが直面すると予想される組み込みのエラー、サポート対象として報告される一般的な問題、タスクの実行中に発生する可能性がある状況が含まれます。

リリース ノートを参照すれば、閲覧者は、GitHub のバージョン管理された Enterprise 製品の各リリースでのユーザーに対する変更を理解し、準備できます。

クイック スタートは、何かのしくみや使用する理由について長い説明をせずに、すぐにに指示を求めるユーザーに最適です。

チュートリアルは、誰かが製品について基本的に理解しており、特定の問題を解決するためにその理解を広げることに関心がある場合に便利です。

1 つの記事に複数のコンテンツ タイプを組み合わせて、複雑なタスクを完了させることができます。