为 GitHub 文档编写

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

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

我们的文档被翻译成多种语言。我们撰写英文文档的方法可以极大提高这些翻译的质量。

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

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

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

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

本指南说明如何创建满足 GitHub 文档用户需求的视频。

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

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

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

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

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

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

您可以对较长的代码示例进行注释，以说明它们的工作原理以及人们如何为其他用途自定义它们。

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