句子写作方法¶
文章是由句子组成的,句子是文档写作的最小单元,句子的简洁明了是文档传达信息的基础。技术文档中,一句话只能有一个动词。一句话只能有一个动词。
避免使用长句¶
长句一般是指结构复杂、修饰成分较多、词语较多的句子,短句是指结构简单、词语较少的句子。句子的长短是相对而言的,没有截然的界限。
控制句子长度¶
不包含任何标点符号的单个句子,或者以逗号分隔的句子构件,长度控制在 30 个字以内;多于 40 个字的句子,任何情况下都不能接受。以逗号分割的长句,总长度不应该超过 100 字。
错误示例:
本产品适用于从由一台服务器进行动作控制的单一节点结构到由多台服务器进行动作
控制的并行处理程序结构等多种体系结构。
正确示例:
本产品适用于多种体系结构。无论是由一台服务器(单一节点结构),还是由多台服
务器(并行处理结构)进行动作控制,均可以使用本产品。
避免使用复合句¶
尽量使用简单句和并列句,避免使用复合句。
并列句示例:
他昨天生病了,没有参加会议。
复合句示例:
那个昨天生病的人没有参加会议。
改变展现形式¶
一个句子中有很长的定语、状语和补语时,可以使用列表的形式展现。
错误示例:
小灵通有着资费廉价、绿色环保、带宽独享的优点,同时又有功能少、覆盖差、不能
漫游、重复建设的缺点。
正确示例:
小灵有如下特点:
- 资费廉价
- 绿色环保
- 带宽独享
- 功能少
- 覆盖差
- 不能漫游
- 重复建设
语义明确¶
句子语义要明确,不能有多种解释,要明确“是”或“否”。这一要求对于翻译和非母语读者尤其重要。
保持信息一致¶
保持词汇、术语的前后统一,全文保持一致。
错误示例:
BIM 有 7 种接口板类型,其中 BIM0~BIM5 为可插拔的无源单板,BIM6 为不可插拔
的接口卡。
正确示例:
BIM 有 7 种接口板类型,其中 BIM0~BIM5 为可插拔的接口板,BIM6 为不可插拔的
接口板。
避免产生歧义¶
使用正确的修饰词,并注意修饰词的位置。避免采用多个连续的名词,否则,会加大读者阅读和理解上的难度。
错误示例:
系统的时钟和主控单元
正确示例:
系统的时钟和系统的主控单元
主控单元和系统的时钟
使用主动语态¶
使用主动语态,尽量不使用被动语态。一般情况下,主动语态比被动语态更有说服力。
错误示例:
假如此软件尚未被安装,请正确安装该软件。
正确示例:
假如尚未安装这个软件,请正确安装该软件。
多使用陈述句、祈使句。
错误示例:
我们把伞撑开了
伞被我们撑开了
伞难道没有撑开吗?
陈述句示例:
我们撑开了伞
祈使句示例:
撑开伞
使用肯定句¶
同样一个意思,使用肯定句表达,不使用否定句表达。
错误示例:
请确认没有接通装置的电源。
正确示例:
请确认装置的电源已关闭。
禁止使用双重否定句¶
句子要简单明确,不饶弯子,显然双重否定句不符合这种要求。
错误示例:
没有删除权限的用户,不能删除此文件。
正确示例:
用户必须拥有删除权限,才能删除此文件。
代词指代明确¶
使用代词时(比如“其”、“该”、“此”、“这”、“它”等词),必须明确指代的内容,保证只有一个含义。
错误示例:
从管理系统可以监视中继系统和受其直接控制的分配系统。
正确示例:
从管理系统可以监视两个系统:中继系统和受中继系统直接控制的分配系统。
其它¶
避免使用表示程度、强调语气的副词。技术文档是严谨的,要给出准确的描述,不要带有个人感情。
描述具体¶
使用具体、明确、展示细节的词汇,将读者代入情境。避免使用情感描述。
错误示例:
他满意地拿走了辛苦挣来的奖赏。
正确示例:
把硬币放进口袋里,他咧开嘴笑了。
的、地、得¶
用对“的”、“地”、“得”,。
形容词 + 的 + 名词示例:
她露出了开心的笑容。
副词 + 地 + 动词示例:
她开心地笑了。
动词 + 得 + 副词示例:
她笑得很开心。
少用形容词¶
名词前不要使用过多的形容词。减少形容词的使用,少用“的”。
错误示例:
此设备的使用必须在接受过本公司举办的正式的设备培训的技师的指导下进行。
正确示例:
此设备必须在技师的指导下使用,且指导技师必须接受过由本公司举办的正式设备
培训。