产品文档最讲究两点：简明扼要，文风一致。
“简明扼要”尚可依仗技术写作人员的专业能力来实现，可“文风一致”怎么做到呢? 靠技术写作人员的个人感觉吗? 如果产品文档需要多人共同完成，怎样办?
答案是：标准化。参与文档编写的所有人员，遵循统一的标准来进行写作。这个标准，叫做技术文档写作指南（Style Guide）。
写作指南里，可以规定写作原则、术语库、标题和缩略语的写法、标点符号的使用方法、单位的使用方法、无障碍阅读设计原则、以及跨设备阅读设计原则等方方面面的内容。
有了写作指南，技术写作人员在写作时就有章可循、有规可守，即使多人协作也能“异口同声”。
有些行业推行业内通用的技术文档写作指南，比如航空业的 ASD-STE100 。但大多数行业没有统一标准，需要企业自行编写。
还没有自己的技术文档写作指南? 别愁！虽然编写作指南的难度系数很高，但你完全不需要从零开始。
很多“个高”的公司（比如微软、谷歌、苹果），不仅编写出了优质的技术文档写作指南，实时维护，还把它们免费公开了！
虽然你可能属于不同的行业，但这些写作指南里的很多写作原则却是通用的，而且已经被广泛验证过。
如果这些还不够，文末还有更权威、更详尽的泰斗级写作指南作后盾呢！
ASD-STE100
ASD-STE100 起源于航空航天业和国防部门，是专门为了降低操作手册和维修手册的阅读难度而编写的一种英语语言规范。
在很多领域里，英语是使用率最高的国际通用语言。但对于很多人来说，英语并非母语，很难读懂手册里的多义词、生僻单词、俗语、以及结构复杂的长句子。
一旦飞行员、维修工程师、培训人员等工作人员对手册里的操作规范理解有误，进行了不正当操作，势必会危及全体乘客的生命安全。
正是基于这种需求，欧洲航空航天和国防工业协会（ASD）联合美国航空航天工业协会（AIA）共同调研并编制了 ASD-STE100。
ASD-STE100 要求在手册中使用简洁的语言向读者传递准确、不包含歧义的信息。它由两大部分构成：
- 写作原则
- 受控词库
ASD-STE100 不涉及格式、标点符号、缩略语、单位等内容，只能作为技术文档写作指南的一部分，并不能独立使用。
目前，ASD-STE100 的使用范围已经远远超出了航空航天业，在很多行业中推广开来。
官方渠道：前往 ASD-STE100 官网下载申请表，填好后发送至 stemg@asd-ste100.org。之后，工作人员会将 PDF 版 ASD-STE100 免费发送到你的邮箱。
IBM 技术文档写作指南
这是 IBM 于 2011 年出版的技术文档写作指南，堪称技术写作的教科书。
这里面，英语语法、标点符号、文档架构、单位、格式、词汇表等写作指南的标准构件一应俱全。
难能可贵的是，这本书不仅给出了这些元素的基本概念，还现身说法——为每一条写作原则提供写作实例和讲解。很多技术写作人员把它当成技术写作的入门必备教材。
作为 DITA 的开创者，IBM 还在这本书里对主题化写作和 DITA 的三大主题类型进行了科普。
微软技术文档写作指南
这是微软现行的技术文档写作指南，也是所有消费型产品在编写产品文档时应该参照的金科玉律。
像平常聊天一样讲述产品，友善、轻松、简洁、清晰，想用户所想。这，是微软技术写作的最高原则。
微软写作指南将最高原则分解成十大原则，然后又将十大原则分解成一条条简单的小原则、小技巧。
这本指南本身，就是产品文档的范本。有情怀，有格调，有方法，完美！
这是我最喜欢的一本技术文档写作指南，谷歌也将它列为官方参考资料之一呢！
谷歌开发者技术文档写作指南
谷歌写作指南非常注重屏幕感，包含一些微软写作指南里没有涉及的建议。
比如，如何使用 HTML 元素，Markdown 与 HTML 之间如何选择，为了方便屏幕阅读而限定每行不能多于 80 个字符 ……
如果你的产品文档也提供网页版，不妨好好看看这本写作指南。谷歌甚至还有一本 Google HTML/CSS Style Guide 呢！
官方文档：Google Developer Documentation Style Guide
苹果技术文档写作指南
相比于微软与谷歌，苹果的写作指南非常简单，内容上也没什么亮点。
不过这本指南的官网界面设计非常不错，首页还提供了四本界面设计指南的链接。
如果你正要为自己的产品文档创建网页版，看完谷歌的技术建议之后，不妨也顺道来这里取取经，找找灵感。
官方文档：Apple Style Guide
Gitlab 技术文档写作指南
作为一家代码托管平台，Gitlab 的技术文档写作指南格外注重内容重用和协作共享，科技感十足。
Gitlab 使用 Markdown 编写文档。写作指南里对 Markdown 中各种元素的使用方法进行了详细说明，并使用测试程序自动验证文档格式是否正确、链接是否有效。如果文档不符合规范，就不能成功提交。
Gitlab 使用 Git 对文档进行版本管理，就像管理代码一样。作为一款开源软件，Gitlab 文档的贡献者众多。为此，写作指南中不仅对文档修改和提交流程进行了详细说明，还对 Gitlab 的文档架构进行了详尽的阐述。
如果你正苦于不知道如何进行文档管理，这本写作指南可算是雪中送炭了！
官方文档：Gitlab Documentation Style Guide
SUSE 技术文档写作指南
SUSE 是德国的一家操作系统（Linux）提供商。
SUSE 写作指南的独特之处在于，它是一本使用 DocBook 编写产品文档的写作指南。
写作指南里详细说明了产品文档的章节划分和内容架构，以及各部分内容应该使用的 DocBook 元素，并配有 XML 代码实例。
如果你也使用 DocBook，这本技术写作指南可不容错过哦！
官方文档：SUSE Documentation Style Guide
Mailchimp 技术文档写作指南
Mailchimp 是一家邮件营销软件提供商。
可能出于职业习惯，除了技术写作的原则之外，Mailchimp 还不遗余力地总结了：
- 营销邮件的写作原则；
- 在社交平台（如微博、朋友圈、知乎、领英）上发布内容的创作规范。
虽然 Mailchimp 是在规范自己的营销行为，但这似乎一点也不妨碍我们照猫画虎（吧?）。
官方文档：Mailchimp Content Style Guide
红帽技术文档写作指南
红帽公司是总部位于美国的一家开源解决方案供应商，2018 年被 IBM 收购。
红帽的写作指南很传统，很详细，强调正式感和庄重感。在这一点上，红帽与微软的风格截然不同。
格式手册和词典
技术文档写作指南可繁可简，最重要的是适合企业自身的实际需要。
但不管写作指南是繁是简，都不可能包罗万象。产品文档编写过程中，总会遇到没有在写作指南中预设的场景。在这种情况下，可以将一些外部资源作为写作指南的补充。
以下是技术文档写作指南中常用的参考资源：
写作指南中最好明确说明，哪些外部资源可供参考，这些外部资源有没有优先级，等等。
现在，你可以站在巨人们的肩头上编写自己的技术文写作指南了！
