为 GitHub Docs 撰写内容

遵循这些最佳实践，创建用户友好且易于理解的文档。

我们的文档理念指导我们创建什么内容以及如何创建内容。

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

我们的文档被翻译成多种语言。我们如何处理英文文档的编写方式可以极大地提高这些翻译的质量。

遵循这些 SEO 最佳实践，帮助用户使用搜索引擎查找 GitHub 文档。

GitHub Docs 使用 YAML 前置内容和 Liquid 运算符，通过单一来源方法支持多个版本的 GitHub。

您可以使用 Markdown 和 Liquid 来格式化内容、创建可复用的内容以及为 GitHub Docs 上的不同版本编写内容。

您可以使用 YAML 前置内容来定义版本控制、添加元数据以及控制文章的布局。

本指南说明如何创建支持 GitHub Docs 用户需求的视频。

您可以创建可复用的内容，这些内容可以在多个内容文件中引用。

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

本指南说明何时以及如何为 GitHub Docs 创建图表。

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

如果文章的标题、版本或位置发生更改，您可以创建到当前内容的重定向。

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

您可以注释较长的代码示例，以解释它们的工作原理以及人们如何将其自定义以用于其他用途。

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