本篇文章給大家談談軟件開發(fā)文檔，以及軟件開發(fā)文檔編制規(guī)范對應的知識點，希望對各位有所幫助，不要忘了收藏本站喔。

本文目錄一覽：

• 1、軟件開發(fā)文檔的分類
• 2、軟件開發(fā)需要編寫哪些文檔？
• 3、軟件開發(fā)文檔包括哪些
• 4、軟件開發(fā)文檔干什么的？
• 5、軟件開發(fā)策劃書

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

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

2. 《投標方案》 -- 根據(jù)用戶的功能要求，經(jīng)過與招標方溝通和確認，技術人員開始書寫《投標方案》，方案書一般包括以下幾個重要的章節(jié)： 前言 -- 項目背景、公司背景和業(yè)務、技術人員結(jié)構(gòu)、公司的成功案例介紹等。 需求分析 -- 項目要求、軟件結(jié)構(gòu)、功能列表、功能描述、注意事項等。 技術方案 -- 總體要求和指導思想、技術解決方案、軟件開發(fā)平臺、網(wǎng)絡結(jié)構(gòu)體系等。 項目管理 -- 描述公司的軟件開發(fā)流程、工程實施服務、組織和人員分工、開發(fā)進度控制、軟件質(zhì)量保證、項目驗收和人員培訓、軟件資料文檔等。 技術支持 -- 公司的技術支持和服務介紹、服務宗旨和目標、服務級別和響應時間、技術服務區(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過程、編譯結(jié)果、編譯示例、編譯環(huán)境、操作系統(tǒng)、編譯工具、源文件列表和制作安裝程序的過程。

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

11. 《項目總結(jié)》 -- 包括項目簡介、項目參與人員和開發(fā)時間、項目風險管理過程、項目功能列表、項目結(jié)構(gòu)特點、技術特點、對項目的升級建議、對以后的項目的建議、人員素質(zhì)情況等。 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. 《功能介紹》 -- 以《需求分析》為書寫基礎，包括軟件介紹、軟件結(jié)構(gòu)、功能列表、功能描述和公司聯(lián)系地址。

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

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

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)品總結(jié)和建議等。

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)的功能，進行軟件測試文檔的編寫；大多測試文檔有兩類，一類是軟件單體測試文檔，一類是軟件結(jié)合測試文檔；顧名思義，單體測試：就是對軟件中每個小的方法，一個獨立的方法進行測試的文檔；結(jié)合測試：就是把多個功能模塊組合到一起進行測試，主要是為了檢測每個功能模塊之前的交互性和功能的結(jié)合實現(xiàn)性。

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

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

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

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

這個問題沒有一定的，因為這里有多種因素

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

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

可行性研究報告（若是一個新項目且未確定的或應客戶要求時需要，實際上大部份公司很少有這文檔)

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

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

設計說明書(體系結(jié)構(gòu)、詳細設計)

測試用例

用戶手冊

實現(xiàn)代碼

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

當然項目計劃、測試計劃也應算在內(nèi)

其它的(如CMM要求的)

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

具體需要多少文檔就是要看項目實際

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

軟件開發(fā)文檔包括哪些

軟件開發(fā)文檔是軟件開發(fā)使用和維護過程中的必備資料。它能提高軟件開發(fā)的效率，保證軟件的質(zhì)量，而且在軟件的使用過程中有指導，幫助，解惑的作用，尤其在維護工作中，文檔是不可或缺的資料。

軟件文檔可以分為開發(fā)文檔和產(chǎn)品文檔兩大類。

開發(fā)文檔包括：《功能要求》、《投標方案》、《需求分析》、《技術分析》、《系統(tǒng)分析》、《數(shù)據(jù)庫文檔》、《功能函數(shù)文檔》、《界面文檔》、《編譯手冊》、《 QA 文檔》、《項目總結(jié)》等。

產(chǎn)品文檔包括：《產(chǎn)品簡介》、《產(chǎn)品演示》、《疑問解答》、《功能介紹》、 《技術白皮書》、《評測報告》。

用戶文檔《安裝手冊》、《使用手冊》、《維護手冊》、 《用戶報告》、《銷售培訓》等。

軟件開發(fā)文檔干什么的？

在軟件的生產(chǎn)過程中，總是伴隨著大量的信息要記錄、要使用。因此，軟件文檔在產(chǎn)品的開發(fā)生產(chǎn)過程中起著重要的作用。

1)提高軟件開發(fā)過程的能見度。把開發(fā)過程中發(fā)生的事件以某種可閱讀的形式記錄在文檔中。管理人員可把這些記載下來的材料作為檢查軟件開發(fā)進度和開發(fā)質(zhì)量的依據(jù)，實現(xiàn)對軟件開發(fā)的工程管理。

2)提高開發(fā)效率。軟件文檔的編制，使得開發(fā)人員對各個階段的工作都進行周密思考、全盤權衡、從而減少返工。并且可在開發(fā)早期發(fā)現(xiàn)錯誤和不一致性，便于及時加以糾正。

3)作為開發(fā)人員在一定階段的工作成果和結(jié)束標志。

4)記錄開發(fā)過程中的有關信息，便于協(xié)調(diào)以后的軟件、開發(fā)、使用和維護。

5)提供對軟件的運行、維護和培訓的有關信息，便于管理人員、開發(fā)人員、操作人員、用戶之間的協(xié)作、交流和了解。使軟件開發(fā)活動更科學、更有成效。

6)便于潛在用戶了解軟件的功能、性能等各項指標，為他們選購符合自己需要的軟件提供依據(jù)。

文檔在各類人員、計算機之間的多種橋梁作用中看出：

既然軟件已經(jīng)從手工藝人的開發(fā)方式發(fā)展到工業(yè)化的生產(chǎn)方式，文檔在開發(fā)過程中就起到關鍵作用。從某種意義上來說，文檔是軟件開發(fā)

規(guī)范的體現(xiàn)和指南。按規(guī)范要求生成一整套文檔的過程，就是按照軟件開發(fā)規(guī)范完成一個軟件開發(fā)的過程。所以，在使用工程化的原理和方法來指導軟件的開發(fā)和維護時，應當充分注意軟件文檔的編制和管理。

PS：軟件開發(fā)文檔包括：

操作手冊

維護修改建議

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

開發(fā)文檔 軟件需求（規(guī)格）說明書

數(shù)據(jù)要求說明書

概要設計說明書

詳細設計說明書

可行性研究報告

項目開發(fā)計劃

管理文檔 項目開發(fā)計劃

測試計劃

測試報告

開發(fā)進度月報

開發(fā)總結(jié)報告

軟件開發(fā)策劃書

軟件開發(fā)策劃書怎么寫?下面就為大家提供了軟件開發(fā)策劃書范文，歡迎大家閱讀參考!

軟件項目開發(fā)計劃書模板【1】

項目名稱:********

評審日期:

1 引言

1.1編寫目的

說明編寫這份項目開發(fā)計劃的目的，并指出預期的讀者。

1.2背景

說明:

a.待開發(fā)的軟件系統(tǒng)的名稱;

b.本項目的任務提出者、開發(fā)者、用戶及實現(xiàn)該軟件的計算中心或計算機網(wǎng)絡;

c.該軟件系統(tǒng)同其他系統(tǒng)或其他機構(gòu)的基本的相互來往關系。

1.3定義

列出本文件中用到的專門術語的定義和外文首字母組詞的原詞組。

1.4參考資料

列出用得著的參考資料，如:

a.本項目的經(jīng)核準的計劃任務書或合同、上級機關的批文;

b.屬于本項目的其他已發(fā)表的文件;

c.本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標準。

列出這些文件資料的標題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。

2 項目概述

2.1工作內(nèi)容

簡要地說明在本項目的開發(fā)中須進行的各項主要工作。

2.2主要參加人員

扼要說明參加本項目開發(fā)工作的主要人員的情況，包括他們的技術水平。

2.3產(chǎn)品

2.3.1程序

列出需移交給用戶的程序的名稱、所用的編程語言及存儲程序的媒體形式，并通過引用有關文件，逐項說明其功能和能力。

2.3.2文件

列出需移交給用戶的每種文件的名稱及內(nèi)容要點。

2.3.3服務

列出需向用戶提供的各項服務，如培訓安裝、維護和運行支持等，應逐項規(guī)定開始日期、所提供支持的級別和服務的期限。

2.3.4非移交的產(chǎn)品

說明開發(fā)集體應向本單位交出但不必向用戶移交的產(chǎn)品(文件甚至某些程序)。

2.4驗收標準

對于上述這些應交出的產(chǎn)品和服務，逐項說明或引用資料說明驗收標準。

2.5完成項目的最遲期限

2.6本計劃的批準者和批準日期

3 實施計劃

3.1工作任務的分解與人員分工

對于項目開發(fā)中需完成的.各項工作，從需求分析、設計、實現(xiàn)、測試直到維護，包括文件的編制、審批、打印、分發(fā)工作，用戶培訓工作，軟件安裝工作等，按層次進行分解，指明每項任務的負責人和參加人員。

3.2接口人員

說明負責接口工作的人員及他們的職責，包括:

a.負責本項目同用戶的接口人員;

b.負責本項目同本單位各管理機構(gòu)，如合同計劃管理部門、財務部門、質(zhì)量管理部門等的接口人員;

c.負責本項目同各分合同負責單位的接口人員等。

3.3進度

對于需求分析、設計、編碼實現(xiàn)、測試、移交、培訓和安裝等工作，給出每項工作任務的預。

定開始日期、完成日期及所需資源，規(guī)定各項工作任務完成的先后順序以及表征每項工作任務完成的標志性事件(即所謂"里程碑")。

3.4預算

逐項列出本開發(fā)項目所需要的勞務(包括人員的數(shù)量和時間)以及經(jīng)費的預算(包括辦公費、差旅費、機時費、資料費、通訊設備和專用設備的租金等)和來源。

3.5關鍵問題

逐項列出能夠影響整個項目成敗的關鍵問題、技術難點和風險，指出這些問題對項目的影響。

4 支持條件

說明為支持本項目的開發(fā)所需要的各種條件和設施。

4.1計算機系統(tǒng)支持

逐項列出開發(fā)中和運行時所需的計算機系統(tǒng)支持，包括計算機、外圍設備、通訊設備、模擬器、編譯(或匯編)程序、操作系統(tǒng)、數(shù)據(jù)管理程序包、數(shù)據(jù)存儲能力和測試支持能力等，逐項給出有關到貨日期、使用時間的要求。

4.2需由用戶承擔的工作

逐項列出需要用戶承擔的工作和完成期限。

包括需由用戶提供的條件及提供時間。

4.3由外單位提供的條件

逐項列出需要外單位分合同承包者承擔的工作和完成的時間，包括需要由外單位提供的條件和提供的時間。

5 專題計劃要點

說明本項目開發(fā)中需制訂的各個專題計劃(如分合同計劃、開發(fā)人員培訓計劃、測試計劃、安全保密計劃、質(zhì)量保證計劃、配置管理計劃、用戶培訓計劃、系統(tǒng)安裝計劃等)的要點。

如何高效策劃應用軟件開發(fā)需求文檔【2】

高效策劃應用軟件開發(fā)需求文檔需要通過明確產(chǎn)品的長遠發(fā)展戰(zhàn)略、明確產(chǎn)品的核心功能、細致進行競品分析、制作前端以及后臺的需求文檔、UI做設計、交互設計、完善文案、完成高保證原型等環(huán)節(jié)。

一、明確應用軟件開發(fā)的長遠發(fā)展戰(zhàn)略

做一款產(chǎn)品首先需要明確幾個問題：用戶是誰?用戶使用產(chǎn)品能夠獲得什么?公司推出產(chǎn)品是為了獲得什么?只有明確這幾個問題之后，才能夠獲得明確的發(fā)展方向。

二、明確開發(fā)的核心功能

不同的產(chǎn)品需要的核心功能是不一樣的，如電商APP，策劃人員需要從前端和后臺等方面進行具體說明其所需要的核心功能需求。

在用戶端需要為用戶提供的主要功能包括：瀏覽商品、分類查看商品、加入收藏、加入購物車、直接購買等。

后臺系統(tǒng)搭建的過程中，需要根據(jù)不同的電商模式，進行設計不同的架構(gòu)，主要的策劃方向是根據(jù)商家端是全部自己來進行管理還是開發(fā)加盟的方式。

主要架構(gòu)包括賬戶架構(gòu)、功能架構(gòu)，用戶的前端展示的功能需要后臺給出相應字段，數(shù)據(jù)接口。

三、應用軟件開發(fā)競品分析

在確定核心功能需求和打磨的細節(jié)之外，接下來需要做的就是進行細致的競品分析，如電商APP，需要尋找5款產(chǎn)品，下載安卓和IOS端分別使用，不同的產(chǎn)品進行進行縱向和橫向分析，包括UI風格、色彩和圖標、文字、按鈕的顏色、大小、位置等，進行分析其設計的優(yōu)劣勢，給自己的產(chǎn)品設計提供必要的參考。

四、制作需求文檔

在制作需求文檔需要從前端和后臺兩個方面著手，在這個過程中需要考慮到后臺的架構(gòu)，接口的形式，是使用H5web頁面還是客戶端開發(fā)。

這里以UI設計、交互設計、IOS開發(fā)組、Android開發(fā)組、后臺開發(fā)組都具備的情況下為例進行輸出產(chǎn)品需求文檔。

首先根據(jù)已經(jīng)定義的功能板塊畫出整個應用軟件的前端的腦圖和后臺架構(gòu)的腦圖;

其次是框圖制作，其主要可以使用axure、sketch等軟件制作，進一步列出功能點、展示形式和內(nèi)容樣本;

再次是列出流程圖，包括節(jié)點、不同情況的判斷、處理方式，所需文案等。

后臺整體框架、表、字段說明，所需要的不同角色的屬性，加載條數(shù)、總體流程等。

第四，做低保證原型，和交互設計師一起制作低保真原型，把框圖、腦圖、流程圖、文字說明整合到一個文件;

第五，組織研發(fā)、運營等相關部門人員開會評審需求，根據(jù)原型走流程，完善細節(jié)，增加文字圖片說明……

五、UI設計和交互設計

在確認交付設計和文案確定好之后，接下來就要在UI做設計、交互設計師做交互的時候，找相關部門人員完善文案需求，和項目經(jīng)理一起對工作進行細分，確認時間節(jié)點，最后由交互設計師輸出一套高保證原型。

六、交付高保證原型

在這個過程中需要注意充分完善各個細節(jié)，對設計、交互、研發(fā)、運營等對工作要求以及工作流程都有清晰的設計思路，包括每個人的具體工、相應的時間節(jié)點等，然后應用軟件開發(fā)團隊根據(jù)具體的需求文檔進行執(zhí)行就可以了。

軟件開發(fā)文檔的介紹就聊到這里吧，感謝你花時間閱讀本站內(nèi)容，更多關于軟件開發(fā)文檔編制規(guī)范、軟件開發(fā)文檔的信息別忘了在本站進行查找喔。