英文技術(shù)文檔優(yōu)化實(shí)證

文/鄭旅芳 張鸰

1 引言

技術(shù)文檔作為產(chǎn)品和用戶之間的橋梁，是人們?nèi)粘Ｉ钪谐＝佑|的產(chǎn)品信息載體。技術(shù)文檔的瑕疵有可能降低公司產(chǎn)品在國際市場(chǎng)的接納度，甚至招致潛在的法律糾紛。近年來，中國企業(yè)特別是通信企業(yè)，對(duì)技術(shù)文檔的重視更是提升到一個(gè)前所未有的高度。[1]技術(shù)寫作是技術(shù)傳播最主要的手段，需要充分考慮用戶及其目的，將原來高深難懂的科技產(chǎn)品信息知識(shí)通過技術(shù)文檔變得簡(jiǎn)單通俗易懂，增加用戶對(duì)產(chǎn)品的接收度。Mike Markel提出技術(shù)文檔的內(nèi)容應(yīng)嚴(yán)格遵守準(zhǔn)確性、清晰性、簡(jiǎn)明性、一致性、客觀性、可用性等原則[2]13-14。Alan S.Pringle和Sara S.O’Keefe也指出技術(shù)文檔內(nèi)容要遵從清晰，易理解，準(zhǔn)確，簡(jiǎn)明，易遵循的指導(dǎo)原則[3]30。國內(nèi)學(xué)者王傳英，王丹等也在文獻(xiàn)中介紹了英文技術(shù)相應(yīng)的規(guī)范。[3]

國內(nèi)企業(yè)目前對(duì)于技術(shù)文檔標(biāo)準(zhǔn)規(guī)范認(rèn)識(shí)及應(yīng)用非常有限?！?015年中國技術(shù)寫作發(fā)展現(xiàn)狀調(diào)查報(bào)告》顯示，目前我國技術(shù)寫作人員訓(xùn)練的主要途徑是自學(xué)，其比例高達(dá)79.35%[5]，這說明多數(shù)國內(nèi)技術(shù)寫作人員缺少相關(guān)的訓(xùn)練。為了管窺國內(nèi)民企通信類產(chǎn)品英文說明書的狀況，本文通過對(duì)某民企外銷話機(jī)英文說明書的分析，從標(biāo)題格式、列表使用、信息歸類、語言表達(dá)等五個(gè)方面進(jìn)行診斷，探討了優(yōu)化的方案及其適切性，期望研究對(duì)相關(guān)企業(yè)的技術(shù)文檔改善有一定的參考意義。

2 英文技術(shù)寫作基本規(guī)范

技術(shù)文檔經(jīng)常用于指導(dǎo)讀者執(zhí)行某個(gè)動(dòng)作，或者幫助讀者完成相關(guān)的任務(wù)，它是讀者導(dǎo)向、注重實(shí)用性。從技術(shù)傳播視角，一份的技術(shù)文檔的質(zhì)量通?？梢詮囊韵聨讉€(gè)方面進(jìn)行衡量，如表1所示。

技術(shù)文檔的使命是與用戶交流信息，一份合格的技術(shù)文檔應(yīng)該是用詞準(zhǔn)確，清晰，易理解，[3]30這樣才能有效幫助用戶了解產(chǎn)品。有瑕疵的技術(shù)文檔不僅可能帶來冗余的文檔印刷成本，額外的用戶幫助支出等，甚至可能會(huì)給企業(yè)帶來潛在訴訟風(fēng)險(xiǎn)。

3 話機(jī)英文說明書樣本診斷及優(yōu)化建議

本研究樣本是國內(nèi)某一民企的話機(jī)說明書，用戶通過閱讀說明書可以找到大部分有用的信息，但在對(duì)照英文技術(shù)寫作規(guī)范后發(fā)現(xiàn)其在語言、格式等四個(gè)方面仍有較大的改善空間。

3.1 標(biāo)題瑕疵

在技術(shù)文檔中標(biāo)題是起引導(dǎo)作用的，它提前告知用戶每個(gè)章節(jié)部分所要講的內(nèi)容，幫助用戶找到想要的信息[6]235，表2所列為標(biāo)題語言規(guī)范。

根據(jù)表2，樣本中存在如下瑕疵并進(jìn)行相優(yōu)化

包裝清單模塊的標(biāo)題：Packaging contents，可以優(yōu)化改為Package content，因?yàn)闃?biāo)題內(nèi)容是物品的呈列，并未涉及步驟的操作，無需使用ing形式，優(yōu)化后使用動(dòng)詞原形為標(biāo)題更加簡(jiǎn)潔。

音量調(diào)節(jié)模塊的標(biāo)題：Volume Adjustment，可以優(yōu)化改為Adjust Volume，因?yàn)闃?biāo)題內(nèi)容是關(guān)于調(diào)節(jié)音量的步驟，屬于指令型信息，應(yīng)使用動(dòng)詞引導(dǎo)的標(biāo)題，加強(qiáng)每個(gè)信息模塊間的邏輯，便于用戶的掃讀和略讀。[6]249

3.2 列表缺位及使用瑕疵

列表的使用是化解長句的有效方法[2]216，列表使同樣的信息以更加清楚的形式呈現(xiàn)出來[7]121幫助用戶快速獲取需要的信息。具體使用規(guī)范如表3所示。

根據(jù)表3，樣本中存在如下瑕疵并進(jìn)行相應(yīng)優(yōu)化。

無序列表缺位的瑕疵例子：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.此為話機(jī)手動(dòng)配置的參數(shù)說明，有IP地址，子網(wǎng)掩碼，網(wǎng)關(guān)和首選DNS服務(wù)器和備選DNS服務(wù)器,由于這幾個(gè)參數(shù)的設(shè)置先后不存在邏輯上的先后關(guān)系，因此可以使用無序列表切分這些參數(shù)并垂直排列優(yōu)化見例1，這樣減少了每行的字?jǐn)?shù)，降低信息的密集度，用戶獲取信息的速度也會(huì)加快，也就是提高文檔的易讀性。

有序列表缺位的瑕疵例子：Press the Menu soft key when the phone is idle, select Advanced (default password admin)->Accounts to configure the account.此為話機(jī)賬號(hào)配置的步驟，在話機(jī)閑置時(shí)，按話機(jī)上的菜單鍵，再依次選擇高級(jí)設(shè)置，賬號(hào)，即可進(jìn)行賬號(hào)配置。由于在執(zhí)行賬號(hào)配置步驟時(shí)，按鍵選擇存在先后順序，即它們之間存在邏輯的先后關(guān)系。因此采用有序列表將需要執(zhí)行的步驟進(jìn)行縱向羅列優(yōu)化見例2，用戶知道總的操作步數(shù)，并按照正確的順序操作，在操作的同時(shí)可以檢驗(yàn)步驟的效果。[3]113

Static IP Address:

Configure those for the phone manually as follows:

表1：技術(shù)文檔的基本寫作規(guī)范

表2：標(biāo)題語言規(guī)范

表3：列表通用規(guī)范

表4：信息呈現(xiàn)的規(guī)范

● 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 信息歸類瑕疵

技術(shù)文檔中經(jīng)常會(huì)遇到指令型信息（步驟性信息）和描述型信息（說明性信息）摻雜在一起，給用戶的閱讀造成障礙。拆分摻雜的信息，將信息歸類，可以減輕用戶的閱讀負(fù)擔(dān)。信息呈現(xiàn)的具體規(guī)范如表4所示。

根據(jù)表4，樣本中的信息呈現(xiàn)存在如下瑕疵并進(jìn)行相應(yīng)優(yōu)化。

信息歸類瑕疵例子：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.啟動(dòng)話機(jī)的步驟模塊在話機(jī)連接上網(wǎng)絡(luò)和電源后，話機(jī)自動(dòng)啟動(dòng)。啟動(dòng)完成后，話機(jī)能正常使用。接著可以通過 Web界面或話機(jī)界面配置話機(jī)。由于這一部分是指令型信息，目的是讓用戶完成啟動(dòng)話機(jī)的任務(wù)，卻以描述型的口吻寫出，起不到操作指令的作用，用戶無法快速獲取下一步應(yīng)該做什么的信息。優(yōu)化見例3

按照指令信息的原則，首先告訴用戶指令要完成的目的，再將用戶需要執(zhí)行的動(dòng)作抽出單獨(dú)列出。并附上步驟執(zhí)行后的效果便于用戶檢測(cè)步驟的有效性。（當(dāng)然不是每一模塊的信息都要有前提描述部分和效果執(zhí)行的反饋部分，要根據(jù)具體情況。）

Start the phone as follows

● Connect IP phone to the power and network.

The “welcome “ message display on the screen例4

3.4 語言冗余瑕疵

技術(shù)文檔是用戶導(dǎo)向型的文本，其使用的語言要簡(jiǎn)潔，不累贅冗余。為使語言清晰、簡(jiǎn)練，技術(shù)作者應(yīng)避免使用不必要的名詞或動(dòng)詞詞組[8]。學(xué)者沈晚雙，賈曉云在其文獻(xiàn)中也指出技術(shù)文檔中要盡可能使用短句表達(dá)，可用一個(gè)詞就不用兩三個(gè)詞，[7]即可使用單個(gè)詞代替詞組和刪除無意義詞來消除此語言冗余現(xiàn)象。[8]

根據(jù)上述規(guī)范，樣本中存在如下瑕疵，并進(jìn)行相應(yīng)優(yōu)化。

詞義冗余的例子如話機(jī)的提示模塊：Note：You can add contacts from call history easily.For more information, refer to Call History above可以優(yōu)化改為Note：You can add contacts from call historyFor more information, refer to Call History above因?yàn)榧夹g(shù)寫作是客觀性寫作，“easily”帶有主觀的感情色彩，刪掉“easily”可使信息更加客觀。

詞數(shù)冗余的例子如話機(jī)撥打步驟：1.Pick up the handset可以優(yōu)化改為1.Lift the handset因?yàn)橛谩癓ift”意思單一的單詞代替意思多樣的詞組“Pick up”，避免用戶對(duì)文本的誤解的可能性。

4 優(yōu)化建議適切性探討

為了解前述提供的優(yōu)化建議的適切性，研究參考了國外同類競(jìng)品的英文說明書如美國Polycom公司、AVAYA公司和加拿大Mitel公司同類型的話機(jī)說明手冊(cè)在標(biāo)題格式、信息歸類、列表使用、信息呈現(xiàn)的使用狀況，發(fā)現(xiàn)許多支撐例子。

如在美國Polycom公司550電話機(jī)的說明書（User Guide for the Polycom? SoundPoint IP? 550 Phone SIP 3.1）中，介紹話機(jī)連接網(wǎng)絡(luò)和電源步驟的標(biāo)題均采用動(dòng)名詞形式的標(biāo)題；如在美國AVAYA公司電話機(jī)的使用手 冊(cè)（AVAYA Telephone Feature User Guide NN40170-101）中，介紹以會(huì)議主持人身份參加電話會(huì)議的操作指令不僅采用兩級(jí)的列表，還通過縮進(jìn)的列表的嵌套來使信息層級(jí)區(qū)分。

如在加拿大Mitel公司電話機(jī)使用手冊(cè)(Mitel 5320E IP Phone User Guide)中，介紹回?fù)茈娫捁δ艿男畔⑴判蚴敲枋鲂托畔⒃谙雀嬖V用戶回?fù)茈娫挼倪@個(gè)功能使用的場(chǎng)合以及要完成的任務(wù)，隨后是指令型信息告訴用戶收聽信息的具體步驟，最后才是用戶按照步驟操作后的效果。

通過對(duì)國外竟品英文說明書的上述分析，一方面可以了解到話機(jī)產(chǎn)品英文說明書的國內(nèi)外差異，另一方面也說明了本研究中相關(guān)優(yōu)化建議的適切性。

5 結(jié)語

上述實(shí)證分析可見該民企話機(jī)英文說明書與國外競(jìng)品英文說明書的差異體現(xiàn)在標(biāo)題語言、列表使用、信息歸類、等方面。該研究雖然僅是基于一家民營公司的某一產(chǎn)品的文檔分析，但分析結(jié)果對(duì)于開拓國際市場(chǎng)的其他國內(nèi)公司的技術(shù)文檔開發(fā)工作仍具有提示性。