分类: 服务器与存储
2017-02-07 16:50:53
很多人说,不知道怎么写文档,都是凭着感觉写。
网上也很少有资料,教你写文档。这已经影响了中文软件的发展。
英语世界里,文档非常受重视,许多公司和组织都有自己的文档规范,清楚地规定写作要求,比如、、、、、Struts 等等(维基百科有一份完整的)。中文的也有不少,但都不令人满意,要么太简单,要么不太适用。
我就动手,参考上面的规范,也结合自己的实践,总结了一份简单的《中文技术文档的写作规范》。
我希望,这样可以抛砖引玉,让更多人重视文档,进而真正出现大家普遍接受的文档规范。
下面是关于写作风格的一个片段。欢迎提交 Issue 和 PR 补充。
=================================
(摘自《中文技术文档的写作规范》)
如果使用了被动语态,应考虑更改为主动语态。
不使用非正式的语言风格。
用对"的"、"地"、"得"。