本篇文章給大家談?wù)勡浖_(kāi)發(fā)設(shè)計(jì)文檔示例，以及軟件開(kāi)發(fā)系統(tǒng)設(shè)計(jì)文檔對(duì)應(yīng)的知識(shí)點(diǎn)，希望對(duì)各位有所幫助，不要忘了收藏本站喔。

本文目錄一覽：

• 1、軟件開(kāi)發(fā)文檔應(yīng)包括哪些內(nèi)容？
• 2、軟件項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告實(shí)例
• 3、做軟件項(xiàng)目設(shè)計(jì)文檔怎么寫(xiě)啊
• 4、軟件開(kāi)發(fā)需要編寫(xiě)哪些文檔？
• 5、軟件開(kāi)發(fā)文檔怎么寫(xiě)
• 6、怎么寫(xiě)項(xiàng)目開(kāi)發(fā)的文檔？

軟件開(kāi)發(fā)文檔應(yīng)包括哪些內(nèi)容？

開(kāi)發(fā)文檔

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

2. 《投標(biāo)方案》 — 根據(jù)用戶的功能要求，經(jīng)過(guò)與招標(biāo)方溝通和確認(rèn)，技術(shù)人員開(kāi)始書(shū)寫(xiě)《投標(biāo)方案》，方案書(shū)一般包括以下幾個(gè)重要的章節(jié)： 前言 — 項(xiàng)目背景、公司背景和業(yè)務(wù)、技術(shù)人員結(jié)構(gòu)、公司的成功案例介紹等。 需求分析 — 項(xiàng)目要求、軟件結(jié)構(gòu)、功能列表、功能描述、注意事項(xiàng)等。 技術(shù)方案 — 總體要求和指導(dǎo)思想、技術(shù)解決方案、軟件開(kāi)發(fā)平臺(tái)、網(wǎng)絡(luò)結(jié)構(gòu)體系等。 項(xiàng)目管理 — 描述公司的軟件開(kāi)發(fā)流程、工程實(shí)施服務(wù)、組織和人員分工、開(kāi)發(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à)列表、軟件開(kāi)發(fā)費(fèi)用、系統(tǒng)維護(hù)費(fèi)用等。 項(xiàng)目進(jìn)度 — 整個(gè)項(xiàng)目的進(jìn)度計(jì)劃，包括簽署合同、項(xiàng)目啟動(dòng)、需求分析、系統(tǒng)分析、程序開(kāi)發(fā)、測(cè)試維護(hù)、系統(tǒng)集成、用戶驗(yàn)收、用戶培訓(xùn)等步驟的時(shí)間規(guī)劃。

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

4. 《技術(shù)分析》 — 包括技術(shù)選型、技術(shù)比較、開(kāi)發(fā)人員、關(guān)鍵技術(shù)問(wèn)題的解決、技術(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ù)問(wèn)題要解決 ，估計(jì)開(kāi)發(fā)期間會(huì)碰到什么困難，技術(shù)方案以后如何升級(jí)，對(duì)本項(xiàng)目的技術(shù)有什么評(píng)價(jià)等。

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

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

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

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

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

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)目參與人員和開(kāi)發(fā)時(shí)間、項(xiàng)目風(fēng)險(xiǎn)管理過(guò)程、項(xiàng)目功能列表、項(xiàng)目結(jié)構(gòu)特點(diǎn)、技術(shù)特點(diǎn)、對(duì)項(xiàng)目的升級(jí)建議、對(duì)以后的項(xiàng)目的建議、人員素質(zhì)情況等。

軟件項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告實(shí)例

軟件項(xiàng)目總結(jié)報(bào)告范文

1引言

1.1編寫(xiě)目的

XXX公司業(yè)務(wù)管理系統(tǒng)的開(kāi)發(fā)已經(jīng)基本完成。寫(xiě)此項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告，以方便我們?cè)谝院蟮捻?xiàng)目開(kāi)發(fā)中來(lái)更好的實(shí)施項(xiàng)目的訂制開(kāi)發(fā); 讓我在今后的項(xiàng)目開(kāi)發(fā)中有更多的有據(jù)的資料來(lái)規(guī)范我們的開(kāi)發(fā)過(guò)程和提高我們的開(kāi)發(fā)效率,從而創(chuàng)造更多公司效益。

1.2背景

項(xiàng)目名稱：XXX業(yè)務(wù)管理系統(tǒng)

軟件名稱：XXX業(yè)務(wù)系統(tǒng)

客戶：XXX

用戶：XXX員工

1.3參考資料

項(xiàng)目開(kāi)發(fā)文檔：

1．軟件開(kāi)發(fā)數(shù)據(jù)模型：PDM_OperationSystem20070831.pdm

2．?dāng)?shù)據(jù)庫(kù)開(kāi)發(fā)文檔： XXX業(yè)務(wù)管理系統(tǒng)數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū)2.0.doc

3．軟件業(yè)務(wù)流程參考：XXX業(yè)務(wù)管理系統(tǒng)流程說(shuō)明.doc

4．軟件使用手冊(cè)參考：XXX業(yè)務(wù)管理系統(tǒng)功能說(shuō)明3.0.doc

5．軟件業(yè)務(wù)流程參考：XXX業(yè)務(wù)管理系統(tǒng)流程說(shuō)明.doc

6．軟件中使用到的第三方控件：ComponentArt Web.UI 2006.1252 for asp.net2.0.rar

7．軟件中使用的安全I(xiàn)key驅(qū)動(dòng)：Ikey Driver.rar

以上參考資料是截止2007-08-31是最新的資料文檔。如有修改，即使修改此處的參考文檔名稱。

2開(kāi)發(fā)工作評(píng)價(jià)

2.1對(duì)生產(chǎn)效率的評(píng)價(jià)

1． 系統(tǒng)開(kāi)發(fā)已歷時(shí)快1年的時(shí)間了

2． 開(kāi)發(fā)的反復(fù)性比較多。

3． 對(duì)客戶的需求理解不是很透徹。

綜合以上，此項(xiàng)目的開(kāi)發(fā)效率不是很高，相反有相當(dāng)一定時(shí)間的浪費(fèi)。

2.2對(duì)產(chǎn)品功能的評(píng)價(jià)

經(jīng)過(guò)我們公司各位同事的共同努力協(xié)作，XXX業(yè)務(wù)管理系統(tǒng)已經(jīng)很好的完成了客戶的業(yè)務(wù)流需求。經(jīng)過(guò)對(duì)客戶使用過(guò)程的觀察，此項(xiàng)目開(kāi)發(fā)的還是比較成功，但是還是存在著一些問(wèn)題，造成這些問(wèn)題的原因是多方面的。如：前期系統(tǒng)數(shù)據(jù)庫(kù)的設(shè)計(jì)缺陷和部分代碼的構(gòu)建缺陷、客戶需求的理解上也存在一定問(wèn)題，這就需要我們用一定的時(shí)間來(lái)維護(hù)客戶使用過(guò)程中提出的新問(wèn)題和存在的debug。總的來(lái)說(shuō)，此系統(tǒng)的功能開(kāi)發(fā)還是一個(gè)比較成功的案例。

2.3對(duì)技術(shù)方法的總結(jié)

在此項(xiàng)目中使用到技術(shù)和工具：

1． 使用代碼生成器：使用代碼生成器 [動(dòng)軟.Net代碼自動(dòng)生成器],此工具在很大程度上提高了編碼效率，從而加快了項(xiàng)目的開(kāi)發(fā)進(jìn)程。在以后的項(xiàng)目中，我們要盡量的來(lái)使用一些類似的工具來(lái)在最短的時(shí)間內(nèi)完成工作。在今后的項(xiàng)目開(kāi)發(fā)中，我們最好是能開(kāi)發(fā)出適合自己的代碼生成工具，更大限度的節(jié)省開(kāi)發(fā)周期和開(kāi)發(fā)費(fèi)用。

2． 使用數(shù)據(jù)庫(kù)建模工具；PowerDesigner 工具來(lái)建立系統(tǒng)數(shù)據(jù)庫(kù)模型，以方便程序員很好的理解業(yè)務(wù)流和掌握系統(tǒng)架構(gòu)者的架構(gòu)思想，更好的滿足客戶的功能需求。在今后的項(xiàng)目開(kāi)發(fā)中，我們要更好的來(lái)完成系統(tǒng)的前期數(shù)據(jù)庫(kù)模型的建立，最大的來(lái)優(yōu)化系統(tǒng)功能。

3． 使用第三方控件：此系統(tǒng)中使用了ComponentArt Web.UI 第三方控件。此控件在很大程度上滿足了客戶對(duì)軟件界面的需求，從而也給軟件的操作帶來(lái)了方便。本項(xiàng)目中只使用了ComponentArt Web.UI一種第三方控件，在今后的項(xiàng)目開(kāi)發(fā)過(guò)程中，要繼續(xù)使用第三方的控件。這樣以來(lái)，無(wú)論是針對(duì)軟件界面的美觀性、友好性來(lái)說(shuō)、易操作性而言，還是針對(duì)系統(tǒng)開(kāi)發(fā)效率而言，這都是很好途徑。但需要意的是：在是使用第三方控件時(shí)，要謹(jǐn)慎的選擇一些網(wǎng)絡(luò)中的比較常見(jiàn)的第三方控件。

4． 使用自定義控件：此系統(tǒng)中使用了自定義控件(GhdGridView),此自定義控件可以很好的統(tǒng)一系統(tǒng)中的所有信息顯示表格樣式。如客戶對(duì)數(shù)據(jù)顯示樣式有什么新的意見(jiàn)，我就不需要修改每一個(gè)頁(yè)面的表格樣式，我們只需要修改GhdGridView控件的樣式，系統(tǒng)中的所有繼承自GhdGridView的表格樣式都可以改變。

5． 系統(tǒng)開(kāi)發(fā)框架：此系統(tǒng)的框架使用的是簡(jiǎn)單三層結(jié)構(gòu)，此框架在開(kāi)發(fā)一些中小軟件是比較實(shí)用的。但是我們要是可以開(kāi)發(fā)出自己的框架，把一些通用的功能開(kāi)發(fā)到框架中。這樣以來(lái)，在以后的系統(tǒng)開(kāi)發(fā)中，針對(duì)系統(tǒng)中一些通用的功能就不需要再開(kāi)發(fā)，從而也可以很好的提高我們的開(kāi)發(fā)效率；減少很多維護(hù)費(fèi)用。使我們的技術(shù)不斷的更加成熟。

6． 系統(tǒng)安全加密：此系統(tǒng)中針對(duì)客戶提出的系統(tǒng)安全問(wèn)題，我們采用了Ikey加密硬件鑰匙來(lái)驗(yàn)證客戶端登陸客戶的合法性，此Ikey鑰匙可以綁定到一個(gè)系統(tǒng)使用用戶，也可以讓多個(gè)用戶來(lái)使用一個(gè)加密鑰匙來(lái)驗(yàn)證登陸系統(tǒng)的合法性。這樣以來(lái)，即使用戶的密碼不慎丟失，或者被不法人員取得（不法人員他也是無(wú)法登陸到我們的系統(tǒng)中來(lái)），這樣就最大的提高了我們系統(tǒng)的安全性。Ikey加密鑰匙是很好的加密B/S架構(gòu)軟件的硬件工具，在以后的軟件安全方面可以借鑒。

3項(xiàng)目經(jīng)驗(yàn)總結(jié)

3.1簽定合同

一個(gè)項(xiàng)目的開(kāi)發(fā)成敗或者說(shuō)項(xiàng)目開(kāi)發(fā)帶來(lái)效益的大小，在很大程度上是受項(xiàng)目合同簽定的影響的。往往，很多一部分公司與客戶簽定的項(xiàng)目合同都是很模糊的，也很難簽定的比較清楚，這樣以來(lái)就會(huì)導(dǎo)致在項(xiàng)目的開(kāi)發(fā)后期，工作兩會(huì)越來(lái)越大，影響項(xiàng)目的竣工周期；而且，項(xiàng)目的開(kāi)發(fā)費(fèi)用一般是不會(huì)變的。這樣以來(lái)，我們就大大的降低了我們的開(kāi)發(fā)效益。雖然需求范圍很難簽定的明確，但是我們?cè)诤灦ê贤瑫r(shí)，要盡量的去把合同功能邊界和添加新功能的條件簽定。

3.2開(kāi)發(fā)團(tuán)隊(duì)

在項(xiàng)目確立后，要盡快的建立起項(xiàng)目開(kāi)發(fā)團(tuán)隊(duì)。

項(xiàng)目團(tuán)隊(duì)成員的團(tuán)結(jié)合作、相互溝通是非常重要的，團(tuán)隊(duì)成員之間要相互學(xué)習(xí)彼此的優(yōu)點(diǎn)和技術(shù)，使團(tuán)隊(duì)的能力不斷的提高。這樣，在項(xiàng)目的開(kāi)發(fā)過(guò)程中，團(tuán)隊(duì)才不會(huì)被難題困住不動(dòng)。另外，團(tuán)隊(duì)中要有一個(gè)項(xiàng)目負(fù)責(zé)人，這個(gè)人無(wú)論是在與客戶的溝通上，還是在技術(shù)上都要是很出眾的人，此項(xiàng)目負(fù)責(zé)人要能很好的溝通客戶與開(kāi)發(fā)成員之間，以此來(lái)更好的理解客戶的功能需求。人的記憶力總是有限的，所以就要求開(kāi)發(fā)團(tuán)隊(duì)成員要盡量的書(shū)寫(xiě)一些開(kāi)發(fā)文檔，這些文檔往往是我們?cè)陧?xiàng)目開(kāi)發(fā)后期要用到的可尋資料。項(xiàng)目團(tuán)隊(duì)士氣是項(xiàng)目成功的一個(gè)因素,我們需要不斷的來(lái)培養(yǎng)我們的團(tuán)隊(duì)氣勢(shì)，使我們的團(tuán)隊(duì)不斷的壯大。

3.3需求的調(diào)研

在項(xiàng)目確立后，就到了需求調(diào)研分析階段。

1． 項(xiàng)目組對(duì)客戶的整體組織結(jié)構(gòu)、公司有關(guān)人員的關(guān)系、職責(zé)等如果沒(méi)有一個(gè)很好、足夠的了解掌握，這樣項(xiàng)目組就無(wú)法很好的完整的整理到客戶的需求、或者說(shuō)客戶真實(shí)的功能需求，如此以來(lái)我們就為自己埋下了地雷,影響項(xiàng)目的開(kāi)發(fā)周期，這就要求我們要與客戶搞好無(wú)論是工作上的還是生活上的朋友關(guān)系,要深入的去了解客戶需求。

2． 我們要盡量的讓客戶也參與到項(xiàng)目的開(kāi)發(fā)團(tuán)隊(duì)中來(lái)，也就是說(shuō)我們要使客戶把自己也納入到項(xiàng)目的開(kāi)發(fā)團(tuán)隊(duì)中來(lái)，如此一來(lái)，我們掌握客戶需求的真實(shí)性、可靠性就會(huì)大大的提高,也就不會(huì)為項(xiàng)目的后期功能開(kāi)發(fā)埋下陷阱

3． 在需求調(diào)研過(guò)程中，如果缺乏足夠用戶參與，這樣的需求調(diào)研也是失敗的。很多程序員不愿參與到客戶的需求調(diào)研中去，為什么呢？很簡(jiǎn)單，與客戶溝通不如與代碼溝通容易有意思。盡管這樣，我們還是必須用足夠多的時(shí)間去和客戶進(jìn)行溝通，了解他們真實(shí)的需求。很多用戶也是如此，他們自己也不愿意參與到項(xiàng)目的需求調(diào)研中來(lái)，為什么呢？需求調(diào)研有出去和朋友一塊爛漫對(duì)嗎。。。雖然現(xiàn)狀如此，我們還是要努力的使客戶參與到需求的調(diào)研中來(lái)。

4． 模糊需求，也就是模棱兩可是需求規(guī)格說(shuō)明中最為可怕的問(wèn)題。一是指諸多客戶對(duì)需求說(shuō)明產(chǎn)生了不同的理解；一是指單個(gè)讀者能用不止一個(gè)方式來(lái)解釋某個(gè)需求說(shuō)明。針對(duì)對(duì)這種情況，就要求我們的調(diào)研人員要能夠從多個(gè)角度來(lái)分析客戶的不同需求，整理出最終的需求與客戶確認(rèn)，定出最終真實(shí)可靠的需求，我們絕不能憑借我們自己的單面理解來(lái)定立客戶的最終需求。

5． 在一個(gè)項(xiàng)目的開(kāi)發(fā)中，文檔的書(shū)寫(xiě)是極為中要的一項(xiàng)工作。因?yàn)椋承┪臋n就是我們?cè)陂_(kāi)發(fā)后期與客戶溝通的可尋依據(jù)、也是我們程序員在編碼過(guò)程中要用到的重要文檔。我們絕對(duì)不能認(rèn)為，憑借我們的大腦來(lái)記錄所有的開(kāi)發(fā)需求。。。；即使，你說(shuō)你是天才，你要用你那顆愛(ài)因斯坦的大腦來(lái)記錄所有的開(kāi)發(fā)需求，那也是不可能的，人的精力總是有限的。這就要求我們?cè)谛枨笳{(diào)研中做好需求文檔的記錄和整理。

6． 需求調(diào)研工具選擇，客戶一般對(duì)圖形還是比較感興趣的，所以我們?cè)谡{(diào)研過(guò)程中，我要盡量的采用圖形化界面來(lái)和客戶溝通需求。比如可以采用Rose工具，把客戶的意思轉(zhuǎn)換為用例圖、時(shí)序圖、協(xié)作圖、狀態(tài)圖、類圖等，使表達(dá)的意思更加直觀。這樣客戶會(huì)更快的進(jìn)行問(wèn)題的實(shí)質(zhì)。

3.5做好開(kāi)發(fā)計(jì)劃

在項(xiàng)目確立后，我們就需要做好項(xiàng)目開(kāi)發(fā)計(jì)劃，需求調(diào)研用時(shí)，開(kāi)發(fā)用時(shí)，測(cè)試用時(shí)，實(shí)施用時(shí)，維護(hù)用時(shí)。在我們做好了計(jì)劃后，我們要隨時(shí)的跟蹤計(jì)劃任務(wù)的完成進(jìn)度，從而使我們的項(xiàng)目進(jìn)度掌控在我們的開(kāi)發(fā)周期范圍之內(nèi)，今日計(jì)劃、行動(dòng)，明日成功。

3.5很好的溝通

在其他行業(yè)中，人與人的之間的溝通只很重要的。項(xiàng)目開(kāi)發(fā)也不例外，很好的溝通能夠加快項(xiàng)目的進(jìn)度，這就要求我們每一個(gè)開(kāi)發(fā)人員要學(xué)會(huì)和善于溝通于客戶和同事之間。在一個(gè)項(xiàng)目的開(kāi)發(fā)過(guò)程中，我們與客戶的溝通是一個(gè)不斷交流和溝通的過(guò)程。在開(kāi)發(fā)到一定的階段，我們就需要和客戶溝通已有功能，盡量的去避免一些隱藏的問(wèn)題，及時(shí)的發(fā)現(xiàn)問(wèn)題，解決問(wèn)題，從而按時(shí)或者提前完成項(xiàng)目的開(kāi)發(fā)。

3.6做好工作總結(jié)

在項(xiàng)目進(jìn)行的過(guò)程中，我們要不斷去整理自己的工作情況和做好總結(jié)，這樣以來(lái)，無(wú)論是在自己的技術(shù)還是其它方面，都會(huì)對(duì)我們有很大的提高，在長(zhǎng)期的積累后，無(wú)論是我們個(gè)人能力，，還是我們的團(tuán)隊(duì)能力都會(huì)有很大的提高。

做軟件項(xiàng)目設(shè)計(jì)文檔怎么寫(xiě)啊

按照以下格式填就好了，不過(guò)是我自己寫(xiě)的，有不好的地方大家互相學(xué)習(xí)修改一下~

詳細(xì)設(shè)計(jì)文檔規(guī)范

1.0概述

這部分提供對(duì)整個(gè)設(shè)計(jì)文檔的概述。描述了所有數(shù)據(jù)，結(jié)構(gòu)，接口和軟件構(gòu)件級(jí)別的設(shè)計(jì)。

1.1 目標(biāo)和對(duì)象

描述軟件對(duì)象的所有目標(biāo)。

1.2 陳述范圍

軟件描述。主要輸入，過(guò)程功能，輸出的描述，不考慮詳細(xì)細(xì)節(jié)。

1.3 軟件內(nèi)容

軟件被置于商業(yè)或者產(chǎn)品線中，討論相關(guān)的戰(zhàn)略問(wèn)題。目的是讓讀者能夠?qū)Α昂陥D”有所了解。

1.4 主要系統(tǒng)參數(shù)

任何商務(wù)軟件或者產(chǎn)品線都包含軟件規(guī)定、設(shè)計(jì)、實(shí)現(xiàn)和測(cè)試的說(shuō)明和規(guī)范。

2.0 數(shù)據(jù)設(shè)計(jì)

描述所有數(shù)據(jù)結(jié)構(gòu)包括內(nèi)部變量，全局變量和臨時(shí)數(shù)據(jù)結(jié)構(gòu)。

2.1 內(nèi)部軟件數(shù)據(jù)結(jié)構(gòu)

描述軟件內(nèi)部的構(gòu)件之間的數(shù)據(jù)傳輸?shù)慕Y(jié)構(gòu)。

2.2 全局?jǐn)?shù)據(jù)結(jié)構(gòu)

描述主要部分的數(shù)據(jù)結(jié)構(gòu)。

2.3 臨時(shí)數(shù)據(jù)結(jié)構(gòu)

為臨時(shí)應(yīng)用而生成的文件的描述。

2.4 數(shù)據(jù)庫(kù)描述

作為應(yīng)用程序的一部分，描述數(shù)據(jù)庫(kù)結(jié)構(gòu)。

3.0 結(jié)構(gòu)化和構(gòu)件級(jí)別設(shè)計(jì)

描述程序結(jié)構(gòu)。

3.1 程序結(jié)構(gòu)

詳細(xì)描述應(yīng)用程序所選定的程序結(jié)構(gòu)。

3.1.1 結(jié)構(gòu)圖

圖形化描述結(jié)構(gòu)。

3.1.2 選擇性

討論其它可供考慮的結(jié)構(gòu)。選定3.1.1中結(jié)構(gòu)類型的原因。

3.2 構(gòu)件描述

詳細(xì)描述結(jié)構(gòu)中的每個(gè)軟件構(gòu)件。

3.2.1 構(gòu)件過(guò)程敘述(PSPEC)

描述構(gòu)件的過(guò)程。

3.2.2 構(gòu)件接口描述

詳細(xì)描述構(gòu)件的輸入和輸出。

3.2.3 構(gòu)件執(zhí)行細(xì)節(jié)

每個(gè)構(gòu)件的詳細(xì)演算描述。

3.2.3.1 接口描述

3.2.3.2 演算模型(e.g., PDL)

3.2.3.3 規(guī)范/限制

]3.2.3.4 本地?cái)?shù)據(jù)結(jié)構(gòu)

3.2.3.5 在3.2.3.6設(shè)計(jì)中包含的執(zhí)行結(jié)果

3.3 軟件接口描述

軟件對(duì)外界的接口描述

3.3.1機(jī)器對(duì)外接口

與其他機(jī)器或者設(shè)備的接口描述。

3.3.2系統(tǒng)對(duì)外接口

對(duì)其它系統(tǒng)、產(chǎn)品和網(wǎng)絡(luò)的接口描述。

3.3.3與人的接口

概述軟件與任何人的界面。

4.0 用戶界面設(shè)計(jì)

描述軟件的用戶界面設(shè)計(jì)。

4.1 描述用戶界面

詳細(xì)描述用戶界面，包括屏幕顯示圖標(biāo)、圖片或者類型。

4.1.1 屏幕圖片

從用戶角度描述界面。

4.1.2 對(duì)象和操作

所有屏幕對(duì)象和操作的定義。

4.2 界面設(shè)計(jì)規(guī)范

用戶界面的設(shè)計(jì)和實(shí)現(xiàn)的規(guī)范和標(biāo)準(zhǔn)。

4.3 可見(jiàn)構(gòu)件

實(shí)現(xiàn)的GUI可見(jiàn)構(gòu)件說(shuō)明。

4.4 UIDS描述

用戶界面開(kāi)發(fā)系統(tǒng)描述。

5.0約束、限制和系統(tǒng)參數(shù)

會(huì)影響軟件的規(guī)格說(shuō)明、設(shè)計(jì)和實(shí)現(xiàn)的特殊事件。

6.0測(cè)試標(biāo)準(zhǔn)

測(cè)試策略和預(yù)備測(cè)試用例描述。

6.1 測(cè)試的類別

規(guī)定實(shí)施測(cè)試的類別，包括盡量詳細(xì)的描述。這里是針對(duì)黑盒測(cè)試現(xiàn)象的描述。

6.2期待軟件反饋

測(cè)試期待的結(jié)果描述。

6.3執(zhí)行界線

特殊執(zhí)行需要的說(shuō)明。

6.4 重要構(gòu)件確認(rèn)

決定性構(gòu)件或者需要特殊注意的構(gòu)件的測(cè)試確認(rèn)。

7.0附錄

設(shè)計(jì)說(shuō)明的補(bǔ)充信息。

7.1系統(tǒng)可跟蹤矩陣

一個(gè)定期回歸系統(tǒng)規(guī)格跟蹤軟件需求的矩陣。

7.2 產(chǎn)品戰(zhàn)略

如果規(guī)格說(shuō)明書(shū)是為一個(gè)產(chǎn)品設(shè)計(jì)的，描述相關(guān)的產(chǎn)品戰(zhàn)略。

7.3 使用分析算法

描述所有分析活動(dòng)所使用到的分析算法。

7.4 補(bǔ)充信息 (如果有需要特別說(shuō)明的)

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

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

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

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

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

用戶需求說(shuō)明書(shū)(用戶+開(kāi)發(fā)人員共同確認(rèn))

軟件需求規(guī)格說(shuō)明書(shū)

設(shè)計(jì)說(shuō)明書(shū)(體系結(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í)際

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

軟件開(kāi)發(fā)文檔怎么寫(xiě)

這要看你的文檔是基于什么用途的銷(xiāo)售用途：要有產(chǎn)品白皮書(shū)，產(chǎn)品未來(lái)方向報(bào)告，使用性能報(bào)告，兼容性報(bào)告，產(chǎn)品演示文稿說(shuō)明設(shè)計(jì)用途的。產(chǎn)品功能需求文件，產(chǎn)品的底層設(shè)計(jì)，產(chǎn)品詳細(xì)設(shè)計(jì)內(nèi)容。產(chǎn)品用途的。產(chǎn)品目錄，自訴文件，幫助文件，使用手冊(cè)，產(chǎn)品授權(quán)書(shū)?？头猛?。已知問(wèn)題列表，常見(jiàn)問(wèn)題解答，危機(jī)處理指南，問(wèn)題診斷指南。有個(gè)模板可以看下國(guó)家標(biāo)準(zhǔn)軟件開(kāi)發(fā)文檔模板GB856T ;no=1

怎么寫(xiě)項(xiàng)目開(kāi)發(fā)的文檔？

軟件開(kāi)發(fā)中文檔的編寫(xiě)是一個(gè)不可缺少的環(huán)節(jié)，常見(jiàn)的如《需求分析》、《概要分析》、《數(shù)據(jù)庫(kù)設(shè)計(jì)》等。在“軟件人”的陣營(yíng)里向來(lái)存在兩種觀點(diǎn)，注重文檔還是關(guān)心代碼。

我這里寫(xiě)一個(gè)《用戶信息模塊的概要設(shè)計(jì)文檔》，只列舉主要內(nèi)容了

1.功能描述：用于完成系統(tǒng)用戶信息的新增、刪除、修改、查詢；

2.功能用例：一個(gè)主用例用戶信息，附加新增、刪除、修改、查詢4個(gè)子用例，操作人員為管理員，圖形就不畫(huà)了，很簡(jiǎn)單的；

3.業(yè)務(wù)流程：查詢有效范圍用戶信息——》新增用戶信息——》判斷當(dāng)前帳號(hào)是否存在——》存在給出提示，反之保存成功提示。

4.約束限制：超級(jí)管理員可操作所有（包含刪除，我這里考慮僅是邏輯刪除、非物理刪除）的用戶信息；系統(tǒng)管理員可操作除系統(tǒng)管理員、超級(jí)管理員外的全部用戶信息；單位管理員可操作本單位用戶信息；用戶帳號(hào)信息系統(tǒng)內(nèi)全局唯一；

5.系統(tǒng)性能：要求同時(shí)支持500個(gè)并發(fā)操作；頁(yè)面操作響應(yīng)時(shí)間小于1s；頁(yè)面大小小于1kb；

當(dāng)前用戶所屬員工信息不存在時(shí)，可直接進(jìn)行員工信息的添加，并完成用戶信息的同步保存，確保事務(wù)的完整性；

6.運(yùn)行環(huán)境：依賴系統(tǒng)整體運(yùn)行環(huán)境為準(zhǔn)（存在特殊需要注明）；

7.操作實(shí)體：用戶信息、員工信息、系統(tǒng)日志等。

8.異常處理：如果系統(tǒng)框架中已經(jīng)提供相關(guān)說(shuō)明，這里僅需要注明符合系統(tǒng)架構(gòu)異常處理方式即可。

9.外部接口：輸入—用戶ID，輸出—用戶信息；

10.其他說(shuō)明：用戶帳號(hào)必須定義為字母開(kāi)頭，數(shù)字與字母組合，并保證全局唯一；用戶密碼采用md5算法加密，系統(tǒng)架構(gòu)已提供相關(guān)接口。

11.注意事項(xiàng)：用戶帳號(hào)不能為空，不能存在空格，不能超過(guò)6位；超級(jí)用戶信息僅在系統(tǒng)初始化中完成其信息寫(xiě)入操作，其他用戶無(wú)權(quán)對(duì)其進(jìn)行修改。

項(xiàng)目組中也不是所有人都必須參與文檔的編寫(xiě)，通常業(yè)務(wù)需求人員、設(shè)計(jì)人員、架構(gòu)師、項(xiàng)目經(jīng)理、小組長(zhǎng)占大多數(shù)，而且這些人中很多也不是專注于寫(xiě)代碼的角色。

軟件開(kāi)發(fā)設(shè)計(jì)文檔示例的介紹就聊到這里吧，感謝你花時(shí)間閱讀本站內(nèi)容，更多關(guān)于軟件開(kāi)發(fā)系統(tǒng)設(shè)計(jì)文檔、軟件開(kāi)發(fā)設(shè)計(jì)文檔示例的信息別忘了在本站進(jìn)行查找喔。