{"meta":{"title":"参与完善 GitHub Docs 文档","intro":"了解 GitHub Docs 团队是如何创建文档的，以及您如何能够贡献力量。","product":"贡献 GitHub 文档","breadcrumbs":[{"href":"/zh/contributing","title":"贡献 GitHub 文档"}],"documentType":"product"},"body":"# 参与完善 GitHub Docs 文档\n\n了解 GitHub Docs 团队是如何创建文档的，以及您如何能够贡献力量。\n\n## Recommended\n\n* [关于参与编写 GitHub Docs](/zh/contributing/collaborating-on-github-docs/about-contributing-to-github-docs)\n\n  可以通过多种方式参与 GitHub Docs 内容的编写。\n\n* [GitHub Docs 的最佳实践](/zh/contributing/writing-for-github-docs/best-practices-for-github-docs)\n\n  按照这些最佳做法即可创建用户友好且易于理解的文档。\n\n* [风格指南](/zh/contributing/style-guide-and-content-model/style-guide)\n\n  按照本指南操作，确保 GitHub文档保持一致，并遵循读者可以理解的清晰模式。\n\n* [关于内容模型](/zh/contributing/style-guide-and-content-model/about-the-content-model)\n\n  内容模型描述我们发布的内容的结构和类型。\n\n* [在 GitHub Docs 中使用 Markdown 和 Liquid](/zh/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs)\n\n  可以使用 Markdown 和 Liquid 在 GitHub Docs 上设置内容格式、创建可重用内容，以及为不同版本编写内容。\n\n* [模板](/zh/contributing/writing-for-github-docs/templates)\n\n  本文包含适用于GitHub Docs中不同内容类型的入门模板。\n\n## Links\n\n### Getting started\n\n* [关于参与编写 GitHub Docs](/zh/contributing/collaborating-on-github-docs/about-contributing-to-github-docs)\n\n  可以通过多种方式参与 GitHub Docs 内容的编写。\n\n* [GitHub Docs 的最佳实践](/zh/contributing/writing-for-github-docs/best-practices-for-github-docs)\n\n  按照这些最佳做法即可创建用户友好且易于理解的文档。\n\n## Articles\n\n* [GitHub Docs 的最佳实践](/zh/contributing/writing-for-github-docs/best-practices-for-github-docs)\n\n  按照这些最佳做法即可创建用户友好且易于理解的文档。\n\n* [关于 GitHub 的文档理念](/zh/contributing/writing-for-github-docs/about-githubs-documentation-philosophy)\n\n  我们的文档理念指导我们创建的内容以及创建内容的方式。\n\n* [关于 GitHub 的文档基础知识](/zh/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals)\n\n  在 GitHub Docs 上发布的所有内容必须满足这些基本要求。\n\n* [内容设计原则](/zh/contributing/writing-for-github-docs/content-design-principles)\n\n  我们分享这些原则，为使用 GitHub 的人员设计和创建最佳内容。\n\n* [编写要翻译的内容](/zh/contributing/writing-for-github-docs/writing-content-to-be-translated)\n\n  我们的文档已翻译成多种语言。 我们编写英语文档的方式可以大大提高这些翻译的质量。\n\n* [让内容可在搜索中查找](/zh/contributing/writing-for-github-docs/making-content-findable-in-search)\n\n  遵循以下 SEO 最佳做法，帮助用户使用搜索引擎来查找 GitHub 文档。\n\n* [对文档进行版本控制](/zh/contributing/writing-for-github-docs/versioning-documentation)\n\n  GitHub Docs 使用 YAML 前辅文和 Liquid 运算符通过单一源方法支持 GitHub 的多个版本。\n\n* [在 GitHub Docs 中使用 Markdown 和 Liquid](/zh/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs)\n\n  可以使用 Markdown 和 Liquid 在 GitHub Docs 上设置内容格式、创建可重用内容，以及为不同版本编写内容。\n\n* [使用 YAML 前辅文](/zh/contributing/writing-for-github-docs/using-yaml-frontmatter)\n\n  可以使用 YAML 前辅文来定义版本控制、添加元数据和控制文章的布局。\n\n* [创建可重用内容](/zh/contributing/writing-for-github-docs/creating-reusable-content)\n\n  可以创建可在多个内容文件中引用的可重用内容。\n\n* [创建屏幕截图](/zh/contributing/writing-for-github-docs/creating-screenshots)\n\n  你可以通过将屏幕截图添加到 GitHub Docs 来帮助用户找到用户界面中难以找到的元素。\n\n* [为 GitHub Docs 创建关系图](/zh/contributing/writing-for-github-docs/creating-diagrams-for-github-docs)\n\n  本指南介绍何时与如何为 GitHub Docs 创建关系图。\n\n* [在文章中创建工具切换器](/zh/contributing/writing-for-github-docs/creating-tool-switchers-in-articles)\n\n  可以使用工具切换器来演示如何使用特定工具完成任务。\n\n* [配置重定向](/zh/contributing/writing-for-github-docs/configuring-redirects)\n\n  如果文章的标题、版本或位置发生更改，则可以创建指向最新内容的重定向。\n\n* [更改文章的标题](/zh/contributing/writing-for-github-docs/changing-an-articles-title)\n\n  当必须更改文章的标题时，可能需要在多个位置更新名称。\n\n* [注释代码示例](/zh/contributing/writing-for-github-docs/annotating-code-examples)\n\n  可以批注较长的代码示例，以说明它们的工作原理以及用户如何自定义它们以用于其他用途。\n\n* [模板](/zh/contributing/writing-for-github-docs/templates)\n\n  本文包含适用于GitHub Docs中不同内容类型的入门模板。\n\n* [风格指南](/zh/contributing/style-guide-and-content-model/style-guide)\n\n  按照本指南操作，确保 GitHub文档保持一致，并遵循读者可以理解的清晰模式。\n\n* [关于内容模型](/zh/contributing/style-guide-and-content-model/about-the-content-model)\n\n  内容模型描述我们发布的内容的结构和类型。\n\n* [GitHub Docs 文章的内容](/zh/contributing/style-guide-and-content-model/contents-of-a-github-docs-article)\n\n  每篇文章都包含一些标准元素，并且可能包含条件元素或可选元素。 我们还对文章中的内容使用标准顺序。\n\n* [概念内容类型](/zh/contributing/style-guide-and-content-model/concepts-content-type)\n\n  人们在了解新内容时最常使用概念性内容。\n\n* [引用内容类型](/zh/contributing/style-guide-and-content-model/reference-content-type)\n\n  参考内容提供了在用户主动使用某项功能时所需的详细信息。\n\n* [操作方法内容类型](/zh/contributing/style-guide-and-content-model/how-to-content-type)\n\n  介绍如何使用 GitHub 产品和功能完成任务。\n\n* [故障排除内容类型](/zh/contributing/style-guide-and-content-model/troubleshooting-content-type)\n\n  故障排除内容包括用户可能会遇到的内置错误、向支持人员报告的常见问题，以及用户在完成任务时可能遇到的情况。\n\n* [发行说明内容类型](/zh/contributing/style-guide-and-content-model/release-note-content-type)\n\n  通过发行说明，读者能够了解每个版本的 GitHub 企业产品，并为面向用户的更改做好准备。\n\n* [入门内容类型](/zh/contributing/style-guide-and-content-model/get-started-content-type)\n\n  入门内容提供使用产品或功能的最小基本信息。\n\n* [快速入门内容类型](/zh/contributing/style-guide-and-content-model/quickstart-content-type)\n\n  快速入门最适合那些需要快速获得指示的读者，而不用对工作原理或使用它的原因进行冗长的解释。\n\n* [教程内容类型](/zh/contributing/style-guide-and-content-model/tutorial-content-type)\n\n  如果某些读者对产品有基本了解，并且有兴趣进一步深入理解，以解决特定问题，则教程非常有用\n\n* [关于合并多个内容类型](/zh/contributing/style-guide-and-content-model/about-combining-multiple-content-types)\n\n  可以在单个文章中合并多个内容类型，以帮助用户完成复杂的任务。\n\n* [关于参与编写 GitHub Docs](/zh/contributing/collaborating-on-github-docs/about-contributing-to-github-docs)\n\n  可以通过多种方式参与 GitHub Docs 内容的编写。\n\n* [在 GitHub Docs 上使用 Git](/zh/contributing/collaborating-on-github-docs/using-git-on-github-docs)\n\n  可以在命令行上使用 Git 以提交更改，然后将更改推送到文档存储库。\n\n* [使用 TODOCS 占位符留下注释](/zh/contributing/collaborating-on-github-docs/using-the-todocs-placeholder-to-leave-notes)\n\n  可以使用 `TODOCS` 占位符来指示仍需要完成的工作。\n\n* [使用内容 Linter](/zh/contributing/collaborating-on-github-docs/using-the-content-linter)\n\n  可以使用内容 Linter 检查你贡献的内容是否存在任何错误。\n\n* [标签引用](/zh/contributing/collaborating-on-github-docs/label-reference)\n\n  标签有助于找到你想要帮助解决的问题。\n\n* [在 codespace 中编辑 GitHub 文档](/zh/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace)\n\n  可以使用 GitHub Codespaces 处理 GitHub Docs 的文档。\n\n* [创建本地环境](/zh/contributing/setting-up-your-environment-to-work-on-github-docs/creating-a-local-environment)\n\n  可以在计算机上本地运行 GitHub Docs 应用程序。\n\n* [环境故障排除](/zh/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment)\n\n  了解如何解决本地环境和 GitHub Docs 暂存平台的问题。"}