在軟件項(xiàng)目中，文檔既是一項(xiàng)的重要成果，也是項(xiàng)目管 理的有力工具。通過(guò)文檔，可以穩(wěn)定、明確的傳達(dá)信息，實(shí)現(xiàn)項(xiàng)目?jī)?nèi)的有效溝通。所以寫文檔對(duì)項(xiàng)目經(jīng)理來(lái)說(shuō)，是一項(xiàng)必備的技能。

然而很多項(xiàng)目經(jīng)理害怕寫文檔，似乎這是一個(gè)很麻煩、 很困難的工作。其實(shí)會(huì)不會(huì)寫文檔，只是一種外在的表現(xiàn)，通過(guò)一個(gè)人寫文檔的情況，可以看出他對(duì)工作的理解程度，發(fā)現(xiàn)潛在的問(wèn)題和風(fēng)險(xiǎn)。一個(gè)合格的項(xiàng)目經(jīng) 理，不但不會(huì)怕寫文檔， 而且會(huì)覺(jué)得這是一件簡(jiǎn)單、很自然的情，就像一個(gè)人吃飯、喝水一樣，何難之有？

1.編寫文檔的常見問(wèn)題

每個(gè)項(xiàng)目都要寫不少文檔，比如項(xiàng)目實(shí)施計(jì)劃、系統(tǒng)需 求說(shuō)明書、系統(tǒng)概要設(shè)計(jì)設(shè)計(jì)、系統(tǒng)詳細(xì)設(shè)計(jì)、測(cè)試計(jì)劃……在不少軟件項(xiàng)目中，大部分文檔寫出來(lái)只是為了應(yīng)付檢查或驗(yàn)收，如果要對(duì)這些文檔較真的話，就會(huì)發(fā)現(xiàn)它們存在著各種各樣的問(wèn)題。

該 有的文檔沒(méi)有

什么叫該有的文檔？我想有兩點(diǎn)含義：一是合同、招標(biāo) 文件規(guī)定必須提交的文檔；二是項(xiàng)目本身確實(shí)需要的文檔。如果僅僅是前者沒(méi)有，我一般不會(huì)怪項(xiàng)目經(jīng)理，因?yàn)槭潞罂梢匝a(bǔ)上。但如果是第二種情況，那就不只是文 檔本身的問(wèn)題了。試想 ，如果項(xiàng)目執(zhí)行了一半，還沒(méi)有項(xiàng)目計(jì)劃，顯然就無(wú)法就事論事只談?wù)撚?jì)劃了，這反映了項(xiàng)目經(jīng)理對(duì)整個(gè)項(xiàng)目的管理具有隨意性，盲目性；如果沒(méi)有設(shè)計(jì)文檔就完成 了大部分編碼工作，那 么代碼的質(zhì)量就得打上一個(gè)大大的問(wèn)號(hào)了。

項(xiàng)目需要的文檔沒(méi)有，要么是項(xiàng)目經(jīng)理的疏忽，要么是 寫不出來(lái)，這本身也是很危險(xiǎn)的信號(hào)。如果項(xiàng)目經(jīng)理連必需的文檔都可以疏忽，說(shuō)明他的工作完全沒(méi)有系統(tǒng)性，那他對(duì)項(xiàng)目的管理工作怎么值得信任呢？如果是寫不 出來(lái)，這說(shuō)明項(xiàng)目經(jīng)理 沒(méi)有想好怎么做，同樣也是一件很危險(xiǎn)的事情。

丟三落四，內(nèi)容不完整

打開文檔一看，總是有一些你想看的內(nèi)容找不到，或者 對(duì)關(guān)鍵的內(nèi)容輕描淡寫，這多少會(huì)讓人覺(jué)得有點(diǎn)生氣。項(xiàng)目計(jì)劃沒(méi)有工作分解，設(shè)計(jì)文檔沒(méi)有系統(tǒng)邏輯結(jié)構(gòu)，項(xiàng)目周報(bào)沒(méi)有當(dāng)前進(jìn)度情況，試運(yùn)行報(bào)告沒(méi)有系統(tǒng)運(yùn)行 的統(tǒng)計(jì)數(shù)據(jù) ……出現(xiàn)這樣的狀態(tài)，說(shuō) 明項(xiàng)目經(jīng)理缺乏經(jīng)驗(yàn)，對(duì)項(xiàng)目沒(méi)有總體的認(rèn)識(shí)，更加把握不了工作的重點(diǎn)。

照搬模板，徒具形式，內(nèi)容空洞

這種文檔還真讓人有點(diǎn)無(wú)可奈何。乍一看，文檔格式規(guī) 范、內(nèi)容完整，似乎沒(méi)什么問(wèn)題，但心里總覺(jué)得少了一些東西，看完了什么也沒(méi)記住，仿佛沒(méi)看過(guò)一樣。簡(jiǎn)單的說(shuō)，就是沒(méi)有實(shí)質(zhì)性內(nèi)容，缺乏對(duì)問(wèn)題的具體分析，同樣的內(nèi)容，改一下名 字，可以給其它項(xiàng)目用。

這樣說(shuō)項(xiàng)目經(jīng)理可能會(huì)不服氣：我文檔有幾百頁(yè)，怎么 會(huì)沒(méi)內(nèi)容呢？好吧，我們來(lái)清理一下，把模板自帶的內(nèi)容去掉、把合同和招標(biāo)文件中Copy的內(nèi)容去掉、把網(wǎng)上抄的內(nèi)容去掉、把不相關(guān)的內(nèi)容去掉、再把不重要 內(nèi)容去掉，再來(lái)看看究竟還剩下幾頁(yè)？這剩下的內(nèi)容才是真 正有價(jià)值的東西。如果這一部分內(nèi)容很少，你文檔越長(zhǎng)，就會(huì)越像懶婆娘的裹腳布，讓人生厭。

看這樣的文檔，讓人覺(jué)得就像吃了蒼蠅一樣難受。有人 將這種文檔稱之為“模板僵尸”，真是既準(zhǔn)確、又解恨。這種文檔徒具形式，沒(méi)有靈魂、沒(méi)有精神，就像一具只有骨架、沒(méi)有血肉的僵尸。

寫出或者接受這種文檔的項(xiàng)目經(jīng)理也很可怕。 他有經(jīng)驗(yàn)，但是沒(méi)想法；他知道流程，但不知道變化；他能把握形式，但把握不了內(nèi)在；他明白要做什么，卻永遠(yuǎn)也理不清楚工作的內(nèi)容；他寫的內(nèi) 容很多，腦中卻幾乎一片空白。他們寫出來(lái)的文檔像僵尸，做項(xiàng)目也像被僵尸附身一樣，只能沿著固定的路徑一蹦一跳的前進(jìn)，哪怕前面有深淵，他也會(huì)直接跳下去，因 為他壓根就看不到！

2.怎樣寫好文檔

我見過(guò)不少工作十年以上、管過(guò)項(xiàng)目五年以上的同事， 對(duì)于寫項(xiàng)目文檔仍然是愁眉苦臉、痛苦不堪。難道寫文檔真的有這么難嗎？怎樣才能寫出合格的項(xiàng)目文檔呢？

最核心的一點(diǎn)，寫你所想的

俗話說(shuō)：“言為心聲”，寫作也是一種 “言”，同樣體現(xiàn)了作者的內(nèi)心想法。寫項(xiàng)目文檔，最重要的就是要寫自己的真實(shí)想法，展示自己的思路。如果說(shuō)寫文檔有什么訣竅的話，這就是最重要的訣竅。從 哲學(xué)上來(lái)說(shuō) ，這是知行合一的重要一環(huán)；從寫文檔本身來(lái)說(shuō)，只有這樣才寫得好、寫得快。所以如果有誰(shuí)說(shuō)自己不會(huì)寫文檔，我們首先應(yīng)該想到的不是什么技巧問(wèn)題，而是他真 的想好了嗎？

體現(xiàn)了知行合一

“知行合一”也就是“想”和 “做”應(yīng)當(dāng)保持一致。知行合一最簡(jiǎn)單的方法，就是想了就去做，由想直接到做。在軟件行業(yè)個(gè)人英雄主義年代，程序員有好的想法，然后實(shí)現(xiàn)它，就有可能成就一 段傳奇，例 如UCDOS、WPS、RichWin、江民殺毒等都是那個(gè)時(shí)代的產(chǎn)物。由想直接到做，這對(duì)于一個(gè)人完成的 簡(jiǎn)單工作是可以的，但并不適合于由多人協(xié)作完成的復(fù)雜任務(wù)，因?yàn)閳F(tuán)隊(duì)作戰(zhàn)還有一個(gè)關(guān)鍵環(huán)節(jié)——溝通。

溝通有口頭和書面兩種方式，也就是說(shuō)和寫。想、說(shuō)、 寫、做四者統(tǒng)一，才完整體現(xiàn)了項(xiàng)目中的知行合一。說(shuō)你所想的，寫你所想的，否則就是言不由衷、表里不一；然后做你所說(shuō)的，做你所寫的，這叫說(shuō)到做到、一諾千金。

圖 想說(shuō)寫做的統(tǒng)一

由此可見，寫你所想的，是知行合一的重要體現(xiàn)。

寫所想的才能寫得好、 寫得快

為什么有些人寫文檔寫得很慢 、覺(jué)得很痛苦呢？最根本的原因就是因?yàn)樗麤](méi)有想法，或者說(shuō)沒(méi)想好，肚子里沒(méi)貨自然拿不出來(lái)。比 如說(shuō)，如果你不熟悉Java技術(shù)，讓你 來(lái)寫一個(gè)Java系統(tǒng)的設(shè)計(jì)文檔，你自 然不知從哪里下手，縱使你有莫言一樣的文采和想象力，也沒(méi)有辦法完成。

寫你所想的，其實(shí)只是把想法 謄到紙上而已，就像把杯子里的水倒出來(lái)一樣。有思路的話，當(dāng)然能寫得快、寫得好。如果沒(méi)有想法 ，千萬(wàn)不要不懂裝懂，到網(wǎng)上到處復(fù)制一些看上去相關(guān)的內(nèi)容來(lái)填補(bǔ)，因?yàn)檫@會(huì)誤導(dǎo)別人，雖然掩蓋了自己的無(wú)知，但也掩蓋項(xiàng)目隱藏的問(wèn)題和風(fēng)險(xiǎn)。所以對(duì)于沒(méi)有 想清楚的地方，***的 處理方法就是直接寫上“沒(méi)想好”三個(gè)大字，等想好了再補(bǔ)上。記住：說(shuō)假話的人最辛苦，因?yàn)樗偸且聊ピ撛鯓泳幑适拢鯓幼詧A其說(shuō)。講真話的人最輕松，寫 文檔就是要 寫自己的真心話。

不要拘泥于形式

有些人說(shuō)：“我有想法，就是寫不出來(lái)。” 這種情況多半是由于寫作者拘泥于文檔的形式，不知該如何下筆。這樣的話，有一個(gè)簡(jiǎn)單的方法：先把你的想法說(shuō)出來(lái)，用手機(jī)把聲音給錄下來(lái)，然后對(duì)照錄音來(lái)整 理文檔。也就是說(shuō)，我 們要像說(shuō)話一樣寫文檔，說(shuō)話是很自然的事情，寫文檔也是很自然的事情。如果你沒(méi)辦法說(shuō)清楚，那估計(jì)神仙也法辦法了——除非有誰(shuí)懂得讀心術(shù)。

文檔最重要的是內(nèi)容和思想，讓讀者能讀懂你的思路， 而不是構(gòu)思有多精巧，語(yǔ)言有多優(yōu)美。如果總是在琢磨先寫什么，再寫什么，用什么詞，怎么能快得了呢？

不拘泥于形式的另一含義是不要有過(guò)多形式化的內(nèi)容。 有時(shí)一篇30頁(yè)的文檔，項(xiàng)目背景、建 設(shè)目標(biāo)、參考資料之類就占掉15頁(yè)， 并且在每一篇中都千篇一律。這些東西不是完全沒(méi)用，但過(guò)多就會(huì)影響對(duì)文檔重點(diǎn)的把握，盡可砍掉或簡(jiǎn)化。

另外不要湊篇幅。項(xiàng)目文檔是用來(lái)指導(dǎo)項(xiàng)目實(shí)施的，因 此把問(wèn)題寫清楚就可以了，多寫無(wú)益。有些人寫文檔時(shí)，喜歡問(wèn)要寫多少頁(yè)，其實(shí)這根本不應(yīng)該成為一個(gè)問(wèn)題，如果把想說(shuō)的都說(shuō)清楚了，你管它有多少頁(yè)呢 ？

文 檔結(jié)構(gòu)要具邏輯性

在第三章中，曾經(jīng)提到PMBok項(xiàng)目管理理論遵循結(jié)構(gòu)化的思想，即自頂向下、逐層分解。 這一規(guī)律同樣可以用來(lái)指導(dǎo)文檔的編寫，項(xiàng)目文檔在結(jié)構(gòu)上同樣應(yīng)該是“結(jié)構(gòu)化”的，自頂向下、逐層分解，形成金字塔形的結(jié)構(gòu)。

還記得在學(xué)校里老師教我們?cè)鯓訉懽魑牧藛?？要?“總分”或“總分總”的結(jié)構(gòu)來(lái)寫，這其實(shí)也是結(jié)構(gòu)化方法的體現(xiàn)。結(jié)構(gòu)化方法之所以放之四海而皆準(zhǔn)，是因?yàn)樗先藢?duì)事物的認(rèn)識(shí)規(guī)律。

設(shè)想我們要研讀一本書，一般我們首先會(huì)看書名、作者 ，再看目錄、前言或簡(jiǎn)介，對(duì)全書全形成一個(gè)總體的印象，這是“總”的過(guò)程。然后我們會(huì)逐章逐節(jié)的閱讀，一步一步消化全書的內(nèi)容，這是一個(gè)“分”的過(guò)程。部 分讀者在讀完以后，可能還會(huì)對(duì)全書的內(nèi)容進(jìn)行再次總結(jié)回顧，以進(jìn)一步加深理解，這又是一個(gè)“總”的過(guò)程。通過(guò)這樣一個(gè)“總分總”的過(guò)程，我們形成了對(duì)事物 的深刻理解。

所以一本書按照金字塔結(jié)構(gòu)來(lái)組織文檔，其實(shí)就是為了 迎合讀者，降低他們理解的難度，讓他們只需要更少的時(shí)間就可以對(duì)整個(gè)文檔的精要有一個(gè)完整準(zhǔn)確的理解。作者寫得輕松、讀者讀得開心，真是皆大歡喜。

結(jié)構(gòu)化方法不但適用于文檔的整體結(jié)構(gòu)，同樣適用于局 部結(jié)構(gòu)，例如文檔的某一節(jié)。只要事物具有一定的復(fù)雜度，我們都可以用這種方式將其講得更加透徹。

采用結(jié)構(gòu)化方法來(lái)編寫文檔還有一個(gè)好處，就是可以檢 驗(yàn)思維的嚴(yán)謹(jǐn)性。結(jié)構(gòu)化方法的一個(gè)重要工作就是對(duì)事物進(jìn)行分解，而分解的過(guò)程其實(shí)是一個(gè)再次深入思考的過(guò)程，例如分解的標(biāo)準(zhǔn)是什么，上層結(jié)構(gòu)是否完整的包含了下層結(jié)構(gòu)等，從而 發(fā)現(xiàn)被遺漏的問(wèn)題，并進(jìn)行完善。

注意排版

文檔排版是許多人容易忽視的問(wèn)題。一份內(nèi)容上乘的文 檔，如果用工整悅目的排版來(lái)展現(xiàn)，那就是錦上添花了，反之就有損文檔作者的形象。這就好比一個(gè)人心靈美固然重要，但如果穿著邋遢，面目可憎，也不大可能會(huì)受到別人的歡迎。

排版并非難事，只需要投入很小工作量，就可以為文檔 獲得一定的加分，這就是排版的價(jià)值。事實(shí)上，排版還是對(duì)讀者尊重的表現(xiàn)。作者多花一點(diǎn)點(diǎn)精力，就可以讓讀者擁有更好的閱讀心情，更快的閱讀速度，實(shí)在是一種設(shè)身處地為他人著想 的美德。

原文鏈接：