一本說明書，教你全方位打造強迫症

話說，前段時間與同事聊天提及用戶手冊。我司用戶手冊最初由各組件開發人員自行編寫，後經整合及優化，逐步形成滿足基本交付的發布版本。但深究字句，仍覺得有較大提升空間。同事不解問道：不同的人寫作，語言表達上自然會有所差別，應該不算是什麼問題吧？——事實真的是這樣嗎？

如果留心觀察大企業的技術文檔就會發現，即便是由團隊共同開發規模較大的文檔，最終體現在文檔的語言風格上，差異也並不是很大——一定程度上，這也正是文檔質量的體現——那麼，他們又是如何做到的呢？

其實不難理解，兩個字：規範。就好比工業化生產的場景下，不同工人製造出來的產品，通常不會有明顯差異，道理是一樣的。

所以，這就不能不提到，技術文檔工程師無論如何也繞不開這樣一本說明書。對於搞技術的人可能知道，數據是用來描述事物的，而用來描述數據的數據，被稱作「元數據」；同理，這本說明書可被稱作「元說明書」，因為它是用來指導技術文檔工程師如何寫作說明書的說明書——有的公司稱之為「質量基線」，有的公司稱之為「Style Guide（樣式指導書）」，而我則樂於統稱為「寫作規範」——毫不誇張地說，這是一本專註培養強迫症患者的說明書。

IBM公司作為技術傳播領域的先行者，其寫作規範為行業樹立了標杆。作為一名資深寫說明書的，曾一度奉之為聖經，虔誠學習。接下來就來一探究竟，所謂「元說明書」中到底都寫了啥，把一批又一批的陽光明媚的大好青年，卓有成效地培養成一個個強迫症患者。當然，這同時也解釋了團隊開發的技術文檔，如何保持語言風格一致這個問題。

《The IBM Style Guide》顧名思義是IBM公司的樣式指導書，內容幾乎涵蓋了技術寫作中可能遇到的各種問題。讓我們翻開這本書試著讀一小段章節，看看裡面都寫了啥：

從第59頁到第63頁，用5頁篇幅只說明了一件事：如何使用句號，使用句號，句號，號……

啥？就如何使用句號這麼點兒破事兒，至於寫5頁的規範？很遺憾，答案是：至於。

顯然，在一本技術文檔中，不僅有句號，還有逗號、冒號、引號……各種各樣的符號，文字、單詞、句子……我就這麼說吧，這本《The IBM Style Guide》絮絮叨叨地對你能想到的一切寫作細節，都進行了詳細說明，總共有400多頁。

如果你以為這就是對技術文檔寫作的全部要求，那麼請允許我無情報以「呵呵」。事實上，IBM的技術文檔寫作書，一共包含三本，除了之前提到的《The IBM Style Guide》之外，還有《Developing Quality Technical Information》（500+P）和《DITA Best Practices》（200+P），分別從不同的角度對技術文檔寫作規範進行了定義：

• 《The IBM Style Guide》主要介紹技術文檔的寫作規範；
• 《DITA Best Practices》主要介紹技術文檔的內容組織方式——DITA（Darwin Information Typing Architecture）寫作；
• 《Developing Quality Technical Information》主要介紹技術文檔寫作的基本理念：Easy to use, Easy to understand, Easy to find

這還只是IBM一家企業的技術文檔規範，其實不同企業對於技術文檔的需求並沒有一定之規，都可以結合自身實際情況，制定適度適用的規範。而技術文檔工程師們就是這樣，每天在各種條條框框中，小心翼翼地工作，無論是誰，也難免有朝一日被打磨成一枚實實在在的強迫症患者。所以，如果你身邊剛好有個看起來神經兮兮的技術文檔工程師，整天較真兒不幹正經事，怪讓人討厭的，請務必理解並對TA好一點——誰也不是天生強迫，得了技術文檔寫作職業病，較真兒就是正經事啊！

由於技術傳播是個小眾的行業/職位，國內很多企業對技術文檔寫作並不十分了解，更談不上重視，以為懂技術、認識字，隨便誰都做得來。殊不知，技術傳播在國外已經發展成為非常專業化的領域。隨著中國的企業、產品不斷走出國門，走向更廣闊的國際市場，勢必會有越來越多的人認識到，信息分享、知識傳遞的重要性。把專業的事交給專業的人，作為技術產品交付的一部分，技術文檔同樣需要經受嚴格的規範不斷打磨，才能保證可靠的質量。

歡迎關注微信公眾號：TechComm

推薦閱讀：