分类: 中文版

技术写作不同于其他形式的写作,其目的通常是为读者提供关于某一物品的使用指导,以帮助他们解决问题。由于技术写作有这样一个独特、明确的目标,因此,良好的技术写作总是会遵循一定的原则。

我们总结了 7 个在技术写作中应该格外注意的问题,如果能规避这些问题、遵循一定的原则,你也能写出相对高质量的技术文档。

1、语言精确,避免模棱两可

在技术写作中,要避免一些模棱两可的表达,例如:

错误:“很快”、“大量”、“稍后”、“很重”、“很多” 等

在翻译时这些词语可以有多种理解,“很快” 是多长时间?“大量” 到底是多少?

此外,这些术语在时间上是相对的:35 年前曾被认为的 “很短时间”,可能在未来很被认为是 “很长时间”。

由于科技的进步,技术文档中一些不精确的语言将被淘汰。因此,在技术写作中要使用尽可能具体、精确的描述。

2、使用主动语态,少用被动语态

主动语态比被动语态的表达更强烈、更直接。例如:

错误:“您的帐户信息被用于登录”
正确:“请使用您的帐户信息登录”

主动语态通常更清晰、更简洁。但是,技术写作中有时候也使用被动语态,例如,当主体不明的或客体更重要时,或者当主动语态暗示某一失控状况应该归咎于读者时,最好使用被动语态。例如:

错误:“如果你无法启动系统……”
正确:“如果系统无法启动……”

你可以体会一下两种说法之间的区别。

3、言简意赅,去除不必要的信息

技术写作要言简意赅。如果不能帮助用户解决问题,就要舍去。关于某项技术内部运行原理的各种细节,或者称赞这一技术成就的营销性语言,都不应该出现在技术文档中。

unnecessary information

例如,普通消费者要设置家庭路由器时并不需要理解路由技术,他们也没必要阅读那些营销材料,从而了解他们已经购买的产品值得购买。

4、使用一般现在时,而非将来时

在技术写作中,将来时不如现在时更加直接。我们可以比较一下两个时态,例如:

错误:“当您插上电源线时,设备将自动启动。”
正确:“当您插上电源线时,设备自动启动。”

将来时对于事物的进展似乎有一些不确定性。相比之下,现在时的表达更加直接、确定。由于技术写作经常需要描述一系列操作及其执行结果,因此现在时更能清晰说明问题。

5、逻辑清晰,避免结构混乱

清晰的组织架构是写好技术文档的关键。相关信息应该便于查找并且具有一定的逻辑顺序。

legal writing

无论是描述一个简单的程序,或是决定每个章节的布局,拥有合理、直观的结构能够避免逻辑混乱,并且提供良好的用户体验。

6、句式简单,避免复杂长句

技术文档中的大部分内容都是指导性的,因此句子应尽可能简单。例如:

错误:“创建两个设备之间的连接”
正确:“连接两个设备”

尽量使用动词形式,而不是名词形式,并且使用简单的祈使句。

7、恰当使用图表,代替枯燥文字

技术作者能够用易于理解的语言解释复杂的概念。有时,用上千个字描述不明白的东西,很可能一张图就能解释清楚。图表直观、生动,不仅吸引读者,而且有时是传达信息最好的方式。

Diagrams

明白易懂、使用恰当的图表或插图可以帮助用户最终解决问题,否则,用户可能会由于困惑而放弃一个产品。因此,能够通过一些图形化的表达来说明问题,一定比纯文字的表达更加容易理解。

CSOFT 华也国际的技术写作团队是位于中国的全外籍母语写作团队, 我们的技术作者了解中国市场、熟悉中国语言和文化, 拥有丰富的写作经验,具备国际标准,可以提供物超所值的完美解决方案。

 

本文由华也国际市场文案 Shirley Guo 编译

Related:  自然语言处理下的机器翻译和神经机器翻译技术有什么区别?