中文技术文档的写作规范

中文技术文档的写作规范

本文总结了一份简单的《中文技术文档的写作规范》，参考了微软、MailChimp、Apple等公司的文档规范，并结合了作者的实践经验。希望这份指南能帮助更多人重视文档写作，进而推动中文软件行业的发展。

写作风格

（摘自《中文技术文档的写作规范》）

避免被动语态

错误：假如此软件尚未被安装，
正确：假如尚未安装这个软件，

使用正式语言

错误：Lady Gaga 的演唱会真是酷毙了，从没看过这么给力的表演！！！
正确：无法参加本次活动，我深感遗憾。

正确使用"的"、"地"、"得"

她露出了开心的笑容。
（形容词＋的＋名词）
她开心地笑了。
（副词＋地＋动词）
她笑得很开心。
（动词＋得＋副词）

清晰的代词指代

错误：从管理系统可以监视中继系统和受其直接控制的分配系统。
正确：从管理系统可以监视两个系统：中继系统和受中继系统直接控制的分配系统。

控制名词前的形式词数量

错误：此设备的使用必须在接受过本公司举办的正式的设备培训的技师的指导下进行。
正确：此设备必须在技师的指导下使用，且指导技师必须接受过由本公司举办的正式设备培训。

控制句子长度

句子的长度尽量保持在20个字以内；20～29个字的句子，可以接受；39～39个字的句子，语义必须明确，才能接受；多于40个字的句子，在任何情况下都不能接受。

错误：本产品适用于从由一台服务器进行动作控制的单一节点结构到由多台服务器进行动作控制的并行处理程序结构等多种体系结构。
正确：本产品适用于多种体系结构。无论是由一台服务器（单一节点结构），还是由多台服务器（并行处理结构）进行动作控制，均可以使用本产品。

使用肯定句表达

同样一个意思，尽量使用肯定句表达，不使用否定句表达。

错误：请确认没有接通装置的电源。
正确：请确认装置的电源已关闭。

避免双重否定

错误：没有删除权限的用户，不能删除此文件。
正确：用户必须拥有删除权限，才能删除此文件。