Foreword
如果你有過 Technical Writer 實習(xí)或工作經(jīng)歷，那么對技術(shù)寫作的流程應(yīng)該已經(jīng)了解爆袍。當(dāng)然首繁，在很多大公司里作郭，你參與的很可能只是這個流程的某一個環(huán)節(jié)。例如弦疮，你只負責(zé)寫夹攒，或者只負責(zé) review，或者只負責(zé)文檔架構(gòu)胁塞。相比之下芹助，在創(chuàng)業(yè)公司里，可能會參與多個環(huán)節(jié)闲先。
如果你是尚未畢業(yè)而且也沒有相關(guān)實習(xí)經(jīng)歷的在校生状土，或者已經(jīng)工作但有意轉(zhuǎn)行做 Technical Writer 的小伙伴，那么可能對技術(shù)寫作流程仍存疑惑伺糠，或者一知半解蒙谓。
不同公司技術(shù)文檔流程的劃分可能略有差異，但從本質(zhì)上來看训桶，則大同小異累驮。無論你在這個流程中的哪個環(huán)節(jié)，從宏觀上了解整個流程有助于讓你的認識更加清晰舵揭，也有助于在有需求時從容地承擔(dān)其它環(huán)節(jié)的工作谤专。
這里跟大家分享一個完整的技術(shù)文檔寫作流程，你只需記住六個單詞即可午绳。如下圖所示：
再說明一下置侍，你從工作中已經(jīng)了解或即將接觸的技術(shù)寫作流程不一定與上圖完全一致，但一個完整的流程一般都會涵蓋這些內(nèi)容拦焚，區(qū)別多半是主觀劃分而已蜡坊，這一點不必拿出“大家來找茬”的精神死磕哦~
1. Preparation 準(zhǔn)備階段
準(zhǔn)備階段的工作主要包括以下幾點：
- 明確文檔需求
- 明確文檔受眾
- 界定文檔范圍
在寫文檔之前，需要明確文檔需求赎败。你要了解為什么要寫這篇文檔秕衙，寫這篇文檔是為了達到什么目的。
也要明確文檔受眾僵刮。受眾不同据忘，內(nèi)容就很可能不同。比如搞糕，面向開發(fā)人員和非開發(fā)人員/普通用戶的文檔勇吊，在內(nèi)容的組織上就會不同。
還要界定文檔范圍寞宫。思考并確定這篇文檔需要覆蓋哪些內(nèi)容或模塊萧福，以及不會涉及哪些內(nèi)容。這樣在之后搜集資料的時候就會有所側(cè)重辈赋，寫的時候也不會模糊不定鲫忍。
2. Research 調(diào)研階段
有過技術(shù)文檔寫作經(jīng)歷的小伙伴一定會深有同感，如果不理解某個東西钥屈，那么給它寫文檔簡直太痛苦悟民。
那么當(dāng)遇到一個讓你毫無頭緒的陌生主題時，該如何盡量避免這種痛苦呢篷就？當(dāng)然就是盡最大可能去理解了射亏。
可是具體該如何做呢？簡言之竭业，即搜集資料智润。那又該如何搜集資料呢？筆者認為未辆，可以從以下幾點著手：
1）對比較有代表性的同類產(chǎn)品或相似產(chǎn)品的相關(guān)文檔進行調(diào)研窟绷，看看別人的文檔是怎么做的。
在一無所知的時候咐柜，借鑒他人的經(jīng)驗做法不失為一種好的選擇兼蜈。通過對幾家產(chǎn)品的文檔進行對比，你就可以對自己要寫的文檔建立一個大致的框架拙友。
需要注意的是为狸，借鑒不是照搬，只用于提供思路遗契；產(chǎn)品不同辐棒，文檔的結(jié)構(gòu)規(guī)劃也會有差異。
2）采用最有效的方法盡力搜集與所寫文檔相關(guān)的各種資料牍蜂。
搜集的資料經(jīng)過 Technical Writer 的摘刪組織涉瘾，很可能就會成為發(fā)布文檔的一部分。
搜集資料的方法有很多捷兰，像網(wǎng)絡(luò)搜索立叛、調(diào)查問卷、訪談贡茅、實驗秘蛇，以及郵件討論、報告顶考、技術(shù)文章等等赁还。到底該使用哪種方法要具體分析，需要你根據(jù)文檔需求驹沿、Deadline艘策、已有資料的豐富程度等因素，來選擇能快速而準(zhǔn)確地搜集到所需資料的方法渊季。
有些主題的寫作朋蔫，通過網(wǎng)絡(luò)搜索可能幾乎無法給你提供任何幫助罚渐。即便是這類內(nèi)容，你也可以從開發(fā)人員那里獲得一些資料驯妄，可以根據(jù)自己的需求請他們協(xié)助提供資料荷并，抑或是通過內(nèi)部系統(tǒng)中的開發(fā)說明和討論獲取所需信息。
對于軟件類的產(chǎn)品文檔青扔，即便有了一些技術(shù)資料源织，也往往需要 Technical Writer 自己使用一遍，從而對操作步驟有一個直觀的理解微猖，獲得文檔寫作的一手資料谈息。
3. Organization 文檔架構(gòu)
當(dāng)資料搜集得差不多的時候就可以組織這篇文檔的具體結(jié)構(gòu)了，之前對相似產(chǎn)品的調(diào)研或許可以在此時助你一臂之力凛剥。
對于常見的產(chǎn)品使用指南侠仇，一般按照安裝或使用的順序進行組織；對于其它一些非指南類的文檔当悔，也應(yīng)遵循一定的順序或邏輯傅瞻。
此外，還需考慮該文檔是否需要配圖盲憎，是否需要使用表格嗅骄。如果需要配圖，明確是需要他人協(xié)助提供饼疙，還是需要自己完成溺森。畫一個較復(fù)雜的圖也是一件蠻耗時的事情，花費的時間也需考慮在內(nèi)窑眯。
有了詳細的文檔架構(gòu)之后屏积，就可以進行下一步的寫作了。
4. Writing 文檔寫作
如果做好了前幾步的工作磅甩，寫作將變得非常簡單炊林，你只需把相應(yīng)的內(nèi)容準(zhǔn)確地填到文檔架構(gòu)中。在這個過程中卷要，你需要寫一個個段落或者具體的操作步驟渣聚。這是一個反映你的語言和寫作功底的時刻。
有的 Technical Writing 書籍中說到僧叉，在寫文檔的時候不必在意語法奕枝、措辭和標(biāo)點，認為這些細節(jié)應(yīng)該在 Revision 階段完善瓶堕。
Expand your outline into paragraphs, without worrying about grammar, refinements of language usage, or punctuation. Writing and revising are different activities; refinements come with revision. - Handbook of Technical Writing
我對此有不同的看法隘道。一個合格的 Technical Writer 本身應(yīng)該有良好的語言功底，像語法、措辭和標(biāo)點這種最基礎(chǔ)的細節(jié)本就不該成為一個需要單獨解決的問題谭梗。規(guī)范的語法忘晤、得體的措辭、正確的標(biāo)點應(yīng)該已經(jīng)成為一種不需要額外付出精力默辨、也幾乎不會占用額外時間的寫作習(xí)慣德频。
如果寫作的初稿比較粗糙苍息，有許多需要修改的小細節(jié)缩幸，這必定會增大 review 時的工作量和時間成本，從而延緩文檔流程竞思。
或許表谊，對于有精細化分工、每個人只負責(zé)一個小環(huán)節(jié)的大企業(yè)盖喷，可以采用這種方法爆办。但是，對于快速發(fā)展课梳、需要文檔敏捷開發(fā)的創(chuàng)業(yè)公司距辆，這種就不適用了。
5. Revision 審閱修改
寫完文檔第一稿后暮刃，一般都需要進一步修改完善跨算。這里的 Revision 指的是 review 之后的修改，所以這一步也可以叫作：Review & Revision椭懊。
那么需要誰來 review 呢诸蚕？技術(shù)文檔通常需要請其他小伙伴進行兩種 review，即：
- Technical Review：從技術(shù)層面看文檔中的描述是否正確有效
- Language Review：從語言層面看文檔中的表達是否簡潔得體
收到 reviewer 的反饋之后氧猬，Technical Writer 需要及時作出判斷和修改背犯，有不明確的地方需和 reviewer 討論確定。改完之后盅抚，再請 reviewer 看一下漠魏。如果又發(fā)現(xiàn)了新的問題，那么還需要再次修改妄均。這個 review - revise 的過程可能會反復(fù)幾次柱锹，很正常。
當(dāng)然丛晦，在請他人 review 之前奕纫，Technical Writer 也可以先自己 review 一遍，盡量避免低級錯誤烫沙，不浪費他人的時間匹层。
哈哈，問題又來了~通常，剛寫完一篇文章的人是很不情愿再去看自己寫的東西的升筏，此時就可以使用一些語法拼寫檢查的小工具來協(xié)助你了撑柔。
我在之前的一篇文章Technical Writer 日常工作中好用的小工具中有推薦，有需要的小伙伴可以戳鏈接去瞅瞅~
如果你覺得自己足夠細心您访，根本不需要小工具來協(xié)助你铅忿，我佩服你的能力，但還是建議用一下小工具灵汪。因為檀训，你可能也會有狀態(tài)不好的時候，有疲勞打盹的時候享言，有不知道自己寫了一堆什么鬼東西的時候……不要跟自己和小工具過不去峻凫。
6. Delivery 文檔交付
等文檔定稿之后，就可以在平臺上發(fā)布了览露，一般很容易操作荧琼。不同的公司的文檔發(fā)布平臺也會不一樣，Technical Writer 使用的寫作工具也不一樣差牛。
文檔發(fā)布之后命锄，并不代表著結(jié)束。根據(jù)我的工作經(jīng)歷偏化，即便是已經(jīng)發(fā)布的文檔脐恩，也依然有可能存在問題，無論是大公司還是小公司的文檔夹孔。例如：未發(fā)現(xiàn)的文字錯誤被盈、失效的鏈接、與最新的產(chǎn)品已不匹配的描述和步驟等搭伤。Technical Writer 需要及時跟進產(chǎn)品動態(tài)只怎，以便及時更新文檔。
Afterword
寫技術(shù)文檔不是一勞永逸的怜俐，只要產(chǎn)品在更新身堡，就需要 Technical Writer 一直維護下去。
以上分享的是一個完整的技術(shù)文檔從零到有的過程拍鲤。日常工作中贴谎，有時不需要從頭開始，而只是對原有文檔的增刪修改季稳，那就可以省去一些相應(yīng)的環(huán)節(jié)擅这。
如果你也是一枚 Technical Writer，也期待聽到你對技術(shù)寫作流程的見解景鼠，歡迎留言交流哦~
Reference:
Handbook of Technical Writing (10th Edition), by Gerald J. Alred, Charles T. Brusaw, and Walter E. Oliu, Bedford/St. Martin’s
你可能想讀：
Technical Writer 日常工作中好用的小工具
技術(shù)翻譯需要有 Technical Writer 的 sense
深度解析關(guān)于技術(shù)翻譯的六個認知誤區(qū)
如何讓你的內(nèi)容輸出更加專業(yè)更有設(shè)計感仲翎？
書單 | 有哪些技術(shù)傳播從業(yè)者必知必看的書籍？
有哪些適合技術(shù)傳播從業(yè)者關(guān)注的優(yōu)質(zhì)博客？（一）
有哪些適合技術(shù)傳播從業(yè)者關(guān)注的優(yōu)質(zhì)博客溯香？（二）
經(jīng)驗分享 | 來自 11 位 Technical Writer 前輩的職業(yè)發(fā)展建議（上篇）
經(jīng)驗分享 | 來自 11 位 Technical Writer 前輩的職業(yè)發(fā)展建議（下篇）
英語技術(shù)文檔的標(biāo)題到底該大寫還是小寫鲫构？
如何使用正則表達式批量添加和刪除字符？
Markdown：寫技術(shù)文檔玫坛、個人博客和讀書筆記都很好用的輕量級標(biāo)記語言
如何為 Markdown 文件自動生成目錄结笨？
技術(shù)寫作實例解析 | 簡潔即是美
兩分鐘趣味解讀 Technical Writer
若脫離理解，直譯得再正確又有何意湿镀？
優(yōu)質(zhì)譯文不應(yīng)止于正確炕吸，還要 Well-Organized
寫在入職技術(shù)型創(chuàng)業(yè)公司 PingCAP 一個月之后
揭秘 Technical Writer 的工作環(huán)境 | 加入 PingCAP 五個月的員工體驗記
-END-
