做了十幾年的IT研發(fā)工作，對(duì)用戶文檔這塊工作一直沒有太多關(guān)注。用戶文檔屬于產(chǎn)品的附屬部分，從項(xiàng)目管理角度看，用戶文檔往往不在項(xiàng)目的關(guān)鍵路徑上，占項(xiàng)目預(yù)算比例低，技術(shù)風(fēng)險(xiǎn)、日程風(fēng)險(xiǎn)都很低，一旦發(fā)生問題，影響往往也不大，問題也容易得到解決。在項(xiàng)目管理中，往往不會(huì)過多關(guān)注用戶文檔。
最近一段時(shí)間，對(duì)寫作產(chǎn)生了很大興趣，開始關(guān)注技術(shù)寫作和身邊的技術(shù)寫手們，通過和她們交流，開始對(duì)技術(shù)寫作有了一些初步認(rèn)識(shí)。
什么是技術(shù)寫作？
技術(shù)寫作是一個(gè)專業(yè)領(lǐng)域，是通過寫作來進(jìn)行技術(shù)傳播，比如大家經(jīng)常見到的產(chǎn)品說明書，用戶操作手冊(cè)，安裝指南等，它為各行各業(yè)服務(wù)，比如計(jì)算機(jī)、電子、醫(yī)藥、機(jī)械等，形式多樣，有紙質(zhì)媒體，電子文檔，網(wǎng)頁(yè)，在線幫助等。
技術(shù)寫作有著特定的范圍，不是一個(gè)泛指的名詞，很多和技術(shù)相關(guān)的寫作并不屬于“技術(shù)寫作”行業(yè)的范疇，比如《科學(xué)美國(guó)人》里的科普文章，技術(shù)網(wǎng)站上的產(chǎn)品評(píng)測(cè)報(bào)告等。
從事技術(shù)寫作的專業(yè)人員叫做技術(shù)寫手，她們完成專業(yè)的技術(shù)文檔。
技術(shù)寫作在國(guó)外很普遍，在國(guó)內(nèi)尚未引起足夠的重視。比如在維基百科上，Technicalwriting, technical writer等相關(guān)條目都沒有中文版本。國(guó)內(nèi)從事技術(shù)寫作的往往是跨國(guó)公司，技術(shù)寫手們配合國(guó)內(nèi)研發(fā)團(tuán)隊(duì)提供面向全球的英文版的技術(shù)文檔，和本地化的技術(shù)文檔。大部分國(guó)內(nèi)公司往往對(duì)技術(shù)寫作不夠重視，各種用戶手冊(cè)和國(guó)際水平相差較大。一些優(yōu)秀的國(guó)內(nèi)公司，比如華為，對(duì)技術(shù)寫作非常重視，對(duì)中文的技術(shù)寫作發(fā)展起到推動(dòng)作用。
技術(shù)寫手的背景
國(guó)內(nèi)專業(yè)的技術(shù)寫手大部分從事英文技術(shù)文檔寫作，尤其以信息行業(yè)居多。專業(yè)背景主要來源于兩方面，語(yǔ)言相關(guān)專業(yè)和技術(shù)相關(guān)專業(yè)。技術(shù)寫作既需要語(yǔ)言、寫作能力，也需要技術(shù)能力。寫手們也需要對(duì)兩者都抱有很大興趣。
技術(shù)寫手們走向這條職業(yè)發(fā)展道路，也往往是由興趣驅(qū)動(dòng)。技術(shù)專業(yè)背景的對(duì)于語(yǔ)言和寫作有著濃厚的興趣，語(yǔ)言專業(yè)的對(duì)于技術(shù)產(chǎn)生興趣，這種跨界的興趣又恰好被技術(shù)寫手這樣一個(gè)職業(yè)所滿足，既能滿足個(gè)人的興趣，又能提供一個(gè)職業(yè)發(fā)展空間。重視技術(shù)寫作的公司又往往是有品位的業(yè)界領(lǐng)先公司，能提供比較好的工作環(huán)境和企業(yè)文化。
技術(shù)寫手們往往具有穩(wěn)定的職業(yè)軌跡，較強(qiáng)的職業(yè)認(rèn)同感。
技術(shù)寫作的特點(diǎn)
技術(shù)寫作的閱讀對(duì)象是各種用戶，主要目的是技術(shù)傳播，寫作風(fēng)格要求客觀、中性，使各類用戶能夠準(zhǔn)確、快速的了解必要的產(chǎn)品信息。
因?yàn)槟康暮湍繕?biāo)對(duì)象的不同，技術(shù)寫作不像各類文案、文學(xué)作品一樣要去打動(dòng)人心、優(yōu)美的語(yǔ)言。反而很多時(shí)候要反其道而行之。
簡(jiǎn)潔、準(zhǔn)確，用詞要簡(jiǎn)潔、準(zhǔn)確，行文要簡(jiǎn)潔、準(zhǔn)確，結(jié)構(gòu)要簡(jiǎn)潔、準(zhǔn)確，在準(zhǔn)確傳達(dá)信息的基礎(chǔ)上，還要盡可能的節(jié)省用戶時(shí)間。對(duì)于國(guó)際化的產(chǎn)品，目標(biāo)用戶可能來源于世界各地，技術(shù)寫作有可能會(huì)用到簡(jiǎn)單英語(yǔ)，這是英語(yǔ)的一個(gè)子集，精選了必要的少量詞匯和語(yǔ)法，用于基本的表達(dá)，簡(jiǎn)單英語(yǔ)可以大大降低非母語(yǔ)英語(yǔ)讀者的閱讀門檻，同時(shí)減少歧義。除此之外，還有各種寫作的風(fēng)格可供大家借鑒。
技術(shù)文檔，需要幫助用戶在合適的時(shí)候發(fā)現(xiàn)合適的內(nèi)容，往往并不是要求用戶順序閱讀的，所以往往是采用結(jié)構(gòu)化的方式來組織各種信息。怎么組織，如何設(shè)計(jì)結(jié)構(gòu)，信息在什么地方呈現(xiàn)，信息如何匯集，這些都大有學(xué)問，需要精心設(shè)計(jì)。良好的結(jié)構(gòu)設(shè)計(jì)有利于用戶及時(shí)發(fā)現(xiàn)準(zhǔn)確的信息，也有助于文檔工作者維護(hù)、修改。
管理成熟的跨國(guó)公司，往往具有完善的技術(shù)寫作規(guī)范，比如愛立信公司，就詳細(xì)定義了寫作的語(yǔ)言風(fēng)格，文檔的結(jié)構(gòu)，生成文檔、查看文檔的工具，文檔寫作、審查、驗(yàn)證的流程，確保了技術(shù)文檔的質(zhì)量和全球各地用戶閱讀技術(shù)文檔的體驗(yàn)。
技術(shù)寫手的成長(zhǎng)
技術(shù)寫手需要在寫作和技術(shù)上協(xié)同發(fā)展，很多寫手反映技術(shù)的學(xué)習(xí)和提高是非常關(guān)鍵的。有多種學(xué)習(xí)途徑，通過翻譯學(xué)習(xí)，閱讀手冊(cè)學(xué)習(xí)，觀摩具體的操作，操作相關(guān)的產(chǎn)品、從做中學(xué)，向技術(shù)團(tuán)隊(duì)同事學(xué)習(xí)，同行之間的切磋和互相學(xué)習(xí)。
技術(shù)寫手經(jīng)常要面對(duì)新的產(chǎn)品和技術(shù)，需要不斷的學(xué)習(xí)，這是挑戰(zhàn)，也是這份工作帶來的樂趣所在。一個(gè)優(yōu)秀寫手的成長(zhǎng)除了自身之外，也需要環(huán)境的支持，包括技術(shù)團(tuán)隊(duì)的支持和同行的支持。
一個(gè)有經(jīng)驗(yàn)的技術(shù)寫手，需要有同理心，站在終端用戶的角度去考慮，用戶閱讀文檔的時(shí)候是什么場(chǎng)景，如何滿足他的需要，如何帶來更好的用戶體驗(yàn)等等。
為了實(shí)現(xiàn)這些目標(biāo)，滿足用戶需求并帶來良好的用戶體驗(yàn)，技術(shù)寫手需要像設(shè)計(jì)師一樣工作，她需要了解用戶心理。有些技術(shù)內(nèi)容很重要，但是用戶有可能會(huì)忽略掉、或者遺忘，需要考慮適當(dāng)?shù)膹?qiáng)調(diào)和合理的重復(fù)。對(duì)于復(fù)雜的產(chǎn)品，龐雜信息項(xiàng)目，各種不同級(jí)別的細(xì)節(jié)程度，如何組織結(jié)構(gòu)，信息放置在什么部分，什么層次，哪些位置都需要精心。輸出的文檔，產(chǎn)生的過程如同其他技術(shù)產(chǎn)品、軟件產(chǎn)品一般，都需要設(shè)計(jì)、思考、表達(dá)，滿足用戶體驗(yàn)，所不同的就是工具和產(chǎn)品的形式不同而已。
技術(shù)寫作和研發(fā)團(tuán)隊(duì)的配合
技術(shù)文檔也是向客戶最終交付的輸出物之一,文檔的內(nèi)容和產(chǎn)品的功能和操作息息相關(guān)。技術(shù)文檔的交付往往也由產(chǎn)品經(jīng)理（產(chǎn)品負(fù)責(zé)人）負(fù)責(zé)。由產(chǎn)品負(fù)責(zé)人和技術(shù)寫手溝通產(chǎn)品的功能，技術(shù)文檔需要包括的范圍，比如新功能描述、操作、安裝、配置等。技術(shù)寫手負(fù)責(zé)完成具體的寫作工作，技術(shù)文檔的內(nèi)容還需要專業(yè)的測(cè)試人員進(jìn)行測(cè)試，用來保證文檔和產(chǎn)品的一致性。
在寫作過程中，寫手需要和開發(fā)團(tuán)隊(duì)密切合作，了解產(chǎn)品的具體操作、配置等必要的細(xì)節(jié)，在敏捷開發(fā)環(huán)境下，新功能在短周期內(nèi)進(jìn)行快速迭代，寫手需要配合迭代的節(jié)奏完成相關(guān)的文檔工作。
研發(fā)團(tuán)隊(duì)本身也有很多研發(fā)文檔需要完成，比如架構(gòu)文檔，設(shè)計(jì)文檔，測(cè)試文檔等，在研發(fā)實(shí)踐中，很多技術(shù)人員具備很好的技術(shù)能力，但是缺乏必要的文檔寫作能力，文檔質(zhì)量不高，很多時(shí)候?qū)е卵邪l(fā)效率下降。技術(shù)寫手如果能夠和研發(fā)團(tuán)隊(duì)密切合作，快速、有效的提高研發(fā)團(tuán)隊(duì)的基本文檔寫作能力，對(duì)于提高研發(fā)效率、產(chǎn)品質(zhì)量也是大有幫助的。
尾聲
用戶說明書、手冊(cè)往往是隨著產(chǎn)品一起交付的，和產(chǎn)品、產(chǎn)品的包裝一樣屬于用戶體驗(yàn)的一部分。喬布斯要精心設(shè)計(jì)iPod,iPhone的外包裝，形狀、大小、顏色，還有內(nèi)包裝，產(chǎn)品和各個(gè)配件的放置方法，甚至設(shè)計(jì)了用戶如何打開包裝，如何看到產(chǎn)品，如何把配件一一拿起的過程，這全部都是用戶體驗(yàn)。
用戶說明書也是這個(gè)體驗(yàn)的一部分，對(duì)于很多產(chǎn)品來說，用戶在使用產(chǎn)品之前會(huì)快速的查看簡(jiǎn)要的說明書，或者說明書的某些章節(jié)，在使用過程中也有可能查閱技術(shù)文檔，也可能會(huì)時(shí)時(shí)查看聯(lián)機(jī)說明，這些都是用戶和產(chǎn)品互動(dòng)的一部分，也是很重要的用戶體驗(yàn)。需要進(jìn)行思考和設(shè)計(jì)。
技術(shù)寫手不只是寫手，她們也是設(shè)計(jì)師、思想者和產(chǎn)品制造者。她們交付的技術(shù)文檔，也是用戶體驗(yàn)的一部分。目前，或許只有真正優(yōu)秀的產(chǎn)品才能真正投入精力提高技術(shù)文檔的質(zhì)量。希望將來能看到越來越多的優(yōu)秀產(chǎn)品和設(shè)計(jì)精良的技術(shù)文檔。
