很多人说,不知道怎么写文档,都是凭着感觉写。
网上也很少有资料,教你写文档。这已经影响了中文软件的发展。
英语世界里,文档非常受重视,许多公司和组织都有自己的文档规范,清楚地规定写作要求,比如微软、MailChimp、Apple、Yahoo、docker、Struts 等等(维基百科有一份完整的清单)。中文的也有不少,但都不令人满意,要么太简单,要么不太适用。
我就动手,参考上面的规范,也结合自己的实践,总结了一份简单的《中文技术文档的写作规范》。
我希望,这样可以抛砖引玉,让更多人重视文档,进而真正出现大家普遍接受的文档规范。
下面是关于写作风格的一个片段。欢迎提交 Issue 和 PR 补充。
=================================
写作风格
(摘自《中文技术文档的写作规范》)
如果使用了被动语态,应考虑更改为主动语态。
不使用非正式的语言风格。
用对"的"、"地"、"得"。
使用代词时(比如"其"、"该"、"此"、"这"等词),必须明确指代的内容,保证只有一个含义。
名词前不要使用过多的形式词。
句子的长度尽量保持在20个字以内;20~29个字的句子,可以接受;39~39个字的句子,语义必须明确,才能接受;多于40个字的句子,在任何情况下都不能接受。
同样一个意思,尽量使用肯定句表达,不使用否定句表达。
避免使用双重否定句。
(正文完)