技术文档写作风格指南

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

摘自 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/

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

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

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

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

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

查看更多

湛卢通讯 – lssue #2

重启少年的浪漫 少年曾经有很多想法,后来都一一归于平淡。 言论 一个好的领导(或者产品经理),应该具备五项技能:SQL、Excel、简洁写作、讲故事、区分优先级。 旁边的程序看完之后想说,最好是个女的… 循此苦旅,直抵群星 苹果发布会提前,迫于开发进度,主力开发不惧背刺怒升顶配开肝!Respect!!! 推荐

湛卢通讯 – Issue #1

《湛卢周刊》-> 《湛卢通讯》周刊定义:周刊指的是一星期出版一次的书刊,杂志或文摘。 札记之类的出版物。对于目前的我来说,负担太重,导致实际更新发稿的时候根本不想发布。 今天起,写 Newsletter,写随心所欲的,不受定义的「湛卢通讯」目前是一份自我观察的 Newsletter。 不要给自

想和他做朋友?​

请您带上菊花与¥

Scroll to Top