跳转至

Alt text

Documentation Style Guide

无论是对于个人、企业、学校还是政府,采用完善的文档风格规范对外进行文档发布,有非常多的优点:

  • 充分的展示自己的风格,通过良好的视觉体验向读者传递自己的价值。
  • 通过良好的风格设计,可以让文档眉目清晰、章节分明,为读者提供良好的阅读体验。同时,也能够让读者快速获得文档中的重要信息。
  • 对文档团队来说,会提高沟通效率,提高协作能力。

一份文档风格规范(Documentation Style Guide)通常会包含:语言的用词用语风格、文档的排版约定、文档内容元素。但并不限于此,也可能会包含具体文档工具的使用说明。

下面的清单是一份比较知名的公司或组织的文档规范:

技术类风格

非技术类风格

一些非技术类的文档风格,可以参考如下的几个规范:

一个中文类风格规范