为 GitHub Docs 编写内容

按照这些最佳做法即可创建用户友好且易于理解的文档。

我们的文档理念指导我们创建的内容以及创建内容的方式。

在 GitHub Docs 上发布的所有内容必须满足这些基本要求。

我们分享这些原则，为使用 GitHub 的人员设计和创建最佳内容。

我们的文档已翻译成多种语言。 我们编写英语文档的方式可以大大提高这些翻译的质量。

遵循以下 SEO 最佳做法，帮助用户使用搜索引擎来查找 GitHub 文档。

GitHub Docs 使用 YAML 前辅文和 Liquid 运算符通过单一源方法支持 GitHub 的多个版本。

可以使用 Markdown 和 Liquid 在 GitHub Docs 上设置内容格式、创建可重用内容，以及为不同版本编写内容。

可以使用 YAML 前辅文来定义版本控制、添加元数据和控制文章的布局。

本指南介绍如何创建支持用户对 GitHub Docs 的需求的视频。

可以创建可在多个内容文件中引用的可重用内容。

你可以通过将屏幕截图添加到 GitHub Docs 来帮助用户找到用户界面中难以找到的元素。

本指南介绍何时与如何为 GitHub Docs 创建关系图。

可以使用工具切换器来演示如何使用特定工具完成任务。

如果文章的标题、版本或位置发生更改，则可以创建指向最新内容的重定向。

当必须更改文章的标题时，可能需要在多个位置更新名称。

可以批注较长的代码示例，以说明它们的工作原理以及用户如何自定义它们以用于其他用途。

本文包含 GitHub Docs 中使用的不同内容类型的入门模板。