前面說的文檔管理體系，是有一整套方法論的。大到文檔體系的架構(到底需要多少篇文檔，分別由誰來負責，寫給誰看)，小到文檔內容的編寫，都有相應的理論和技巧。這些不是靠人海戰術就可以完美完成的。

　　想要寫好一篇文檔，首先第一個問題，就是你要搞清楚這篇文檔的定位——它是一篇什麽性質的文檔?寫作目的是什麽?它的使用者是誰?

　　文檔的定位，直接決定了整篇文檔的基調。

　　例如我經常寫的零基礎入門，定位就是對相關內容背景知識毫無了解的讀者。然而，又不是小學生那種層次，而是至少已經完成了基礎教育，處於大一及以上學歷水平的讀者，有基本的物理學和數學常識，也有對自然現場的基本認知，還有正常人的邏輯思維能力。

　　如果你寫技術文檔，首先要搞明白，文檔使用者是內部客戶還是外部客戶，是有經驗的客戶，還是零基礎的客戶，是已經閱讀過前置文檔的客戶，還是第一次看這套文檔的客戶。

　　明確了對象之後，要切記，在寫作整篇文檔的過程中，你都要隨時切換自身角色。一定要站在讀者的角度，琢磨文檔內容是不是能看得懂。

　　如果沒有把握，那麽，就找個和目標讀者處於同等水平的體驗用戶，讓他試讀，提供反饋意見。

　　大部分技術文檔的作者不是作家，甚至不是文科生，而是技術工程師。這類人在文字表達技巧上通常比較欠缺，但是有一個顯著優勢，那就是邏輯思維能力強。對於寫作來說，這一點非常重要。尤其是技術文檔的寫作，必須有很強的邏輯思維能力。

　　文檔的總體結構，必須要有邏輯連貫的章節順序。文檔的語句，也必須有邏輯嚴謹的表述方式。過於跳躍的思維，不適合應用於技術類文檔。文科生過於感性的文字，也不適合技術類文檔。

　　技術工程師最常犯的毛病，就是自以為是:“這麽簡單，你怎麽都不懂?”“這是基礎啊，是個人都懂！”然後就偷工減料，言簡意賅，跳過了大量的細節，忽視了可能出現的不同情況，讓文檔使用者不知所措。甚至有的作者，喜歡玩“玄學”，覺得越寫得高深，就越顯得自己很懂，簡直可笑。

　　規范的技術文檔，通常會遵循SOP的原則。所謂SOP，就是 Standard Operating Procedure，標準作業程序。

　　具體的操作步驟，雖然簡短，但內容十分清晰，分為幾個步驟，每一個步驟敲什麽命令、有什麽目的，都會告訴你。

　　在最後，還會有驗證結果環節(本例的驗證結果部分相對簡略，實際上還應該包括通過命令，查看結果，以此進行明確驗證)。

　　上面這種SOP的文檔寫作方式，和我們從小接受過的傳統寫作是完全不同的，

　　以前我們常說，中式菜譜喜歡用“鹽少許、醬油少許、大火煎炸片刻”這種定量非常模糊的表達方式，其實確實和我們的寫作習慣有一定關系。對於技術文檔來說，我們這方面的偏重性培養和訓練確實做得不夠。真正的寫作，不是刻意追求辭藻的華麗，而是意思和情境的準確表達。

　　要想寫好技術文檔，還有一個重要技巧，那就是多用圖表。

　　所謂“字不如表、表不如圖”。技術是很抽象的東西，也是理解起來很有難度的東西。想要靠純文字進行內容轉述，是很困難的。所以，應該更多地借助表格和圖片，甚至gif動圖，幫助讀者理解。

　　說白了，這個就是考驗作者的責任心。如果寫作者不能站在讀者的角度，不能以讀者滿意度為出發點，那麽，就不會願意多此一舉去畫圖。畫圖是很複雜的工作，有時候我寫文章，一幅圖都要畫一天，很不容易。

　　技術文檔的寫作，不僅對企業來說非常重要，對於個人來說，也是受益匪淺的。

　　養成並堅持寫作的習慣，有利於培養邏輯思維能力，也有利於個人知識沉澱積累。個人可以開技術blog或公眾號，發表並分享自己的經驗心得，會很有成就感，日積月累的話，甚至可能形成個人品牌和影響力，有利於自己的職業生涯發展。

　　雖然現在視頻化的趨勢明顯，但是我個人認為，文檔是無法被視頻取代的。目前的技術，視頻無法進行快速內容檢索，無法進行快速更新和修改，無法進行快速傳遞，文件體積較大，這些都決定了文檔的不可替代性。

　　視頻的優勢，更多在於內容形象而生動的展示，可以讓用戶有更感性的認識，更深刻的記憶，適合培訓，不適合工作查閱，不適合歸檔。