简洁的魅力
表达简洁的优势在于:
- 容易理解。
- 容易维护。
技术文档写作实践中通常遵循以下原则。
把长句子切分成若干个短句
和任务类话题一样,一个句子只用来表达一个中心思想。把长句子按照中心思想进行切分,可以让表达的内容更容易理解。
把长句子转换成列表
有的长句子里包含并列的内容。我们可以把这些并列的内容挑出来,逐一列出,从而让层次更清晰,阅读起来也更快。
删除不必要的词
上学的时候,老师总是教我们多用词组,少用单个的词;多用高级句型,少用简单句型。而技术文档的规则却是反其道而行之。原因有二:
- 一是因为词组和复杂句让内容变得臃肿,用户遇到问题时必然是火急火燎,心焦气躁,倘若又遇到喋喋不休,云里雾里的文档必然会火冒三丈。用户需要清爽的,切中要害的教程,以解燃眉之急,而不是听一个学究在那里叨叨。比较:
- determine the location of vs find
- 二是因为技术文档会被翻译成多国语言,源语言字数越多,翻译费用越高;表达越冗余,译文质量越容易下降。
综上所述,技术文档不是作文题,看谁字数够,看谁写的炫;而是要容易懂,容易看,容易找,容易用。