# GitHub Docs の執筆

GitHub Docsの記述について説明します。

## Links

* [GitHub Docs のベスト プラクティス](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/best-practices-for-github-docs)

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

* [GitHub のドキュメント哲学について](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/about-githubs-documentation-philosophy)

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

* [GitHub のドキュメントの基本について](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals)

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

* [コンテンツの設計原則](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/content-design-principles)

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

* [翻訳するコンテンツの記述](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/writing-content-to-be-translated)

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

* [検索でコンテンツを検索できるようにすること](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/making-content-findable-in-search)

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

* [バージョン管理に関するドキュメント](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/versioning-documentation)

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

* [GitHub Docs での Markdown と Liquid の使用](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs)

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

* [YAML front matter の使用](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/using-yaml-frontmatter)

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

* [再利用可能なコンテンツの作成](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/creating-reusable-content)

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

* [スクリーンショットの作成](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/creating-screenshots)

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

* [GitHub Docs 用の図を作成する](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/creating-diagrams-for-github-docs)

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

* [記事内のツールスイッチャーの作成](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/creating-tool-switchers-in-articles)

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

* [リダイレクトを構成する](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/configuring-redirects)

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

* [記事のタイトルの変更](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/changing-an-articles-title)

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

* [コード例に注釈を付ける](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/annotating-code-examples)

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

* [テンプレート](/ja/enterprise-server@3.22/contributing/writing-for-github-docs/templates)

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