眾所周知，做軟件的目的就是要滿足客戶的需求，這個(gè)需求包括功能、外觀、操作、時(shí)間及性能等各方面。那么，在軟件開發(fā)過程中那部分最重要呢，程序員說“毋庸置疑，我編寫的程序?qū)崿F(xiàn)了客戶提出的功能以及業(yè)務(wù)流程，肯定我是最重要的”，美工說“你開發(fā)的功能如果沒有我的頁面美化，是無法呈現(xiàn)給客戶的，要知道，很多客戶并不很了解內(nèi)部復(fù)雜的功能，首先映入眼簾的就是界面的效果，就像人一樣，如果你不是美女，那么他看了你一眼之后，就沒有想和你再繼續(xù)溝通和發(fā)展的積極性了”，測試聽了不高興了，說“漏洞百出的產(chǎn)品，哪怕你外觀再漂亮，實(shí)現(xiàn)的功能再多，也是不成熟的產(chǎn)品，客戶是不會(huì)使用的?！北娬f紛紜，各執(zhí)一詞。

以上所說都很有道理，每個(gè)角色都是軟件成功必不可少的，每個(gè)人都好比是一塊積木，只有組合起來才能搭成既美觀又穩(wěn)固的造型。

另一方面，他們卻又都不是最重要的。舉個(gè)例子，現(xiàn)在我家在進(jìn)行裝修，木工、瓦工、油漆工都是南方的工人，有很好的手藝，干活也很細(xì)致，可是他們在施工的時(shí)候都要參考兩份文件，一是房屋結(jié)構(gòu)圖，二是裝修效果圖。沒有此文件，他們就無從下手，就是擁有再好的手藝，做出來的再漂亮，到時(shí)候也會(huì)與房屋的實(shí)際效果存在偏差。

孫悟空三大白骨精，相信誰都耳熟能詳。里面有這樣一個(gè)場景，孫悟空去化齋前，劃了一個(gè)圈，將唐僧他們包在里面，只要他們在圈里面，就不會(huì)有事，如果出了圈就很危險(xiǎn)。這個(gè)圈，就是一個(gè)范圍、一個(gè)標(biāo)準(zhǔn)。在這個(gè)圈里，你隨便折騰，怎么折騰都行，但千萬不要越界，否則后果不堪設(shè)想。

而在軟件開發(fā)中文檔就是那個(gè)圈，它將項(xiàng)目開發(fā)所進(jìn)行的一切活動(dòng)都進(jìn)行詳細(xì)的定義，只要遵照這個(gè)文檔去開發(fā)，那么最終的結(jié)果一定是八九不離十。

文檔貫穿軟件工程的始終，從前期的項(xiàng)目準(zhǔn)備，中期的開發(fā)到后期的維護(hù)、培訓(xùn)，無不以文檔作為工作的依據(jù)。那么在軟件項(xiàng)目中，都包括哪些文檔呢，它們的作用又是什么呢，下面我將我的經(jīng)驗(yàn)分享給大家。

《可行性研究報(bào)告》：這是客戶在進(jìn)行項(xiàng)目調(diào)研階段所編寫的，具有兩重意義，其一，指明項(xiàng)目的必要性和緊迫性，并從業(yè)務(wù)角度闡述大概的功能需求，注意，只是大概，可能與最后的結(jié)果有很大出入；其二，最重要的一點(diǎn)就是為了要錢，向財(cái)政部要錢，將最終實(shí)現(xiàn)的功能寫得天花亂墜，包括決策支持、全文檢索、商業(yè)智能、遠(yuǎn)程報(bào)表等，但最后開發(fā)的可能僅僅是融合簡單業(yè)務(wù)流程的信息輸入和輸出而已，但這已無關(guān)緊要，最重要的是我要到了錢。但是嚴(yán)格來說，這不是項(xiàng)目組所需的文檔，于軟件開發(fā)也意義不大。

《建設(shè)方案》：或者是《實(shí)施方案》，當(dāng)客戶從財(cái)政部申請到資金后，就要著手進(jìn)行詳細(xì)的調(diào)研和分析了，這里有兩種情況，其一，客戶自己從各個(gè)產(chǎn)品廠家進(jìn)行相關(guān)的調(diào)研，進(jìn)行匯總后，編寫方案，這樣，聰明、細(xì)心的軟件公司就會(huì)從方案的技術(shù)環(huán)節(jié)，挖掘出客戶所選擇的產(chǎn)品，最后和這個(gè)產(chǎn)品公司合作來中標(biāo)；其二，讓和其關(guān)系很好的一家或兩家軟件公司（不會(huì)超過三家）編寫，客戶進(jìn)行審核，客戶最后選擇了誰的方案那么最后這個(gè)項(xiàng)目就是這家公司的，這樣很多情況并不是公開招標(biāo)。

《招標(biāo)書》：將《建設(shè)方案》或《實(shí)施方案》進(jìn)行摘取，并附帶上技術(shù)問題以及招標(biāo)時(shí)的細(xì)節(jié)、注意事項(xiàng)，構(gòu)成《招標(biāo)書》，這個(gè)文件也是由客戶寫得，軟件公司在投標(biāo)前需要購買《招標(biāo)書》。

《投標(biāo)書》：與《招標(biāo)書》所呼應(yīng)，對技術(shù)問題進(jìn)行相應(yīng)的技術(shù)應(yīng)答，包括技術(shù)標(biāo)和商務(wù)標(biāo)兩部分。

上面幾份文檔，是項(xiàng)目前期準(zhǔn)備時(shí)需要的，是側(cè)重于售前方面的；而下面的文檔是軟件開發(fā)過程中必不可少的，我們按開發(fā)工作的時(shí)間順序一一介紹。

《需求分析說明書》：對于軟件開發(fā)來說，《需求分析說明書》就好像是蓋樓時(shí)所用的圖紙，是最重要的文檔，由項(xiàng)目經(jīng)理對客戶相關(guān)部門進(jìn)行業(yè)務(wù)調(diào)研后編寫，語言側(cè)重于從業(yè)務(wù)的角度描述功能需求。內(nèi)容涉及三大部分，其一，編寫目的、背景、目標(biāo)任務(wù)等公共性語言；其二，功能性需求，將業(yè)務(wù)梳理成幾大功能模塊，一級功能下細(xì)分二級功能，依次類推，將最終細(xì)化的功能按描述、輸入、處理和輸出進(jìn)行詳細(xì)描述；其三，非功能性需求，包括性能、處理能力、進(jìn)度、界面設(shè)計(jì)和運(yùn)行環(huán)境的規(guī)定。

《數(shù)據(jù)庫設(shè)計(jì)說明書》：我是做數(shù)據(jù)庫出身，因此這部分的工作也是由我這個(gè)項(xiàng)目經(jīng)理來做，根據(jù)《需求分析說明書》在Erwin建模工具中設(shè)計(jì)好邏輯模型和物理模型，然后將其整理到此文檔中，文檔還包含數(shù)據(jù)庫所有的表結(jié)構(gòu)和相關(guān)的字段說明。

《概要設(shè)計(jì)說明書》：說實(shí)話，在我做過的項(xiàng)目中，沒有編寫過此文檔，因?yàn)槲矣X得《需求分析說明書》和《詳細(xì)設(shè)計(jì)說明書》就足矣了。甚至如果項(xiàng)目簡單或時(shí)間緊急，《詳細(xì)設(shè)計(jì)說明書》都會(huì)省略：）。

《詳細(xì)設(shè)計(jì)說明書》：主要包含兩部分內(nèi)容，其一，體系結(jié)構(gòu)的設(shè)計(jì)，也就是項(xiàng)目所采用的幾層架構(gòu)，以及層與層之間的通信機(jī)制，還有就是基礎(chǔ)框架所采用的技術(shù)；其二，是本文檔的核心部分，包括每個(gè)細(xì)分模塊的詳細(xì)設(shè)計(jì)說明，包括程序描述、功能、性能、輸入項(xiàng)、輸出項(xiàng)、算法、流程邏輯、接口、存儲(chǔ)分配、注釋設(shè)計(jì)、限制條件、測試計(jì)劃和尚未解決的問題等內(nèi)容。本說明書對項(xiàng)目所采用的技術(shù)和接口都做了詳細(xì)的規(guī)定，是指導(dǎo)程序員開發(fā)的直接工具。但需要說明的是，很多項(xiàng)目由于時(shí)間原因，都忽略了此說明書的編寫，包括本人目前在做的項(xiàng)目也是如此，因此本文檔并不是必須的。但如果作為給客戶的交付物，需要在項(xiàng)目完成后補(bǔ)全。

《計(jì)劃進(jìn)度》：這個(gè)不用多說，由項(xiàng)目經(jīng)理編寫，實(shí)現(xiàn)對項(xiàng)目進(jìn)度的嚴(yán)格把控，是項(xiàng)目必須的文檔，可用project編寫。

《測試用例》：測試用例（Test Case）目前沒有經(jīng)典的定義。比較通常的說法是：指對一項(xiàng)特定的軟件產(chǎn)品進(jìn)行測試任務(wù)的描述，體現(xiàn)測試方案、方法、技術(shù)和策略。內(nèi)容包括測試目標(biāo)、測試環(huán)境、輸入數(shù)據(jù)、測試步驟、預(yù)期結(jié)果、測試腳本等，并形成文檔。它是將軟件測試的行為活動(dòng)做一個(gè)科學(xué)化的組織歸納．目的是能夠?qū)④浖y試的行為轉(zhuǎn)化成可管理的模式；同時(shí)測試用例也是將測試具體量化的方法之一。由此可見，《測試用例》非常重要，是對項(xiàng)目或產(chǎn)品質(zhì)量的嚴(yán)格保證，但由于測試人員和項(xiàng)目組的規(guī)范性、時(shí)間進(jìn)度等限制，本文檔在本地區(qū)的實(shí)際項(xiàng)目中也很少應(yīng)用，至少我認(rèn)識的很多測試人員中，只有極少數(shù)的項(xiàng)目中會(huì)編寫此文檔。

《測試結(jié)果》：在項(xiàng)目開發(fā)階段使用，也就是交付客戶之前。文檔為Excel格式，并提供關(guān)鍵字段的數(shù)據(jù)篩選，內(nèi)容包括描述、缺陷類型（Bug、需求）、開發(fā)人員、狀態(tài)、關(guān)閉時(shí)間、所屬模塊、提交人、解決人、備注等。其中狀態(tài)包含提交、解決和確認(rèn)解決，測試人員將問題提交（紅色），當(dāng)程序員解決后就置為解決（黃色），測試人員再次確認(rèn)無誤后，就修改狀態(tài)為確認(rèn)解決（綠色），并且添寫關(guān)閉時(shí)間。

《需求變更文檔》：產(chǎn)品交付客戶之后使用。任何一個(gè)好軟件，不是在第一個(gè)版本就把這些標(biāo)準(zhǔn)全部實(shí)現(xiàn)，而是有步驟有重點(diǎn)地實(shí)現(xiàn)，逐步成為一個(gè)好軟件。因此《需求變更文檔》是不必可少的，同樣作個(gè)Excel表格，量化解決。包括下列幾項(xiàng)：客戶名稱、需求提出人、提出日期、需求關(guān)閉時(shí)間，功能模塊名，客戶現(xiàn)在版本號，需求描述，需求分類（需求、Bug）等。每次發(fā)布新版本都把從上一版本發(fā)布之日關(guān)閉的需求列表都單獨(dú)摘成一個(gè)文件，附帶到這次新發(fā)布的版本之后。

此舉有兩個(gè)好處，其一，能夠清楚的列出客戶以往所提的需求，因?yàn)橛幸恍┛蛻籼岢龅母膭?dòng)總是反反復(fù)復(fù)，一個(gè)問題一會(huì)要改成A,然后覺得不好要改成B，之后覺得還不如A好，便又要求改回去，這樣給公司的進(jìn)度和安排帶來很大的不便，如果因?yàn)檫@個(gè)耽誤了其他的工作，便可以有此根據(jù)和客戶進(jìn)行溝通，防止客戶賴賬；其二，可以評判技術(shù)支持和相關(guān)程序員的工作量。此文檔為EXCEL格式，但最好還有一個(gè)word類型的文檔，每次客戶提出修改意見時(shí)，將此文檔打印出來交由客戶簽字，作為憑證，此方法實(shí)際中并不是次次可行，一些強(qiáng)權(quán)客戶或不敢承擔(dān)責(zé)任的就不簽字，那也沒轍。

《測試結(jié)果》和《需求變更文檔》要定期（可一周或一個(gè)月）給老板一份。這表明了你的工作量，讓他看看你確實(shí)一直很辛苦地在工作，另外，也能看出你的認(rèn)真負(fù)責(zé)態(tài)度。

《用戶使用手冊》：按標(biāo)準(zhǔn)說，應(yīng)該由文案寫，但在大多數(shù)的軟件公司中都不設(shè)這個(gè)職位，因此要么由項(xiàng)目經(jīng)理寫要么由測試人員寫，關(guān)鍵看是誰給客戶做培訓(xùn)。在目前我做的這個(gè)項(xiàng)目中，并沒有專職測試，所以這個(gè)工作還是項(xiàng)目經(jīng)理來做?！队脩羰褂檬謨浴房筛鶕?jù)實(shí)際情況寫成三種版本，其一，chm類型文件，適用于C/S的項(xiàng)目，就像微軟的產(chǎn)品中，都會(huì)有此幫助手冊；其二，做成網(wǎng)頁形式的幫助文件，適用于B/S項(xiàng)目；其三，就是做成word文檔，雖然可保存至本地，但使用起來沒有前二者方便。

余者還有《開發(fā)任務(wù)書》、《項(xiàng)目總結(jié)報(bào)告》、《軟件驗(yàn)收評審》等，并不是必須的，可根據(jù)客戶需要和實(shí)際的項(xiàng)目來選擇使用，再次并不一一贅述。

并且，以上所有文檔，雖然有些是必須的，比如《需求分析說明書》、《測試結(jié)果》、《用戶使用手冊》等，但根據(jù)不同的行業(yè)、不同的地區(qū)以及不同的項(xiàng)目和團(tuán)隊(duì)規(guī)模，文檔的具體內(nèi)容都會(huì)有所不同，不必較真。只要能抓到老鼠，白貓黑貓都是好貓，況且，沒必要的多余的文檔會(huì)浪費(fèi)時(shí)間和成本等資源。