怎麼才能寫好技術文檔

有很多人都覺得我文檔寫的好。這不是一兩個人說了。

我記得大概是在創業工作的時候，從寫業績點文檔開始的。那時候，我自己給

做了一套模闆。每次都按照這個格式寫。每次都能得到上司的好評。既把自己

的工作都寫進去了，還弄了個好名聲。

在東信工作的時候，我就是軟體組總體設計，專門寫設計文檔。寫的還算好。

每個人都覺得寫的還算好。

有朋友說讓我介紹介紹經驗。那我就在這裡說說。其實，世上無難事，是怕

有心人啊。要做好一件事情，隻要真心對待總能做好的，下面是關于寫文檔

的一點心得。寫出來，以供探讨。本文主要讨論科技說明文檔。不是寫文章。

寫好文檔，注意點有：

一、思路清晰、章節分布合理

分章節、逐層深入地描述問題。這是寫科技文檔的要旨。看看MSDN和各家

軟體公司的産品文檔就可以知道，無一不是如此。

二、不用口語

科技說明文檔，不用口語。不能出現“你們”、“我們”、“好啊”、

“咋樣啊”、“應該”。。。。。。這些都不能出現。比如，“應該”應

寫成“應”、“需”等書面用語。一些讨論稿可以适量使用口語。

文檔代表公司和技術要點，不是展現個人魅力的地方。一個公司不能使用

五花八門風格的文檔。口語的使用，更是會雪上加霜。

三、形成固定風格

科技文檔不要求風格各異，但求達意簡約。這個和寫文章的方法是格格不入。

可以針對每類事務，形成固定的模闆。所謂有章可循。要把它形成組織積累。

而不是個人行為。這樣能形成整體風格。

四、站在讀者的角度寫

主要涉及到難度、叙述方式等。文檔叙述的難易程度要和讀者比對。否則，

難了看不懂。太簡單了，也沒有意思。這些都沒有起到效果。

五、解決問題是核心

任何文檔寫出來都是要解決問題，那就是幫助讀者熟悉知識點。任何的形式、

風格、注意點都是表面的東西。解決問題是關鍵。

一個寫的再好的文檔，不能姐姐問題，都是白搭。

六、注意積累

積水成淵、積善成德。任何事情都不是與生俱來的。小孩子出生後，如果馬上

就放到野獸的巢穴，也照樣說不了話。寫好文檔也是如此。隻有多寫，認真寫

才能寫好。