Skip to main content

GitHub Docs の作成

GitHub Docs の書き込みについて説明します。

GitHub Docs のベスト プラクティス

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

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

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

コンテンツの設計原則

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

翻訳するコンテンツの記述

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

検索でコンテンツを検索できるようにすること

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

バージョン管理に関するドキュメント

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

GitHub Docs での Markdown と Liquid の使用

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

YAML front matter の使用

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

GitHub Docs でのビデオの使用

このガイドでは、GitHub Docs に対するユーザー ニーズをサポートするビデオを作成する方法について説明します。

再利用可能なコンテンツの作成

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

スクリーンショットの作成

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

GitHub Docs のダイアグラムの作成

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

記事でのツール スイッチャーの作成

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

リダイレクトを構成する

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

記事のタイトルの変更

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

コード例に注釈を付ける

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

テンプレート

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