风格指南和内容模型

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

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

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

使用主题使文章可搜索。

人们在学习对他们来说是新事物时，最常使用概念性内容。

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

过程性内容提供了有关任务如何融入某人更大目标的背景。

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

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

快速入门最适合那些想要快速获得说明的人，而无需对事物的工作原理或为什么要使用它进行冗长的解释。

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

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