让句子简洁有力
简洁有力的句子主要靠两点:
- 使用具体的词而不是宽泛的词。
- 使用简洁的结构而不是复杂的结构。
选择有力的动词
许多技术文档作者都把动词看作句子的灵魂。选对了动词,就等于成功了一半。但是,现实中我们往往会使用很多弱化句子的词汇,比如:
- be动词
- occur
- happen
比较:
- This error message happens when … vs The system generates this error message when …
- We are very careful to ensure … vs We carefully ensure …
试试去掉 there be
比较:
- There is a lot of overlap between X and Y. vs X and Y overlap a lot.
是不是简洁了很多?
删掉不必要的形容词和副词
和那些博人眼球、激发购买欲的营销文案不同,技术文档是写实的、客观的、准确的。过于夸张的词语会降低技术文档的可信度,给人一种被推销的感觉。因此,技术文档写作尽可能采用平实的语言和精准的数据。
综上所述,技术文档的语言想要简洁有力,就要多从贴切的动词、简单的结构和平实的语言上下功夫。