技术文档写作风格指南

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

这是一个创建于 1695 天前的主题，其中的信息可能已经有所发展或是发生改变。

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

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

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.英语使用中的常见错误

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

6.Kubernetes 文档风格指南

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

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

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

指南

文档

官网

写作

9 条回复 • 2020-04-03 16:22:44 +08:00

wikinee

2020-04-03 09:50:55 +08:00

@rcx100 在这里，单开一贴。

raymanr

2020-04-03 09:55:46 +08:00

这些规则都是人定的, 而且过一段时间变一次, 个人觉得没有必要拘泥于这些

文档结构清楚, 表达清楚意思就行了

Vegetable

2020-04-03 09:56:51 +08:00

@raymanr 这些都不是规则,而是 guide,核心是告诉开发者不要做什么.

B1ankCat

2020-04-03 10:44:44 +08:00

Remember that everything in the guide is a guideline, not a draconian rule

a6600648

2020-04-03 10:50:21 +08:00

clash 天下第一

wikinee

2020-04-03 15:26:09 +08:00

@B1ankCat @Vegetable 哈哈，你们入门了。上面那个还在纠结。
不光文档风格，所有的代码风格第一条都是：“如果你项目已经有比较成熟的风格了，就使用它。”

wikinee

2020-04-03 15:26:33 +08:00

@a6600648 小恐龙也 666.

rcx100

2020-04-03 16:19:01 +08:00 via Android

@wikinee 感谢大佬

xuboying

2020-04-03 16:22:44 +08:00

google 那个记得有大佬翻译过了