技术文档写作风格指南

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

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

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

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

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

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

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

查看更多

APK汉化手记 & 现金流游戏放出

🔮汉化项目 现金流游戏 Windows 版本 现金流游戏 Android 版本 💡Q&A 为什么是 CASHFLOW GAME ?这是一款经典的财商益智游戏,国内名称多样,现金流游戏/穷爸爸富爸爸/老鼠赛跑,游戏里的东西虽然是虚的,但思路还是可以借鉴的,学会改善自己的财商与现金流,2020年四处暴雷,

中卢周刊(第1期):内卷的打工人

作者: 卢东东日期: 2020年10月30日 这里记录过去一周,我看到的值得分享的东西,周五发布。对于喜欢无休止探索折腾各类科技问题的我,阮一峰老师创立的科技爱好者周刊无疑让我得益匪浅,于是“西颦东效”,建立了《中卢周刊》。 长久以来,我一直用各种方式,尝试整理我的收藏夹。最近想到,把它写

想和他做朋友?​

请您带上菊花与¥

Scroll to Top