軟件開發(fā)詳細設計文檔（軟件開發(fā)詳細設計文檔自動生成工具）
本篇文章給大家談談軟件開發(fā)詳細設計文檔，以及軟件開發(fā)詳細設計文檔自動生成工具對應的知識點，希望對各位有所幫助，不要忘了收藏本站喔。
本文目錄一覽：
軟件開發(fā)文檔的分類
1. 《功能要求》 -- 來源于客戶要求和市場調(diào)查，是軟件開發(fā)中最早期的一個環(huán)節(jié)?？蛻籼岢鲆粋€模糊的功能概念，或者要求解決一個實際問題，或者參照同類軟件的一個功能。有軟件經(jīng)驗的客戶還會提供比較詳細的技術規(guī)范書，把他們的要求全部列表書寫在文檔中，必要時加以圖表解說。這份文檔是需求分析的基礎。
2. 《投標方案》 -- 根據(jù)用戶的功能要求，經(jīng)過與招標方溝通和確認，技術人員開始書寫《投標方案》，方案書一般包括以下幾個重要的章節(jié)： 前言 -- 項目背景、公司背景和業(yè)務、技術人員結構、公司的成功案例介紹等。 需求分析 -- 項目要求、軟件結構、功能列表、功能描述、注意事項等。 技術方案 -- 總體要求和指導思想、技術解決方案、軟件開發(fā)平臺、網(wǎng)絡結構體系等。 項目管理 -- 描述公司的軟件開發(fā)流程、工程實施服務、組織和人員分工、開發(fā)進度控制、軟件質量保證、項目驗收和人員培訓、軟件資料文檔等。 技術支持 -- 公司的技術支持和服務介紹、服務宗旨和目標、服務級別和響應時間、技術服務區(qū)域、技術服務期限、授權用戶聯(lián)系人等。 系統(tǒng)報價 -- 軟、硬件平臺報價列表、軟件開發(fā)費用、系統(tǒng)維護費用等。 項目進度 -- 整個項目的進度計劃，包括簽署合同、項目啟動、需求分析、系統(tǒng)分析、程序開發(fā)、測試維護、系統(tǒng)集成、用戶驗收、用戶培訓等步驟的時間規(guī)劃。
3. 《需求分析》 -- 包括產(chǎn)品概述、主要概念、操作流程、功能列表和解說、注意事項、系統(tǒng)環(huán)境等。以《功能要求》為基礎，進行詳細的功能分析 ( 包括客戶提出的要求和根據(jù)開發(fā)經(jīng)驗建議的功能 ) ，列出本產(chǎn)品是什么，有什么特殊的概念，包括哪些功能分類，需要具備什么功能，該功能的操作如何，實現(xiàn)的時候該注意什么細節(jié)，客戶有什么要求，系統(tǒng)運行環(huán)境的要求等。這里的功能描述跟以后的使用手冊是一致的。
4. 《技術分析》 -- 包括技術選型、技術比較、開發(fā)人員、關鍵技術問題的解決、技術風險、技術升級方向、技術方案評價，競爭對手技術分析等。以《需求分析》為基礎，進行詳細的技術分析 ( 產(chǎn)品的性能和實現(xiàn)方法 ) ，列出本項目需要使用什么技術方案，為什么，有哪些技術問題要解決 ，估計開發(fā)期間會碰到什么困難，技術方案以后如何升級，對本項目的技術有什么評價等。
5. 《系統(tǒng)分析》 -- 包括功能實現(xiàn)、模塊組成、功能流程圖、函數(shù)接口、數(shù)據(jù)字典、軟件開發(fā)需要考慮的各種問題等。以《需求分析》為基礎，進行詳細的系統(tǒng)分析 ( 產(chǎn)品的開發(fā)和實現(xiàn)方法 ) ，估計開發(fā)期間需要把什么問題說明白，程序員根據(jù)《系統(tǒng)分析》，開始在項目主管的帶領下進行編碼。
6. 《數(shù)據(jù)庫文檔》 -- 包括數(shù)據(jù)庫名稱、表名、字段名、字段類型、字段說明、備注、字段數(shù)值計算公式等。以《系統(tǒng)分析》為基礎，進行詳細的數(shù)據(jù)庫設計。必要時可以用圖表解說，特別是關系數(shù)據(jù)庫。
7. 《功能函數(shù)文檔》 -- 包括變量名、變量初值、功能，函數(shù)名，參數(shù)，如何調(diào)用、備注、注意事項等。以《系統(tǒng)分析》為基礎，進行詳細的說明，列出哪個功能涉及多少個函數(shù)，以便以后程序員修改、接手和擴展。
8. 《界面文檔》 -- 包括軟件外觀、界面素材、編輯工具、文件名、菜單、按鈕和其它界面部件的要求，這里與軟件完成后的運行界面是一致的。
9. 《編譯手冊》 -- 包括服務器編譯環(huán)境、操作系統(tǒng)、編譯工具、 GNU 的 C++ 編譯器版本信息、目錄說明、程序生成、源程序文件列表、 Makefile 配置及其相關程序的對應關系列表?？蛻舳说木幾g過程、編譯結果、編譯示例、編譯環(huán)境、操作系統(tǒng)、編譯工具、源文件列表和制作安裝程序的過程。
10. 《 QA 文檔》 -- 包括產(chǎn)品簡介、產(chǎn)品原理、產(chǎn)品功能列表、功能描述、功能流程、執(zhí)行結果、數(shù)據(jù)庫結構、測試要求等，提供給軟件測試人員使用。
11. 《項目總結》 -- 包括項目簡介、項目參與人員和開發(fā)時間、項目風險管理過程、項目功能列表、項目結構特點、技術特點、對項目的升級建議、對以后的項目的建議、人員素質情況等。 1. 《產(chǎn)品簡介》 -- 包括公司背景、產(chǎn)品概念、適用范圍、產(chǎn)品功能、功能特點、運行要求和公司聯(lián)系地址。
2. 《產(chǎn)品演示》 -- 包括公司簡介、產(chǎn)品背景、產(chǎn)品描述、產(chǎn)品特點、產(chǎn)品作用、適用范圍、使用分析、功能模塊、解決問題、合作伙伴、成功案例等。一般用 Power point 或者 VCD 錄制軟件實現(xiàn)。
3. 《疑問解答》 -- 列出用戶關心的問題和處理方法。用于解答軟件的操作功能和解決用戶的疑難問題。
4. 《功能介紹》 -- 以《需求分析》為書寫基礎，包括軟件介紹、軟件結構、功能列表、功能描述和公司聯(lián)系地址。
5. 《技術白皮書》 -- 以《技術分析》為書寫基礎，包括功能實現(xiàn)、技術選型、關鍵技術問題的解決、技術方案特點、技術升級方向等。
6. 《評測報告》 -- 第三方權威評測報告。包括評測目的、評測范圍、評測環(huán)境、評測內(nèi)容、實測數(shù)據(jù)、性能表現(xiàn)、結果分析和評測總結等。
7. 《安裝手冊》 -- 包括系統(tǒng)環(huán)境、運行平臺、產(chǎn)品安裝過程、初始環(huán)境設置、安裝記錄等。
8. 《使用手冊》 -- 包括產(chǎn)品簡介、功能列表、功能描述和解釋、功能操作、客戶服務和聯(lián)系方式等。
9. 《維護手冊》 -- 包括產(chǎn)品簡介、系統(tǒng)須知、初始環(huán)境設置、系統(tǒng)配置、數(shù)據(jù)管理和備份、技術問題解答和聯(lián)系方式等。
10. 《用戶報告》 -- 包括產(chǎn)品簡介、購買時間、使用目的、使用時間、使用地點、實施過程、出現(xiàn)問題和解決、產(chǎn)品總結和建議等。
11. 《銷售培訓》 -- 包括項目簡介、產(chǎn)品功能、產(chǎn)品特點、商業(yè)優(yōu)勢、系統(tǒng)運行環(huán)境、適用范圍、目標客戶等。 第一、需求分析文檔
用戶需求分析文檔是指在和客戶進行溝通時，把用戶所要求的信息記錄下來，根據(jù)用戶的要求進行需求分析，規(guī)劃出我們要開發(fā)的軟件所要實現(xiàn)哪些功能。
第二、概要設計文檔
概要設計：顧名思義，就是對我們所要開發(fā)的軟件進行一個整體的概括，把這個軟件所包含的功能模塊作一個設計，以后我們在開發(fā)的時候就有目標，有方向了。
第三、系統(tǒng)設計文檔
系統(tǒng)設計，就是對概要的一個詳細的實施，就是分析我們所要開發(fā)軟件各大功能模塊中所包含的小模塊，把這些小模塊都一一列舉出來，然后再對軟件開發(fā)人員進行有條理的進行開發(fā)任務的分配。
第四、詳細設計文檔
詳細設計文檔，主要是把我們每個小模塊，小功能的業(yè)務邏輯處理用文字的方式表達出來，讓程序員在編碼的時候有一個依據(jù)和參照；同時，在進行詳細文檔設計的時候，有的軟件公司也會根據(jù)不同的項目作出相應的《軟件開發(fā)代碼規(guī)范》性文檔。以保障我們所做工作的統(tǒng)一性。
第五、軟件測試文檔
當我們參照軟件詳細設計文檔編碼完成后，接著就會根據(jù)我們所實現(xiàn)的功能，進行軟件測試文檔的編寫；大多測試文檔有兩類，一類是軟件單體測試文檔，一類是軟件結合測試文檔；顧名思義，單體測試：就是對軟件中每個小的方法，一個獨立的方法進行測試的文檔；結合測試：就是把多個功能模塊組合到一起進行測試，主要是為了檢測每個功能模塊之前的交互性和功能的結合實現(xiàn)性。
第六、軟件完成后的總結匯報型文檔
不管所開發(fā)軟件的規(guī)模大小，在一個軟件開發(fā)結束后，我們都會把開發(fā)過中的問題和項目開發(fā)總結一起記錄下來，以防以后在開發(fā)過程中再有類似問題出現(xiàn)，提高我們的開發(fā)效率。
根據(jù)軟件開發(fā)公司的規(guī)模、標準和客戶的需求不同，開發(fā)文檔的種類和數(shù)量也不同，我在這里和大家討論的軟件開發(fā)相關文檔都是最基礎的；在軟件行業(yè)有一句話：一個軟件能否順利的完成并且功能是否完善，重要是看這個軟件有多少文檔，軟件開發(fā)文檔是一個軟件的支柱，如果你的開發(fā)文檔漏洞百出，那么你所開發(fā)出來的軟件也不可能會好；開發(fā)文檔的好壞可以直接影響到所開發(fā)出來軟件的成功與否。
軟件開發(fā)中詳細設計文檔現(xiàn)在是必須的么？如果不是用什么取代？
一個人的精力有限，不可能總是記憶設計程序時的思路，要求，因此需要用設計文檔記錄軟件開發(fā)中的細節(jié)內(nèi)容，以便以后重新涉及時可以查閱和回憶，迅速上手
當前軟件設計一般是團隊合作，如果想讓其他開發(fā)人員接手繼續(xù)設計，詳細的設計文檔可以使交接過程變得簡單，否則先前的設計可能會白做了
在管理層面，項目負責人需要詳細的文檔，以便總結開發(fā)設計過程，使設計完整
綜上所述，除非微小項目，一般都需要詳細的設計文檔，尤其是團隊軟件開發(fā)場合更是必須
軟件開發(fā)需要編寫哪些文檔？
這個問題沒有一定的，因為這里有多種因素
如，開發(fā)階段、文檔化要求程度等，若是通過CMM評估的，文檔就較多
一般的是按項目開發(fā)過程來分，基本的有
可行性研究報告（若是一個新項目且未確定的或應客戶要求時需要，實際上大部份公司很少有這文檔)
用戶需求說明書(用戶+開發(fā)人員共同確認)
軟件需求規(guī)格說明書
設計說明書(體系結構、詳細設計)
測試用例
用戶手冊
實現(xiàn)代碼
這些文檔中，包括一定的分析與設計圖形，如用例圖、數(shù)據(jù)庫結構、ER圖等
當然項目計劃、測試計劃也應算在內(nèi)
其它的(如CMM要求的)
風險、估算方面的，質量保證方面的、配置管理方面、定義的模板、度量數(shù)據(jù)庫等
具體需要多少文檔就是要看項目實際
這方面的東西，可參考一些軟件工程類的書
關于軟件開發(fā)詳細設計文檔和軟件開發(fā)詳細設計文檔自動生成工具的介紹到此就結束了，不知道你從中找到你需要的信息了嗎 ？如果你還想了解更多這方面的信息，記得收藏關注本站。
