英文技术文档优化实证

文/郑旅芳 张鸰

1 引言

技术文档作为产品和用户之间的桥梁，是人们日常生活中常接触的产品信息载体。技术文档的瑕疵有可能降低公司产品在国际市场的接纳度，甚至招致潜在的法律纠纷。近年来，中国企业特别是通信企业，对技术文档的重视更是提升到一个前所未有的高度。[1]技术写作是技术传播最主要的手段，需要充分考虑用户及其目的，将原来高深难懂的科技产品信息知识通过技术文档变得简单通俗易懂，增加用户对产品的接收度。Mike Markel提出技术文档的内容应严格遵守准确性、清晰性、简明性、一致性、客观性、可用性等原则[2]13-14。Alan S.Pringle和Sara S.O’Keefe也指出技术文档内容要遵从清晰，易理解，准确，简明，易遵循的指导原则[3]30。国内学者王传英，王丹等也在文献中介绍了英文技术相应的规范。[3]

国内企业目前对于技术文档标准规范认识及应用非常有限。《2015年中国技术写作发展现状调查报告》显示，目前我国技术写作人员训练的主要途径是自学，其比例高达79.35%[5]，这说明多数国内技术写作人员缺少相关的训练。为了管窥国内民企通信类产品英文说明书的状况，本文通过对某民企外销话机英文说明书的分析，从标题格式、列表使用、信息归类、语言表达等五个方面进行诊断，探讨了优化的方案及其适切性，期望研究对相关企业的技术文档改善有一定的参考意义。

2 英文技术写作基本规范

技术文档经常用于指导读者执行某个动作，或者帮助读者完成相关的任务，它是读者导向、注重实用性。从技术传播视角，一份的技术文档的质量通常可以从以下几个方面进行衡量，如表1所示。

技术文档的使命是与用户交流信息，一份合格的技术文档应该是用词准确，清晰，易理解，[3]30这样才能有效帮助用户了解产品。有瑕疵的技术文档不仅可能带来冗余的文档印刷成本，额外的用户帮助支出等，甚至可能会给企业带来潜在诉讼风险。

3 话机英文说明书样本诊断及优化建议

本研究样本是国内某一民企的话机说明书，用户通过阅读说明书可以找到大部分有用的信息，但在对照英文技术写作规范后发现其在语言、格式等四个方面仍有较大的改善空间。

3.1 标题瑕疵

在技术文档中标题是起引导作用的，它提前告知用户每个章节部分所要讲的内容，帮助用户找到想要的信息[6]235，表2所列为标题语言规范。

根据表2，样本中存在如下瑕疵并进行相优化

包装清单模块的标题：Packaging contents，可以优化改为Package content，因为标题内容是物品的呈列，并未涉及步骤的操作，无需使用ing形式，优化后使用动词原形为标题更加简洁。

音量调节模块的标题：Volume Adjustment，可以优化改为Adjust Volume，因为标题内容是关于调节音量的步骤，属于指令型信息，应使用动词引导的标题，加强每个信息模块间的逻辑，便于用户的扫读和略读。[6]249

3.2 列表缺位及使用瑕疵

列表的使用是化解长句的有效方法[2]216，列表使同样的信息以更加清楚的形式呈现出来[7]121帮助用户快速获取需要的信息。具体使用规范如表3所示。

根据表3，样本中存在如下瑕疵并进行相应优化。

无序列表缺位的瑕疵例子：Static IP Address: If your phone cannot contact a DHP server for any reason, you need to configure the IP address, subnet mask, gateway address, primary address and DNS address for the phone manually.此为话机手动配置的参数说明，有IP地址，子网掩码，网关和首选DNS服务器和备选DNS服务器,由于这几个参数的设置先后不存在逻辑上的先后关系，因此可以使用无序列表切分这些参数并垂直排列优化见例1，这样减少了每行的字数，降低信息的密集度，用户获取信息的速度也会加快，也就是提高文档的易读性。

有序列表缺位的瑕疵例子：Press the Menu soft key when the phone is idle, select Advanced (default password admin)->Accounts to configure the account.此为话机账号配置的步骤，在话机闲置时，按话机上的菜单键，再依次选择高级设置，账号，即可进行账号配置。由于在执行账号配置步骤时，按键选择存在先后顺序，即它们之间存在逻辑的先后关系。因此采用有序列表将需要执行的步骤进行纵向罗列优化见例2，用户知道总的操作步数，并按照正确的顺序操作，在操作的同时可以检验步骤的效果。[3]113

Static IP Address:

Configure those for the phone manually as follows:

表1：技术文档的基本写作规范

表2：标题语言规范

表3：列表通用规范

表4：信息呈现的规范

● the IP address

● subnet mask

● gateway address

● primary DNS address

● secondary DNS address

例1

When the phone is idle

1) Press Menu soft key

2) select Advanced

3) select Accounts

例2

3.3 信息归类瑕疵

技术文档中经常会遇到指令型信息（步骤性信息）和描述型信息（说明性信息）掺杂在一起，给用户的阅读造成障碍。拆分掺杂的信息，将信息归类，可以减轻用户的阅读负担。信息呈现的具体规范如表4所示。

根据表4，样本中的信息呈现存在如下瑕疵并进行相应优化。

信息归类瑕疵例子：After the IP phone is connected to the network and supplied with power, it automatically begins the initialization process.After startup the phone is ready for use.You can configure the phone via phone user interface or web user interface.启动话机的步骤模块在话机连接上网络和电源后，话机自动启动。启动完成后，话机能正常使用。接着可以通过 Web界面或话机界面配置话机。由于这一部分是指令型信息，目的是让用户完成启动话机的任务，却以描述型的口吻写出，起不到操作指令的作用，用户无法快速获取下一步应该做什么的信息。优化见例3

按照指令信息的原则，首先告诉用户指令要完成的目的，再将用户需要执行的动作抽出单独列出。并附上步骤执行后的效果便于用户检测步骤的有效性。（当然不是每一模块的信息都要有前提描述部分和效果执行的反馈部分，要根据具体情况。）

Start the phone as follows

● Connect IP phone to the power and network.

The “welcome “ message display on the screen例4

3.4 语言冗余瑕疵

技术文档是用户导向型的文本，其使用的语言要简洁，不累赘冗余。为使语言清晰、简练，技术作者应避免使用不必要的名词或动词词组[8]。学者沈晚双，贾晓云在其文献中也指出技术文档中要尽可能使用短句表达，可用一个词就不用两三个词，[7]即可使用单个词代替词组和删除无意义词来消除此语言冗余现象。[8]

根据上述规范，样本中存在如下瑕疵，并进行相应优化。

词义冗余的例子如话机的提示模块：Note：You can add contacts from call history easily.For more information, refer to Call History above可以优化改为Note：You can add contacts from call historyFor more information, refer to Call History above因为技术写作是客观性写作，“easily”带有主观的感情色彩，删掉“easily”可使信息更加客观。

词数冗余的例子如话机拨打步骤：1.Pick up the handset可以优化改为1.Lift the handset因为用“Lift”意思单一的单词代替意思多样的词组“Pick up”，避免用户对文本的误解的可能性。

4 优化建议适切性探讨

为了解前述提供的优化建议的适切性，研究参考了国外同类竞品的英文说明书如美国Polycom公司、AVAYA公司和加拿大Mitel公司同类型的话机说明手册在标题格式、信息归类、列表使用、信息呈现的使用状况，发现许多支撑例子。

如在美国Polycom公司550电话机的说明书（User Guide for the Polycom® SoundPoint IP® 550 Phone SIP 3.1）中，介绍话机连接网络和电源步骤的标题均采用动名词形式的标题；如在美国AVAYA公司电话机的使用手 册（AVAYA Telephone Feature User Guide NN40170-101）中，介绍以会议主持人身份参加电话会议的操作指令不仅采用两级的列表，还通过缩进的列表的嵌套来使信息层级区分。

如在加拿大Mitel公司电话机使用手册(Mitel 5320E IP Phone User Guide)中，介绍回拨电话功能的信息排序是描述型信息在先告诉用户回拨电话的这个功能使用的场合以及要完成的任务，随后是指令型信息告诉用户收听信息的具体步骤，最后才是用户按照步骤操作后的效果。

通过对国外竟品英文说明书的上述分析，一方面可以了解到话机产品英文说明书的国内外差异，另一方面也说明了本研究中相关优化建议的适切性。

5 结语

上述实证分析可见该民企话机英文说明书与国外竞品英文说明书的差异体现在标题语言、列表使用、信息归类、等方面。该研究虽然仅是基于一家民营公司的某一产品的文档分析，但分析结果对于开拓国际市场的其他国内公司的技术文档开发工作仍具有提示性。