本篇文章給大家談?wù)勡浖_發(fā)詳細(xì)設(shè)計(jì)文檔，以及軟件開發(fā)詳細(xì)設(shè)計(jì)文檔自動(dòng)生成工具對(duì)應(yīng)的知識(shí)點(diǎn)，希望對(duì)各位有所幫助，不要忘了收藏本站喔。

本文目錄一覽：

• 1、軟件開發(fā)文檔的分類
• 2、軟件開發(fā)中詳細(xì)設(shè)計(jì)文檔現(xiàn)在是必須的么？如果不是用什么取代？
• 3、軟件開發(fā)需要編寫哪些文檔？

軟件開發(fā)文檔的分類

1. 《功能要求》 -- 來源于客戶要求和市場(chǎng)調(diào)查，是軟件開發(fā)中最早期的一個(gè)環(huán)節(jié)?？蛻籼岢鲆粋€(gè)模糊的功能概念，或者要求解決一個(gè)實(shí)際問題，或者參照同類軟件的一個(gè)功能。有軟件經(jīng)驗(yàn)的客戶還會(huì)提供比較詳細(xì)的技術(shù)規(guī)范書，把他們的要求全部列表書寫在文檔中，必要時(shí)加以圖表解說。這份文檔是需求分析的基礎(chǔ)。

2. 《投標(biāo)方案》 -- 根據(jù)用戶的功能要求，經(jīng)過與招標(biāo)方溝通和確認(rèn)，技術(shù)人員開始書寫《投標(biāo)方案》，方案書一般包括以下幾個(gè)重要的章節(jié)： 前言 -- 項(xiàng)目背景、公司背景和業(yè)務(wù)、技術(shù)人員結(jié)構(gòu)、公司的成功案例介紹等。 需求分析 -- 項(xiàng)目要求、軟件結(jié)構(gòu)、功能列表、功能描述、注意事項(xiàng)等。 技術(shù)方案 -- 總體要求和指導(dǎo)思想、技術(shù)解決方案、軟件開發(fā)平臺(tái)、網(wǎng)絡(luò)結(jié)構(gòu)體系等。 項(xiàng)目管理 -- 描述公司的軟件開發(fā)流程、工程實(shí)施服務(wù)、組織和人員分工、開發(fā)進(jìn)度控制、軟件質(zhì)量保證、項(xiàng)目驗(yàn)收和人員培訓(xùn)、軟件資料文檔等。 技術(shù)支持 -- 公司的技術(shù)支持和服務(wù)介紹、服務(wù)宗旨和目標(biāo)、服務(wù)級(jí)別和響應(yīng)時(shí)間、技術(shù)服務(wù)區(qū)域、技術(shù)服務(wù)期限、授權(quán)用戶聯(lián)系人等。 系統(tǒng)報(bào)價(jià) -- 軟、硬件平臺(tái)報(bào)價(jià)列表、軟件開發(fā)費(fèi)用、系統(tǒng)維護(hù)費(fèi)用等。 項(xiàng)目進(jìn)度 -- 整個(gè)項(xiàng)目的進(jìn)度計(jì)劃，包括簽署合同、項(xiàng)目啟動(dòng)、需求分析、系統(tǒng)分析、程序開發(fā)、測(cè)試維護(hù)、系統(tǒng)集成、用戶驗(yàn)收、用戶培訓(xùn)等步驟的時(shí)間規(guī)劃。

3. 《需求分析》 -- 包括產(chǎn)品概述、主要概念、操作流程、功能列表和解說、注意事項(xiàng)、系統(tǒng)環(huán)境等。以《功能要求》為基礎(chǔ)，進(jìn)行詳細(xì)的功能分析 ( 包括客戶提出的要求和根據(jù)開發(fā)經(jīng)驗(yàn)建議的功能 ) ，列出本產(chǎn)品是什么，有什么特殊的概念，包括哪些功能分類，需要具備什么功能，該功能的操作如何，實(shí)現(xiàn)的時(shí)候該注意什么細(xì)節(jié)，客戶有什么要求，系統(tǒng)運(yùn)行環(huán)境的要求等。這里的功能描述跟以后的使用手冊(cè)是一致的。

4. 《技術(shù)分析》 -- 包括技術(shù)選型、技術(shù)比較、開發(fā)人員、關(guān)鍵技術(shù)問題的解決、技術(shù)風(fēng)險(xiǎn)、技術(shù)升級(jí)方向、技術(shù)方案評(píng)價(jià)，競(jìng)爭(zhēng)對(duì)手技術(shù)分析等。以《需求分析》為基礎(chǔ)，進(jìn)行詳細(xì)的技術(shù)分析 ( 產(chǎn)品的性能和實(shí)現(xiàn)方法 ) ，列出本項(xiàng)目需要使用什么技術(shù)方案，為什么，有哪些技術(shù)問題要解決 ，估計(jì)開發(fā)期間會(huì)碰到什么困難，技術(shù)方案以后如何升級(jí)，對(duì)本項(xiàng)目的技術(shù)有什么評(píng)價(jià)等。

5. 《系統(tǒng)分析》 -- 包括功能實(shí)現(xiàn)、模塊組成、功能流程圖、函數(shù)接口、數(shù)據(jù)字典、軟件開發(fā)需要考慮的各種問題等。以《需求分析》為基礎(chǔ)，進(jìn)行詳細(xì)的系統(tǒng)分析 ( 產(chǎn)品的開發(fā)和實(shí)現(xiàn)方法 ) ，估計(jì)開發(fā)期間需要把什么問題說明白，程序員根據(jù)《系統(tǒng)分析》，開始在項(xiàng)目主管的帶領(lǐng)下進(jìn)行編碼。

6. 《數(shù)據(jù)庫(kù)文檔》 -- 包括數(shù)據(jù)庫(kù)名稱、表名、字段名、字段類型、字段說明、備注、字段數(shù)值計(jì)算公式等。以《系統(tǒng)分析》為基礎(chǔ)，進(jìn)行詳細(xì)的數(shù)據(jù)庫(kù)設(shè)計(jì)。必要時(shí)可以用圖表解說，特別是關(guān)系數(shù)據(jù)庫(kù)。

7. 《功能函數(shù)文檔》 -- 包括變量名、變量初值、功能，函數(shù)名，參數(shù)，如何調(diào)用、備注、注意事項(xiàng)等。以《系統(tǒng)分析》為基礎(chǔ)，進(jìn)行詳細(xì)的說明，列出哪個(gè)功能涉及多少個(gè)函數(shù)，以便以后程序員修改、接手和擴(kuò)展。

8. 《界面文檔》 -- 包括軟件外觀、界面素材、編輯工具、文件名、菜單、按鈕和其它界面部件的要求，這里與軟件完成后的運(yùn)行界面是一致的。

9. 《編譯手冊(cè)》 -- 包括服務(wù)器編譯環(huán)境、操作系統(tǒng)、編譯工具、 GNU 的 C++ 編譯器版本信息、目錄說明、程序生成、源程序文件列表、 Makefile 配置及其相關(guān)程序的對(duì)應(yīng)關(guān)系列表?？蛻舳说木幾g過程、編譯結(jié)果、編譯示例、編譯環(huán)境、操作系統(tǒng)、編譯工具、源文件列表和制作安裝程序的過程。

10. 《 QA 文檔》 -- 包括產(chǎn)品簡(jiǎn)介、產(chǎn)品原理、產(chǎn)品功能列表、功能描述、功能流程、執(zhí)行結(jié)果、數(shù)據(jù)庫(kù)結(jié)構(gòu)、測(cè)試要求等，提供給軟件測(cè)試人員使用。

11. 《項(xiàng)目總結(jié)》 -- 包括項(xiàng)目簡(jiǎn)介、項(xiàng)目參與人員和開發(fā)時(shí)間、項(xiàng)目風(fēng)險(xiǎn)管理過程、項(xiàng)目功能列表、項(xiàng)目結(jié)構(gòu)特點(diǎn)、技術(shù)特點(diǎn)、對(duì)項(xiàng)目的升級(jí)建議、對(duì)以后的項(xiàng)目的建議、人員素質(zhì)情況等。 1. 《產(chǎn)品簡(jiǎn)介》 -- 包括公司背景、產(chǎn)品概念、適用范圍、產(chǎn)品功能、功能特點(diǎn)、運(yùn)行要求和公司聯(lián)系地址。

2. 《產(chǎn)品演示》 -- 包括公司簡(jiǎn)介、產(chǎn)品背景、產(chǎn)品描述、產(chǎn)品特點(diǎn)、產(chǎn)品作用、適用范圍、使用分析、功能模塊、解決問題、合作伙伴、成功案例等。一般用 Power point 或者 VCD 錄制軟件實(shí)現(xiàn)。

3. 《疑問解答》 -- 列出用戶關(guān)心的問題和處理方法。用于解答軟件的操作功能和解決用戶的疑難問題。

4. 《功能介紹》 -- 以《需求分析》為書寫基礎(chǔ)，包括軟件介紹、軟件結(jié)構(gòu)、功能列表、功能描述和公司聯(lián)系地址。

5. 《技術(shù)白皮書》 -- 以《技術(shù)分析》為書寫基礎(chǔ)，包括功能實(shí)現(xiàn)、技術(shù)選型、關(guān)鍵技術(shù)問題的解決、技術(shù)方案特點(diǎn)、技術(shù)升級(jí)方向等。

6. 《評(píng)測(cè)報(bào)告》 -- 第三方權(quán)威評(píng)測(cè)報(bào)告。包括評(píng)測(cè)目的、評(píng)測(cè)范圍、評(píng)測(cè)環(huán)境、評(píng)測(cè)內(nèi)容、實(shí)測(cè)數(shù)據(jù)、性能表現(xiàn)、結(jié)果分析和評(píng)測(cè)總結(jié)等。

7. 《安裝手冊(cè)》 -- 包括系統(tǒng)環(huán)境、運(yùn)行平臺(tái)、產(chǎn)品安裝過程、初始環(huán)境設(shè)置、安裝記錄等。

8. 《使用手冊(cè)》 -- 包括產(chǎn)品簡(jiǎn)介、功能列表、功能描述和解釋、功能操作、客戶服務(wù)和聯(lián)系方式等。

9. 《維護(hù)手冊(cè)》 -- 包括產(chǎn)品簡(jiǎn)介、系統(tǒng)須知、初始環(huán)境設(shè)置、系統(tǒng)配置、數(shù)據(jù)管理和備份、技術(shù)問題解答和聯(lián)系方式等。

10. 《用戶報(bào)告》 -- 包括產(chǎn)品簡(jiǎn)介、購(gòu)買時(shí)間、使用目的、使用時(shí)間、使用地點(diǎn)、實(shí)施過程、出現(xiàn)問題和解決、產(chǎn)品總結(jié)和建議等。

11. 《銷售培訓(xùn)》 -- 包括項(xiàng)目簡(jiǎn)介、產(chǎn)品功能、產(chǎn)品特點(diǎn)、商業(yè)優(yōu)勢(shì)、系統(tǒng)運(yùn)行環(huán)境、適用范圍、目標(biāo)客戶等。 第一、需求分析文檔

用戶需求分析文檔是指在和客戶進(jìn)行溝通時(shí)，把用戶所要求的信息記錄下來，根據(jù)用戶的要求進(jìn)行需求分析，規(guī)劃出我們要開發(fā)的軟件所要實(shí)現(xiàn)哪些功能。

第二、概要設(shè)計(jì)文檔

概要設(shè)計(jì)：顧名思義，就是對(duì)我們所要開發(fā)的軟件進(jìn)行一個(gè)整體的概括，把這個(gè)軟件所包含的功能模塊作一個(gè)設(shè)計(jì)，以后我們?cè)陂_發(fā)的時(shí)候就有目標(biāo)，有方向了。

第三、系統(tǒng)設(shè)計(jì)文檔

系統(tǒng)設(shè)計(jì)，就是對(duì)概要的一個(gè)詳細(xì)的實(shí)施，就是分析我們所要開發(fā)軟件各大功能模塊中所包含的小模塊，把這些小模塊都一一列舉出來，然后再對(duì)軟件開發(fā)人員進(jìn)行有條理的進(jìn)行開發(fā)任務(wù)的分配。

第四、詳細(xì)設(shè)計(jì)文檔

詳細(xì)設(shè)計(jì)文檔，主要是把我們每個(gè)小模塊，小功能的業(yè)務(wù)邏輯處理用文字的方式表達(dá)出來，讓程序員在編碼的時(shí)候有一個(gè)依據(jù)和參照；同時(shí)，在進(jìn)行詳細(xì)文檔設(shè)計(jì)的時(shí)候，有的軟件公司也會(huì)根據(jù)不同的項(xiàng)目作出相應(yīng)的《軟件開發(fā)代碼規(guī)范》性文檔。以保障我們所做工作的統(tǒng)一性。

第五、軟件測(cè)試文檔

當(dāng)我們參照軟件詳細(xì)設(shè)計(jì)文檔編碼完成后，接著就會(huì)根據(jù)我們所實(shí)現(xiàn)的功能，進(jìn)行軟件測(cè)試文檔的編寫；大多測(cè)試文檔有兩類，一類是軟件單體測(cè)試文檔，一類是軟件結(jié)合測(cè)試文檔；顧名思義，單體測(cè)試：就是對(duì)軟件中每個(gè)小的方法，一個(gè)獨(dú)立的方法進(jìn)行測(cè)試的文檔；結(jié)合測(cè)試：就是把多個(gè)功能模塊組合到一起進(jìn)行測(cè)試，主要是為了檢測(cè)每個(gè)功能模塊之前的交互性和功能的結(jié)合實(shí)現(xiàn)性。

第六、軟件完成后的總結(jié)匯報(bào)型文檔

不管所開發(fā)軟件的規(guī)模大小，在一個(gè)軟件開發(fā)結(jié)束后，我們都會(huì)把開發(fā)過中的問題和項(xiàng)目開發(fā)總結(jié)一起記錄下來，以防以后在開發(fā)過程中再有類似問題出現(xiàn)，提高我們的開發(fā)效率。

根據(jù)軟件開發(fā)公司的規(guī)模、標(biāo)準(zhǔn)和客戶的需求不同，開發(fā)文檔的種類和數(shù)量也不同，我在這里和大家討論的軟件開發(fā)相關(guān)文檔都是最基礎(chǔ)的；在軟件行業(yè)有一句話：一個(gè)軟件能否順利的完成并且功能是否完善，重要是看這個(gè)軟件有多少文檔，軟件開發(fā)文檔是一個(gè)軟件的支柱，如果你的開發(fā)文檔漏洞百出，那么你所開發(fā)出來的軟件也不可能會(huì)好；開發(fā)文檔的好壞可以直接影響到所開發(fā)出來軟件的成功與否。

軟件開發(fā)中詳細(xì)設(shè)計(jì)文檔現(xiàn)在是必須的么？如果不是用什么取代？

一個(gè)人的精力有限，不可能總是記憶設(shè)計(jì)程序時(shí)的思路，要求，因此需要用設(shè)計(jì)文檔記錄軟件開發(fā)中的細(xì)節(jié)內(nèi)容，以便以后重新涉及時(shí)可以查閱和回憶，迅速上手

當(dāng)前軟件設(shè)計(jì)一般是團(tuán)隊(duì)合作，如果想讓其他開發(fā)人員接手繼續(xù)設(shè)計(jì)，詳細(xì)的設(shè)計(jì)文檔可以使交接過程變得簡(jiǎn)單，否則先前的設(shè)計(jì)可能會(huì)白做了

在管理層面，項(xiàng)目負(fù)責(zé)人需要詳細(xì)的文檔，以便總結(jié)開發(fā)設(shè)計(jì)過程，使設(shè)計(jì)完整

綜上所述，除非微小項(xiàng)目，一般都需要詳細(xì)的設(shè)計(jì)文檔，尤其是團(tuán)隊(duì)軟件開發(fā)場(chǎng)合更是必須

軟件開發(fā)需要編寫哪些文檔？

這個(gè)問題沒有一定的，因?yàn)檫@里有多種因素

如，開發(fā)階段、文檔化要求程度等，若是通過CMM評(píng)估的，文檔就較多

一般的是按項(xiàng)目開發(fā)過程來分，基本的有

可行性研究報(bào)告（若是一個(gè)新項(xiàng)目且未確定的或應(yīng)客戶要求時(shí)需要，實(shí)際上大部份公司很少有這文檔)

用戶需求說明書(用戶+開發(fā)人員共同確認(rèn))

軟件需求規(guī)格說明書

設(shè)計(jì)說明書(體系結(jié)構(gòu)、詳細(xì)設(shè)計(jì))

測(cè)試用例

用戶手冊(cè)

實(shí)現(xiàn)代碼

這些文檔中，包括一定的分析與設(shè)計(jì)圖形，如用例圖、數(shù)據(jù)庫(kù)結(jié)構(gòu)、ER圖等

當(dāng)然項(xiàng)目計(jì)劃、測(cè)試計(jì)劃也應(yīng)算在內(nèi)

其它的(如CMM要求的)

風(fēng)險(xiǎn)、估算方面的，質(zhì)量保證方面的、配置管理方面、定義的模板、度量數(shù)據(jù)庫(kù)等

具體需要多少文檔就是要看項(xiàng)目實(shí)際

這方面的東西，可參考一些軟件工程類的書

關(guān)于軟件開發(fā)詳細(xì)設(shè)計(jì)文檔和軟件開發(fā)詳細(xì)設(shè)計(jì)文檔自動(dòng)生成工具的介紹到此就結(jié)束了，不知道你從中找到你需要的信息了嗎 ？如果你還想了解更多這方面的信息，記得收藏關(guān)注本站。