文档写作规范

几条实用规则

1. 文明名称必须使用小写，不能含有空格
2. 数字和单位之间必须要加空格
3. 数字使用半角字符
4. 标题按层级来不要一级标题下面跟三级标题
5. 避免使用长句，长度尽量保持在20个子以内；20～29 个字的句子可以接受；30～39 个字的句子语义必须明确才能接受；多余40个字句子任何情况都不能接受
6. 省略号英文下使用 … 中文下使用 ……
7. 引用第三方内容必须注明出处，例如：本文转载自 wiki
8. 数字的增加使用“增加了”、“增加到”。 “了”表示增量，“到”表示定量
9. 数字的减少要是“降低了”、“降低到”。

参考链接

1. 中文文案排版指北
2. 加空格
3. w3c 中文排版要求
4. 为什么文件要小写
5. Google dc style guide
6. 中华人民共和国国家标准
7. GB 3100-1993 国际单位制及其应用
8. 中文技术文档的写作规范