# GitHub Docs ドキュメントへの投稿

GitHub Docs チームがドキュメントを作成する方法と、投稿する方法について説明します。

## Recommended

* [GitHub Docs へのコントリビューションに関する情報](/ja/contributing/collaborating-on-github-docs/about-contributing-to-github-docs)

  GitHub Docs コンテンツには、いくつかの方法でコントリビュートすることができます。

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

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

* [スタイル ガイド](/ja/contributing/style-guide-and-content-model/style-guide)

  このガイドに従って、 GitHubのドキュメントが一貫性を保ち、読者が理解できる明確なパターンに従っていることを確認します。

* [コンテンツ モデルについて](/ja/contributing/style-guide-and-content-model/about-the-content-model)

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

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

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

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

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

## Links

### Getting started

* [GitHub Docs へのコントリビューションに関する情報](/ja/contributing/collaborating-on-github-docs/about-contributing-to-github-docs)

  GitHub Docs コンテンツには、いくつかの方法でコントリビュートすることができます。

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

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

## Articles

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* [スタイル ガイド](/ja/contributing/style-guide-and-content-model/style-guide)

  このガイドに従って、 GitHubのドキュメントが一貫性を保ち、読者が理解できる明確なパターンに従っていることを確認します。

* [コンテンツ モデルについて](/ja/contributing/style-guide-and-content-model/about-the-content-model)

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

* [GitHub Docs の記事の内容](/ja/contributing/style-guide-and-content-model/contents-of-a-github-docs-article)

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

* [概念コンテンツ タイプ](/ja/contributing/style-guide-and-content-model/concepts-content-type)

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

* [参照コンテンツ タイプ](/ja/contributing/style-guide-and-content-model/reference-content-type)

  参照コンテンツは、ユーザーが機能をアクティブに使用している間に必要な詳細情報を提供します。

* [ハウツーコンテンツの種類](/ja/contributing/style-guide-and-content-model/how-to-content-type)

  GitHub製品と機能を使用してタスクを完了する方法について説明します。

* [トラブルシューティング コンテンツ タイプ](/ja/contributing/style-guide-and-content-model/troubleshooting-content-type)

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

* [リリースノートのコンテンツタイプ](/ja/contributing/style-guide-and-content-model/release-note-content-type)

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

* [コンテンツ タイプの使用を開始する](/ja/contributing/style-guide-and-content-model/get-started-content-type)

  作業を開始するコンテンツは、製品または機能を使用するために必要最小限の情報を提供します。

* [クイック スタート コンテンツ タイプ](/ja/contributing/style-guide-and-content-model/quickstart-content-type)

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

* [チュートリアル コンテンツ タイプ](/ja/contributing/style-guide-and-content-model/tutorial-content-type)

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

* [複数のコンテンツの種類の組み合わせについて](/ja/contributing/style-guide-and-content-model/about-combining-multiple-content-types)

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

* [GitHub Docs へのコントリビューションに関する情報](/ja/contributing/collaborating-on-github-docs/about-contributing-to-github-docs)

  GitHub Docs コンテンツには、いくつかの方法でコントリビュートすることができます。

* [GitHub Docs での Git の使用](/ja/contributing/collaborating-on-github-docs/using-git-on-github-docs)

  コマンド ラインで Git を使用して変更をコミットし、ドキュメント リポジトリにプッシュできます。

* [TODOCS プレースホルダーを使ってメモを残す](/ja/contributing/collaborating-on-github-docs/using-the-todocs-placeholder-to-leave-notes)

  `TODOCS` プレースホルダーを使い、依然として完了する必要がある作業を示すことができます。

* [コンテンツ リンターを使用する](/ja/contributing/collaborating-on-github-docs/using-the-content-linter)

  コンテンツ リンターを使って、コントリビューションのエラーをチェックできます。

* [ラベル参照](/ja/contributing/collaborating-on-github-docs/label-reference)

  ラベルは解決したい問題を見つけるのに役立ちます。

* [codespace での GitHub Docs の操作](/ja/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace)

  GitHub Codespacesを使用して、GitHub Docsのドキュメントを操作できます。

* [ローカル環境の作成](/ja/contributing/setting-up-your-environment-to-work-on-github-docs/creating-a-local-environment)

  GitHub Docs アプリケーションは、コンピューター上でローカルで実行できます。

* [環境のトラブルシューティング](/ja/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment)

  ローカル環境と GitHub Docs ステージング プラットフォームでの問題のトラブルシューティングについて説明します。