风格指南和内容模型

遵循本指南，确保 GitHub 文档保持一致，并遵循读者能够理解的清晰模式。

内容模型描述了我们发布内容的结构和类型。

每篇文章都包含一些标准元素，并且可能包含条件或可选元素。我们还在文章中使用标准内容顺序。

使用主题使文章易于搜索。

当人们学习对他们来说全新的内容时，他们最常使用概念性内容。

参考性内容提供人们在积极使用功能时所需的详细信息。

程序性内容提供有关任务如何融入某人更大目标的上下文。

故障排除内容包含我们期望人们遇到的内置错误、报告给支持部门的常见问题以及人们在完成任务时可能遇到的情况。

发行说明使读者能够理解并为 GitHub 版本化企业产品的每个版本的对用户可见的更改做好准备。

快速入门最适合希望快速获得说明，而无需详细解释内容如何工作或为什么要使用它的用户。

当某人对产品有基本了解并有兴趣扩展其理解以解决特定问题时，教程很有用

您可以在一篇文章中组合多种内容类型，以帮助人们完成复杂的任务。