怎樣寫項目文檔

1、在軟件項目中，文檔既是一項的重要成果，也是項目管理的有力工具。通過文檔，可以穩(wěn)定、明確的傳達信息，實現(xiàn)項目內(nèi)的有效溝通。所以寫文檔對項目經(jīng)理來說，是一項必備的技能。然而很多項目經(jīng)理害怕寫文檔，似乎這是一個很麻煩、很困難的工作。其實會不會寫文檔，只是一種外在的表現(xiàn)，通過一個人寫文檔的情況，可以看出他對工作的理解程度，發(fā)現(xiàn)潛在的問題和風險。一個合格的項目經(jīng)理，不但不會怕寫文檔，而且會覺得這是件簡單、很自然的情，就像一個人吃飯、喝水一樣，何難之有？1.編寫文檔的常見問題每個項目都要寫不少文檔，比如項目實施計劃、系統(tǒng)需求說明書、系統(tǒng)概要設計設計、系統(tǒng)詳細設計、測試計劃 在不少軟件項目中，大部分文檔寫出

2、來只是為了應付檢查或驗收，如果要對這些文檔較真的話，就會發(fā)現(xiàn)它們存在著各種各樣的問題。該有的文檔沒有什么叫該有的文檔？我想有兩點含義：一是合同、招標文件規(guī)定必須提交的文檔；二是項目本身確實需要的文檔。如果僅僅是前者沒有，我一般不會怪項目經(jīng)理，因為事后可以補上。但如果是第二種情況，那就不只是文檔本身的問題了。試想，如果項目執(zhí)行了一半，還沒有項目計劃，顯然就無法就事論事只談論計劃了，這反映了項目經(jīng)理對整個項目的管理具有隨意性，盲目性；如果沒有設 計文檔就完成了大部分編碼工作，那 么代碼的質(zhì)量就得打上一個大大的問號了。項目需要的文檔沒有，要么是項目經(jīng)理的疏忽，要么是寫不出來，這本身也是很危險的信號。

3、如果項目經(jīng)理連必需的文檔都可以疏忽，說明他的工作完全沒有系統(tǒng)性，那他對項目的管理工作怎么值得信任呢？如果是寫不出來，這說明項目經(jīng)理沒有想好怎么做,同樣也是一件很危險的事情。丟三落四，內(nèi)容不完整打開文檔一看，總是有一些你想看的內(nèi)容找不到，或者對關鍵的內(nèi)容輕描淡寫，這多少會讓人覺得有點生氣。項目計劃沒有工作分解，設計文檔沒有系統(tǒng)邏輯結構，項目周報沒有當前進度情況，試運行報告沒有系統(tǒng)運行的統(tǒng)計數(shù)據(jù)出現(xiàn)這樣的狀態(tài)，說 明項目經(jīng)理缺乏經(jīng)驗，對項目沒有總體的認識，更加把握不了工作的重點。照搬模板，徒具形式，內(nèi)容空洞這種文檔還真讓人有點無可奈何。乍一看，文檔格式規(guī)范、內(nèi)容完整，似乎沒什么問題，但心里總覺得少

4、了一些東西，看完了什么也沒記住，仿佛沒看過一樣。簡單的說，就是沒有實質(zhì)性內(nèi)容，缺乏對問題的具體分析，同樣的內(nèi)容，改一下名字，可以給其它項目用。這樣說項目經(jīng)理可能會不服氣：我文檔有幾百頁，怎么會沒內(nèi)容呢？好吧，我們來清理一下，把模板自帶的內(nèi)容去掉、把合同和招標文件中Copy的內(nèi)容去掉、把網(wǎng)上抄的內(nèi)容去掉、把不相關的內(nèi)容去掉、再把不重要內(nèi)容去掉，再來看看究竟還剩下幾頁？這剩 下的內(nèi)容才是真 正有價值的東西。如果這一部分內(nèi)容很少，你文檔越長，就會越像懶婆娘的裹腳布，讓人生厭?？催@樣的文檔，讓人覺得就像吃了蒼蠅一樣難受。有人將這種文檔稱之為“模板僵尸”，真是既準確、又解恨。這種文檔徒具形式，沒有靈魂、

5、沒有精神，就像一具只有骨架、沒有血肉的僵尸。寫出或者接受這種文檔的項目經(jīng)理也很可怕。他有經(jīng)驗，但是沒想法；他知道流程，但不知道變化；他能把握形式，但把握不了內(nèi)在；他明白要做什么，卻永遠也理不清楚工作的內(nèi)容；他寫的內(nèi)容很多，腦中卻幾乎一片空白。他們寫出來的文檔像僵尸，做項目也像被僵尸附身一樣，只能沿著固定的路徑一蹦一跳的前進，哪怕前面有深淵，他也會直接跳下去，因為他壓根就看不到！2.怎樣寫好文檔我見過不少工作十年以上、管過項目五年以上的同事， 對于寫項目文檔仍然是愁眉苦臉、痛苦不堪。難道寫文檔真的有這么難嗎？ 怎樣才能寫出合格的項目文檔呢？最核心的一點，寫你所想的俗話說：“言為心聲”，寫作也是一

6、種“言”，同樣體現(xiàn)了作者的內(nèi)心想法。寫項目文檔，最重要的就是要寫自己的真實想法，展示自己的思路。如果說寫文檔有什么訣竅的話，這就是最重要的訣竅。從哲學上來說，這是知行合一的重要一環(huán)；從寫文檔本身來說，只有這樣才寫得好、寫得快。所以如果有誰說自己不會寫文檔，我們首先應該想到的不是什么技巧問題，而是他真的想好了嗎？體現(xiàn)了知行合一“知行合一”也就是“想”和“做”應當保持一致。知行合一最簡單的方法，就是想了就去做，由想直接到做。在軟件行業(yè)個人英雄主義年代，程序員有好的想法，然后實現(xiàn)它，就有可能成就一段傳奇，例如UCDOS、WPS、RichWin、江民殺毒等都是那個時代的產(chǎn)物。由想直接到做，這對于一個人

7、完成的簡單工作是可以的，但并不適合于由多人協(xié)作完成的復雜任務，因為團隊作戰(zhàn)還有一個關鍵環(huán)節(jié)溝通。溝通有口頭和書面兩種方式，也就是說和寫。想、說、寫、做四者統(tǒng)一，才完整體現(xiàn)了項目中的知行合一。說你所想的，寫你所想的，否則就是言不由衷、表里不一；然后做你所說的，做你所寫的，這叫說到做到、一諾千金。圖想說寫做的統(tǒng)由此可見，寫你所想的，是知行合一的重要體現(xiàn)。寫所想的才能寫得好、寫得快為什么有些人寫文檔寫得很慢 、覺得很痛苦呢？最根本的原因就是因為他沒有想法，或者說沒想好，肚子里沒貨自然拿不出來C比如說，如果你不熟悉Java技術，讓你來寫一個Java系統(tǒng)的設計文檔，你自 然不知從哪里下手，縱使你有莫言一

8、樣的文采和想 象力，也沒有辦法完成。寫你所想的，其實只是把想法 謄到紙上而已，就像把杯子里的水倒出來一樣。有思路的話，當然能寫得快、寫得好。如果沒有想法，千萬不要不懂裝懂，到網(wǎng)上到處復制一些看上去相關的內(nèi)容來填補，因為這會誤導別人，雖然掩蓋了自己的無知，但也掩蓋項目 隱藏的問題和風險。所以對于沒有想清楚的地方，最好的處理方法就是直接寫上“沒想好”三個大字，等想好了再補上。記?。赫f假話的人最辛苦，因為他總是要琢磨該怎樣編故事，怎樣自圓其說。講真話的人最輕松，寫文檔就是要寫自己的真心話。不要拘泥于形式有些人說：“我有想法，就是寫不出來?！边@種情況多半是由于寫作者拘泥于文檔的形式，不知該如何下筆。這

9、樣的話，有一個簡單的方法：先把你的想法說出來，用手機把聲音給錄下來，然后對照錄音來整理文檔。也就是說，我們要像說話一樣寫文檔，說話是很自然的事情，寫文檔也是很自然的事情。如果你沒辦法說清楚，那估計神仙也法辦法了一一除非有誰懂得讀心術。文檔最重要的是內(nèi)容和思想，讓讀者能讀懂你的思路，而不是構思有多精巧，語言有多優(yōu)美。如果總是在琢磨先寫什么，再寫什么，用什么詞，怎么能快得了呢？不拘泥于形式的另一含義是不要有過多形式化的內(nèi)容。有時一篇30頁的文檔，項目背景、建 設目標、參考資料之類就占掉15頁，并且在每一篇中都千篇一律。這些東西不是完全沒用，但過多就會影響對文檔重點的把握，盡可砍掉或簡化。另外不要湊

10、篇幅。項目文檔是用來指導項目實施的，因此把問題寫清楚就可以了，多寫無益。有些人寫文檔時，喜歡問要寫多少頁，其實這根本不應該成為一個問題，如果把想說的都說清楚了，你管它有多少頁呢？文檔結構要具邏輯性在第三章中，曾經(jīng)提到PMBok項目管理理論遵循結構化的思想，即自頂向下、逐層分解。這一規(guī)律同樣可以用來指導文檔的編寫，項目文檔在結構上同樣應該是“結構化”的，自頂向下、逐層分解，形成金字塔形的結構。還記得在學校里老師教我們怎樣寫作文了嗎？要按“總分”或“總分總”的結構來寫，這其實也是結構化方法的體現(xiàn)。結構化方法之所以放之四海而皆準，是因為它符合人對事物的認識規(guī)律。設想我們要研讀一本書，一般我們首先會看

11、書名、作者，再看目錄、前言或簡介，對全書全形成一個總體的印象，這是“總”的過程。然后我們會逐章逐節(jié)的閱讀，一步一步消化全書的內(nèi)容，這是一個“分”的過程。部分讀者在讀完以后，可能還會對全書的內(nèi)容進行再次總結回顧，以進一步加深理解，這又是一個“總”的過程。通過這樣一個“總分總”的過程，我們形成了對事物的深刻理解。所以一本書按照金字塔結構來組織文檔，其實就是為了迎合讀者，降低他們理解的難度，讓他們只需要更少的時間就可以對整個文檔的精要有一個完整準確的理解。作者寫得輕松、讀者讀得開心，真是皆大歡喜。結構化方法不但適用于文檔的整體結構，同樣適用于局部結構，例如文檔的某一節(jié)。只要事物具有一定的復雜度，我們都可以用這種方式將其講得更加透徹。采用結構化方法來編寫文檔還有一個好處，就是可以檢驗思維的嚴謹性。結構化方法的一個重要工作就是對事物進行分解，而分解的過程其實是一個再次深入思考的過程，例如分解的標準是什么，上層結構是否完整的包含了下層結構等，從而發(fā)現(xiàn)被遺漏的問題， 并進行完善。注意排版文檔排版是許多人容易忽視的問題。一份內(nèi)容上乘的文檔，如果用工整悅