Skip to main content

Enterprise Server 3.15 目前作为候选发布提供。

风格指南和内容模型

了解如何让 GitHub 文档保持一致、易于遵循且可以维护。

风格指南

按照本指南操作,确保 GitHub 的文档保持一致,并遵循读者可以理解的明确规律。

关于内容模型

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

GitHub Docs 文章的内容

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

关于主题

使用主题让文章便于搜索。

概念性内容类型

人们在了解新内容时最常使用概念性内容。

参考内容类型

参考内容提供了用户在主动使用某个功能时所需的详细信息。

程序性内容类型

程序性内容提供了有关任务如何适应某些用户的更高目标的上下文。

故障排除内容类型

故障排除内容包括用户可能会遇到的内置错误、向支持人员报告的常见问题,以及用户在完成任务时可能遇到的情况。

发行说明内容类型

通过发行说明,读者能够了解每个版本的 GitHub 企业产品,并为面向用户的更改做好准备。

快速入门内容类型

快速入门最适合那些需要快速说明的读者,无需对工作原理或使用它的原因进行冗长的解释。

教程内容类型

如果某些读者对产品有基本了解,并且有兴趣进一步深入理解,以解决特定问题,则教程非常有用

关于合并多个内容类型

可以在单个文章中合并多个内容类型,以帮助用户完成复杂的任务。