一直都沒有寫過正規的技術文檔，正在努力學習中。如何準確有條理並且簡明扼要的描述一件事情還有如何抓住重點，是我要學習的主要內容。
轉一點資料：
總結一下五條原則：
一·不寫想當然的文檔。
二·不寫只是由於格式或者規範要求你寫的文檔，而是寫確實有內容文檔。
三·寫簡明扼要，重點突出，與閱讀者水平相當的文檔。
四·寫明確無無疑義的文檔，且爲此制定標準，並是大家都遵守此標準。
五·寫你或者別人認爲需要的文檔，而不是規範或者標準要求你寫的文檔。
文檔需要反映的是實實在在的問題，而不要建立在想當然的基礎上。
文檔需要規範嗎？需要。需要格式化嗎？需要。但是文檔更需要的是內容，沒有內容的文檔不是垃圾是什麼。所以第二條原則就是寫有內容的文檔，而不是文檔規範和格式要求你寫的文檔。
文檔是幹嗎的，用來收藏的？用來評級的？用來對付人的？如果你都給予肯定的回答，那麼你乾脆就去搞文檔工程，不要來搞軟件工程。文檔最終的目的還是要人去閱讀，要別人通過閱讀理解自己所要傳遞的信息，要自己以後看從前的文檔可以回憶當時的所表達的信息。如果你可以直接把這些信息傳遞給需要傳遞的人，你就沒有必要寫文檔。如果傳遞的信息混亂不明，繁瑣不易閱讀，或者信息量太大，不能很好的理解，那麼你寫的文檔一樣只是垃圾一類的貨色。寫文檔不是寫論文，不需要說理明確，引用準確，關鍵的是要可以傳遞信息。所以第三條原則是寫文檔要簡明扼要，抓住重點，同時考慮閱讀者的水平，不能給小學生寫微積分，也不必給教授解釋爲什麼2的3倍是6。
按照規範和格式寫出來的文檔才最不容易懂，因爲你怎麼能真的知道他要寫的東西是他想寫的東西。寫文檔最重要的是要有寫文檔的標準，而不是格式。比如如果你的需求說明書最後的版本上寫着，A界面反映迅速，這顯然可以符合規範和格式，但是確實是一個有百害無一疑的說明－－當你的客戶爲1.5秒刷新不迅速而不付款的時候，你就明白你的文檔多麼愚蠢而無用。所以文檔的寫作第四條原則，就是寫含義明確無疑義的文檔，並且爲此制定一個標準，同時人所有人都遵守這個標準。
其實寫文檔是一件簡單的不能在簡單的事情。就向我小時候寫作文，冥思苦想左右不得要領，搜腸刮肚只能應付了事。而現在且下筆如飛，瀟瀟灑灑，動不動就千言萬語。原因簡單的不能在簡單，因爲當初寫作爲是不自願的，現在做文章是自覺的；寫作文是別人命題的，寫文章是自己定題的；寫作文是要有什麼主題思想，要有格式，要字跡清除；而寫文章只要你看懂就好，只要告訴了你我要告訴的東西就好。所以第五條原則就是寫你認爲需要的文檔，而不是寫別人要求你寫的文檔。當然這是在說你不應因爲有個什麼規範或者標準要求你去寫一個什麼文檔，你就去寫那麼文檔。而是說如果某些人需要那些文檔來理解一些問題，那麼你就需要寫那些文檔。