写在前面

你的产品有多好并不重要。因为如果配上了一份极其敷衍的文档（Documentation），人们就不会使用它。 这话听起来可能有些绝对，毕竟在别无选择的时候，用户或许会试着使用你的产品来解决他们的燃眉之急。 但这种情况下，很难假设用户会按照预期去使用你的产品，要求做到高效率的使用，则更是一种奢望。

几乎每个人都明白这一点。几乎每个人都知道他们需要好的文档，而且大多数人都试图创建好的文档。而写作风格指南可以确保一个团队写出来的文档是一致的。

写作风格指南清单

下面，整理了一些技术文档的写作指南与大家分享，希望每一份优秀的产品都有一份比之更优秀的文档。

1. 谷歌开发者文档风格指南：https://developers.google.cn/style

2. 苹果风格指南：https://help.apple.com/asg/

3. 微软写作风格指南：https://docs.microsoft.com/en-us/style-guide/welcome/

4. 芝加哥手册指南：https://www.chicagomanualofstyle.org/

   Q&A：https://www.chicagomanualofstyle.org/qanda/latest.html

5. IBM 风格指南：https://www.ibm.com/developerworks/library/styleguidelines/index.html

6. Kubernetes 文档风格指南：https://kubernetes.io/docs/contribute/style/style-guide/

7. NLM 面向作者、编辑和出版商的风格指南：https://www.ncbi.nlm.nih.gov/books/NBK7256/?depth=2

8. 牛津大学风格指南：https://www.ox.ac.uk/sites/files/oxford/media_wysiwyg/University%20of%20Oxford%20Style%20Guide.pdf

9. 中文技术文档写作风格指南：https://zh-style-guide.readthedocs.io/zh_CN/latest/index.html

   说明：

   前 8 个都为英文版风格指南，只有最后一个为中文，个人也比较喜欢，其 Github 地址为 https://github.com/yikeke/zh-style-guide

写在后面

在小型创业公司，倒也没有写作风格指南这么一说，因为技术写作的也就几个人，写作风格完全自由。个人认为，如果是参与团队技术写作时，制定并遵循写作风格指南是完全必要的，以便给用户带来更好的信息体验。