GitHub Docs の執筆

次のベスト プラクティスに従って、ユーザー フレンドリでわかりやすいドキュメントを作成します。

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

GitHub Docs で公開されるすべてのコンテンツは、これらの基本要件を満たしている必要があります。

GitHub を使用するユーザーに最適なコンテンツを設計および作成するための原則について説明します。

Microsoft のドキュメントは複数の言語に翻訳されています。 英語のドキュメントを記述する方法により、それらの翻訳の品質が大幅に向上します。

これらの SEO のベスト プラクティスに従うと、ユーザーが検索エンジンを使用して GitHub ドキュメントを見つけるのに役立ちます。

GitHub Docs では、YAML frontmatter と liquid の演算子を使って、単一ソースのアプローチで複数のバージョンの GitHub をサポートします。

Markdown と Liquid を使用すると、コンテンツの書式設定、再利用可能なコンテンツの作成、 GitHub Docsのさまざまなバージョンのコンテンツの書き込みを行うことができます。

YAML frontmatter では、バージョン管理の定義、メタデータの追加、記事のレイアウトの制御を行うことができます。

複数のコンテンツ ファイルで参照できる再利用可能コンテンツを作成できます。

スクリーンショットを GitHub Docsに追加することで、見つけにくいユーザー インターフェイスの要素をユーザーが見つけるのに役立ちます。

このガイドでは、 GitHub Docsのダイアグラムを作成するタイミングと方法について説明します。

ツール スイッチャーを使うと、特定のツールを使ってタスクを行う方法を示すことができます。

記事のタイトル、バージョン、または場所が変更された場合は、現在のコンテンツへのリダイレクトを作成できます。

記事のタイトルを変更する必要がある場合は、いくつかの場所で名前を更新する必要があります。

長いコード例には注釈を付けて、その機能と、他の用途に合わせてカスタマイズする方法を説明することができます。

この記事には、 GitHub Docsで使用されるさまざまなコンテンツ タイプのスターター テンプレートが含まれています。