如何當個優秀的文檔工程師？從 TC China 看技術文檔工程師的自我修養

本文系 NebulaGraph Community Academic 技術文檔工程師 Abby 的參會觀感，講述了她在中國技術傳播大會分享的收穫以及感悟。

據說，技術內容領域、傳播領域的專家和決策者們會在中國技術傳播大會「tcworld China 2022」大會上分享心得。作爲一名技術文檔工程師，本着瞭解相關行業的發展趨勢和提升自我爲 NebulaGraph 社區創造更大價值的心態，參加了此次大會。第一次參加 tcworld China 技術傳播大會，乾貨挺多，記錄一下參會的收穫和感受。

tc，技術內容，全稱 technical content。既然是技術內容，那麼技術內容是如何進行傳播呢？

初看，會覺得技術傳播和作爲內容生產者的技術文檔工程師或資料開發沒有半毛錢關係。然而，是本人坐井觀天了：全場聽下來，許多課程主題涉及“從內容到營銷”，當中不乏營銷常出現的詞彙——“故事傳播”、“內容運營”、“視頻傳播”等等。即便是針對產品編寫的"說明書"，也是需要考慮用戶和其使用場景，這正是傳播的邏輯。除了涉及“從內容到營銷”主題，大會還分享了文檔呈現及編輯器的演進和發展、文檔工程師的價值等主題內容。

下面由我帶大家回顧一下這次的技術傳播學習之旅。

課程主題

聽了技術傳播大會的大部分課程，從「技術文檔工程師的價值」到「如何傳播運營技術內容中的各個環節」，本次大會都有對應的課程主題。大會課程主題可以形成一條鏈路：

注：TW，全稱 Technical Writer，即技術文檔工程師。

乾貨及思考

大會中對技術文檔工程師的價值、文檔內容編輯方式、呈現方式、運營方式的現狀及發展趨勢做了相應的分享。在這過程中，我也收穫了一些新知識和有了自己的一些思考。

技術文檔工程師的價值

首先，技術文檔工程師是什麼？引用百科中的一句話———“文檔工程師，是指協同開發人員，收集資料，安排開發計劃，編寫企業項目開發所需的各類文檔，同時保證文檔的質量、安全等的技術人員，他們肩負着軟件開發過程中信息處理與整合的重要職責。面對“文檔”，他們需要完成包括安排開發計劃、制定各類模板、跟蹤編寫進度以及編輯管理等在內的一系列工作，實現文檔處理的“一條龍”服務。”

有人可能會說技術文檔工程師就是給產品 / 項目編寫文檔的人員。這也就延伸出來一個現象：文檔工程師的價值經常被挑戰。有些老闆甚至文檔工程師自身會想，爲什麼企業不訓練一個開發工程師來直接寫技術文檔呢？這樣他對技術的理解還會更強。爲什麼還要設立這樣的專職的崗位？

首先，這樣的技術人員不太好找，具有技術文檔編寫能力的技術人大多都希望深耕自身的技術領域，而不願意去寫這些對“硬”技能能力提升不多的內容。畢竟，相較於文檔更輕量的註釋已經夠讓技術人頭疼了。另外，就是專業的技術文檔所呈現的內容無論是可讀性，還是對產品的理解會比其他人寫出來的更好、更貼近用戶。目前，全球許多大企業都在大量聘用技術文檔工程師，像海康、阿里都有幾十人的技術文檔團隊，人力不足的時候還需要外包。企業願意付出這樣的成本去招聘相關人才，就證明了技術文檔工程師有其獨特的價值存在。

這也是爲什麼會專門存在這樣的部門。因爲，之前未設立技術文檔部門時，其他人來寫這塊內容呈現的效果非常差、用戶體驗不佳。因此，很多企業纔會存在技術文檔這個部門，來幫助企業解決人員分工問題。假如一個企業裏的技術人員既要寫東西，還要去做技術或是去設計產品，就會出現超級節點。那麼，分工的出現就解決這一痛點：專門的人才從事文檔編寫，專門的人才來搞技術，這樣才能把分工內的東西做精做好。

如何提升文檔團隊的影響力

作爲文檔工程師，首先需要肯定和提升自己的認知維度，提升文檔團隊的影響力，具體怎麼做？參考下列方式：

打破角色固化的認知，拒絕做邊緣人。文檔角色只能輸出內容嗎？不止是這樣，文檔可以發現 bug、瞭解和分析用戶需求、給產品設計提需求及意見。
有意識地訓練產品思維，保持對產品的好奇心和敏感度。
多接觸真實的用戶，去現場給用戶培訓，更好地瞭解用戶實際使用產品中遇到的問題，減輕用戶的學習成本。像是 NebulaGraph 這類開源產品，會經常查看社區用戶常提到的問題，並將該問題和解決方案寫在文檔中。
學習用戶體驗法則、尼爾森的十大可用性原則，利用「用戶旅程地圖」發掘機會點。
從用戶痛點出發提出問題，並給出初步解決方案，和產品交互進行溝通並推動提升用戶體驗，從而提升文檔團隊的影響力。

招聘和培養英文技術文檔

如果技術內容傳播還泛指國際上的傳播，那麼英文技術文檔對於產品的國際化具有關鍵作用。tcworld China 2022 分享中提到，在進行英文技術寫作人員招聘過程中，常常遇到三個問題英文能力不足、技術能力不足、寫作能力不足。

當急需人才、短期內又招不到人的情況下，企業可以轉變思維，對英文技術翻譯人員進行培訓。在語言和寫作方面，英文技術翻譯人員上手會相對較快。剩下的就是對其技術方面的專門培訓。像是英文技術文檔這種人羣的招聘前提也是需要 ta 們具有很強的學習意願和能力。

文檔未來

聽完全場，我更喜歡 RWS 呼延韶文老師分享的《文檔未來》課程，他從內容的創作方式和內容的應用端兩個方面分享了文檔的發展趨勢。

內容創作方式

文檔的創造方式，已經從最初的紙質版轉爲電子版（Word / PDF）的方式交付。文檔正從紙質轉變爲電子再轉變成數字化。文檔數字化，指文檔內容模塊化、結構化、文檔生產流程的雲化、文檔和用戶的可交互性。《文檔未來》提到 Forrester 預測文檔下一個十年，新型基於雲端、數據驅動、結構化的文檔創作方式將成爲主流。基於結構化、模塊化主題內容，還可做到文檔內容的自動組合、更新自動推送等等。文檔內容呈現的發展的最後階段是交互性內容，用戶可以和內容進行交互（多以 HTML + CSS 實現）。與技術的互動，從文本到交互界面，是由產品設計引發的潛意識過程所引導的。技術傳播者越是瞭解這種心理過程，越能創造出互動強的文檔。

不僅僅《文檔未來》提到了文檔內容的模塊化、結構化，其他的課程《讓技術文檔智能化交付+多場景呈現》、《如何構建知識百科並營銷，共建產業生態》也都提到了文檔內容的模塊化和結構化。結構化的主題內容可以一源多用，並多格式發佈。相對傳統的編輯方式，結構化能起到降本增效的作用。這種結構化、模塊化的內容呈現是基於 XML 的體系結構，比較火熱且流行的標準是 DITA 標準。目前，NebulaGraph 技術文檔團隊正在使用開源的文檔編輯軟件 MkDocs Material（參考延伸閱讀），滿足目前的內容複用需求。隨着文檔內容量不斷增多，後續可以考慮使用結構化、模塊化的編輯軟件創作文檔內容。

內容應用端

文檔內容發佈後，用戶需要在門戶網站瀏覽文檔內容。那麼，如何呈現內容或者說如何組合內容以提升用戶體驗呢？這個部分的內容和後面《開源網站信息架構的攻守之道》提到的信息架構有相似之處。在應用端（文檔網站）可以做的用來提升用戶體驗的事情：

語義化的搜索能力，搜索引擎可以根據用戶的使用場景，搜索詞語的意思檢索到目標內容。
知識模塊化，基於 XML 體系的內容發佈。
智能內容，智能機器人可以推送用戶搜索的問題。
考慮用戶常搜索的關鍵字，考慮 SEO 創作內容。

信息架構 IA

在參加這次技術傳播大會之前，我只是知道 IA（Information Architecture）這個詞比較火，但不懂什麼是真正的信息架構。信息架構是什麼？用途是啥？參加了大會後，大概知道了 IA 的概念，但是還是有點模糊具體是 IA 是做什麼？於是在網上找到了一篇淺顯易懂的《如何進行信息架構設計？》。下文僅列舉相關概念。