技术文档写作风格指南

最近发现谷歌有个开发者文档写作指南，还有附带的其他家指南整理，贴出来。

摘自 V2EX wikinee

其实准确来说应该是（英语）写作指南，里面有太多英语文法类说明，大家自行取舍。

谷歌开发者文档风格指南

官网： https://developers.google.cn/style

苹果风格指南

官网： https://help.apple.com/asg/

微软写作风格指南

官网： https://docs.microsoft.com/en-us/style-guide/welcome/

芝加哥手册指南

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

英语使用中的常见错误

官网： https://brians.wsu.edu/common-errors/

Kubernetes 文档风格指南

官网： https://kubernetes.io/docs/contribute/style/style-guide/

我曾经想翻译其中一个文档，弄完第一章我就把项目删了，太累。

在此感谢那些无私把技术文档翻译成中文的引路人。

好多人都建议直接读英文；也不是读不了，但是毕竟有个阅读速度的问题，中文的可以一目十行，英文的就不行了。还是个人水平不行吧。

我发这个本意是想给做翻译的提建议，翻译是个折磨人的事情，如果翻译出来的东西达不到”可以食用“的程度，我建议还是不要浪费自己翻译的时间和精力。

这类文档基本上都是开发者们自发翻译的，没有报酬也不图回报，有人愿意一直维护就已经很不错了。
如果你觉得质量不行，你也可以自己参与到翻译的工作中去，让它变得更好。