做軟件項(xiàng)目設(shè)計(jì)文檔怎么寫啊按照以下格式填就好了 , 不過是我自己寫的,有不好的地方大家互相學(xué)習(xí)修改一下~
詳細(xì)設(shè)計(jì)文檔規(guī)范
1.0概述
這部分提供對整個(gè)設(shè)計(jì)文檔的概述 。描述了所有數(shù)據(jù),結(jié)構(gòu),接口和軟件構(gòu)件級別的設(shè)計(jì) 。
1.1目標(biāo)和對象
描述軟件對象的所有目標(biāo) 。
1.2陳述范圍
軟件描述 。主要輸入,過程功能 , 輸出的描述,不考慮詳細(xì)細(xì)節(jié) 。
1.3軟件內(nèi)容
軟件被置于商業(yè)或者產(chǎn)品線中,討論相關(guān)的戰(zhàn)略問題 。目的是讓讀者能夠?qū)Α昂陥D”有所了解 。
1.4主要系統(tǒng)參數(shù)
任何商務(wù)軟件或者產(chǎn)品線都包含軟件規(guī)定、設(shè)計(jì)、實(shí)現(xiàn)和測試的說明和規(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ù)庫描述
作為應(yīng)用程序的一部分,描述數(shù)據(jù)庫結(jié)構(gòu) 。
3.0結(jié)構(gòu)化和構(gòu)件級別設(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)件過程敘述(PSPEC)
描述構(gòu)件的過程 。
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軟件接口描述
軟件對外界的接口描述
3.3.1機(jī)器對外接口
與其他機(jī)器或者設(shè)備的接口描述 。
3.3.2系統(tǒng)對外接口
對其它系統(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對象和操作
所有屏幕對象和操作的定義 。
4.2界面設(shè)計(jì)規(guī)范
用戶界面的設(shè)計(jì)和實(shí)現(xiàn)的規(guī)范和標(biāo)準(zhǔn) 。
4.3可見構(gòu)件
實(shí)現(xiàn)的GUI可見構(gòu)件說明 。
4.4UIDS描述
用戶界面開發(fā)系統(tǒng)描述 。
5.0約束、限制和系統(tǒng)參數(shù)
會影響軟件的規(guī)格說明、設(shè)計(jì)和實(shí)現(xiàn)的特殊事件 。
6.0測試標(biāo)準(zhǔn)
測試策略和預(yù)備測試用例描述 。
6.1測試的類別
規(guī)定實(shí)施測試的類別,包括盡量詳細(xì)的描述 。這里是針對黑盒測試現(xiàn)象的描述 。
6.2期待軟件反饋
測試期待的結(jié)果描述 。
6.3執(zhí)行界線
特殊執(zhí)行需要的說明 。
6.4重要構(gòu)件確認(rèn)
決定性構(gòu)件或者需要特殊注意的構(gòu)件的測試確認(rèn) 。
7.0附錄
設(shè)計(jì)說明的補(bǔ)充信息 。
7.1系統(tǒng)可跟蹤矩陣
一個(gè)定期回歸系統(tǒng)規(guī)格跟蹤軟件需求的矩陣 。
7.2產(chǎn)品戰(zhàn)略
如果規(guī)格說明書是為一個(gè)產(chǎn)品設(shè)計(jì)的,描述相關(guān)的產(chǎn)品戰(zhàn)略 。
7.3使用分析算法
描述所有分析活動(dòng)所使用到的分析算法 。
7.4補(bǔ)充信息(如果有需要特別說明的)
軟件開發(fā)設(shè)計(jì)文檔模板軟件開發(fā)設(shè)計(jì)文檔
文檔管理信息表
主題|機(jī)票預(yù)定系統(tǒng)|
版本|1.1|
內(nèi)容|置于個(gè)旅行社定票點(diǎn)的前臺客戶程序,以及置于|航空公司的數(shù)據(jù)庫服務(wù)器 。|
關(guān)鍵字|機(jī)票預(yù)定|
參考文檔|創(chuàng)建時(shí)間|2016.1.5|
創(chuàng)建人|金城鵬|
最新發(fā)布日期|2016.1.5|
文檔變更紀(jì)錄
更改人|日期|更改內(nèi)容|
創(chuàng)建文件|
文檔主要評審意見
產(chǎn)品組
評審人員|日期|意見|
QA組
評審人員|日期|意見|
角色|主要職責(zé)|負(fù)責(zé)模塊|人員|備注|
項(xiàng)目經(jīng)理|PM|項(xiàng)目全面負(fù)責(zé)|項(xiàng)目設(shè)計(jì)|主要框架/模塊編寫|項(xiàng)目進(jìn)度控制|無|無|產(chǎn)品經(jīng)理|PT|定義需求|產(chǎn)品監(jiān)督|結(jié)果驗(yàn)證(測試)|用戶文檔|無|無|程序員|DEV||后臺開發(fā)|金城鵬|程序員|DEV||頁面開發(fā)|金城鵬|||
航空公司為方便旅客,需開發(fā)一個(gè)機(jī)票預(yù)定系統(tǒng) 。為便于旅客由旅行社代替
航空公司負(fù)責(zé)為旅客定票,旅行社把預(yù)定機(jī)票的旅客信息,包括姓名、性別、工作單
位、身份證號碼、旅行時(shí)間、旅行目的地,輸入機(jī)票預(yù)定系統(tǒng)的客戶端程序,系統(tǒng)經(jīng)
過查詢航空公司內(nèi)的航班數(shù)據(jù)服務(wù)器后,為旅客安排航班,印出取票通知 。旅客在飛
機(jī)起飛前一天憑取票通知和帳單交款后取票 , 系統(tǒng)校對無誤后即印出機(jī)票給旅客 。備的是帳單號 , 將準(zhǔn)備好的數(shù)據(jù)送查尋
軟件開發(fā)文檔應(yīng)該如何寫?如果我們知道軟件文檔的價(jià)值,那么為什么不經(jīng)常使用它呢?對于新手,大多數(shù)軟件文檔都存在很多下面提到的這些問題:
· 糟糕的語法和/或拼寫錯(cuò)誤的詞語
· 不完整
· 過期或不準(zhǔn)確
· 篇幅太長
http://www.mscto.com
· 首字母縮寫沒有解釋或術(shù)語不專業(yè)
http://www.mscto.com
· 難于找到信息或在文檔中定位 軟件開發(fā)網(wǎng)
存在這些問題的主要原因是軟件文檔通常沒有被給予足夠的重視 。項(xiàng)目預(yù)算被迫將主要活動(dòng)花在了開發(fā)工作上,在那里管理層很容易看到他們的收益 。值得投入成本的文檔工作通常都是主觀的 , 而且通常被刻畫為需要避免的成本,因?yàn)樗鼈儽徽J(rèn)為不能產(chǎn)生投資回報(bào)(ROI) 。很多項(xiàng)目經(jīng)理將客戶所需要的最少文檔看作是“鍍金” 。
軟件開發(fā)網(wǎng)
軟件文檔的另外一個(gè)麻煩來源是文檔的作者 。很多應(yīng)用程序開發(fā)經(jīng)理覺得軟件文檔是開發(fā)工作的一個(gè)標(biāo)準(zhǔn)部分,因此,要求他們的開發(fā)人員在編碼時(shí)也編寫軟件文檔 。
雖然這在理論上是說得過去的,但是不應(yīng)該將開發(fā)人員看成文檔作者 。很簡單,技術(shù)人員只被培訓(xùn)如何開發(fā) , 而沒有被培訓(xùn)如何寫文檔 。為了解決這一問題 , 很多應(yīng)用程序開發(fā)經(jīng)理嘗試通過聘請一些技術(shù)性寫手或商業(yè)分析人員來提高他們的軟件文檔的質(zhì)量 。這就導(dǎo)致出現(xiàn)了一個(gè)相反的問題:技術(shù)寫手和商業(yè)分析人員通常只有有限的技術(shù)技能 。
解決方案依賴于文檔,文檔應(yīng)該迎合其潛在讀者的口味 。這方面的通用規(guī)則是要求使用一個(gè)協(xié)同工作方法來編寫文檔,這種方法允許開發(fā)人員和寫手發(fā)揮他們的長處 。例如,如果潛在的讀者是系統(tǒng)設(shè)計(jì)人員,那么開發(fā)人員應(yīng)該提供詳細(xì)的輸入 , 但是允許技術(shù)寫手去組織和編輯內(nèi)容以使文檔符合語法 。
不管潛在的讀者還是被選中的讀者,軟件文檔的質(zhì)量與其可使用性相關(guān) , 以下六個(gè)屬性可以用來測量軟件文檔的可使用性:
· 適用性:文檔提供了相關(guān)的信息嗎?
· 合時(shí)性:文檔所提供的是當(dāng)時(shí)的信息嗎?
· 正確性:文檔所提供的信息正確嗎?
· 完整性:文檔是不是足夠詳細(xì)?
· 可用性:文檔隨手可用嗎?
· 可使用性:能夠快速直觀地找
希望能助你一臂之力
軟件開發(fā)中詳細(xì)設(shè)計(jì)文檔怎么寫設(shè)計(jì)文檔肯定包括功能模塊的簡述,子模塊的功能描述,包括基礎(chǔ)平臺描述 , 數(shù)據(jù)庫鏈接描述、權(quán)限設(shè)計(jì)描述等等,需要模板的話請向ITJOB老師索取下 。
如何寫軟件設(shè)計(jì)文檔按照以下格式填就好了,不過是我自己寫的,有不好的地方大家互相學(xué)習(xí)修改一下~
詳細(xì)設(shè)計(jì)文檔規(guī)范
1.0概述
這部分提供對整個(gè)設(shè)計(jì)文檔的概述 。描述了所有數(shù)據(jù) , 結(jié)構(gòu),接口和軟件構(gòu)件級別的設(shè)計(jì) 。
1.1 目標(biāo)和對象
描述軟件對象的所有目標(biāo) 。
1.2 陳述范圍
軟件描述 。主要輸入,過程功能,輸出的描述,不考慮詳細(xì)細(xì)節(jié) 。
1.3 軟件內(nèi)容
軟件被置于商業(yè)或者產(chǎn)品線中 , 討論相關(guān)的戰(zhàn)略問題 。目的是讓讀者能夠?qū)Α昂陥D”有所了解 。
1.4 主要系統(tǒng)參數(shù)
任何商務(wù)軟件或者產(chǎn)品線都包含軟件規(guī)定、設(shè)計(jì)、實(shí)現(xiàn)和測試的說明和規(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ù)庫描述
作為應(yīng)用程序的一部分,描述數(shù)據(jù)庫結(jié)構(gòu) 。
3.0 結(jié)構(gòu)化和構(gòu)件級別設(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)件過程敘述(PSPEC)
描述構(gòu)件的過程 。
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 軟件接口描述
軟件對外界的接口描述
3.3.1機(jī)器對外接口
與其他機(jī)器或者設(shè)備的接口描述 。
3.3.2系統(tǒng)對外接口
對其它系統(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 對象和操作
所有屏幕對象和操作的定義 。
4.2 界面設(shè)計(jì)規(guī)范
用戶界面的設(shè)計(jì)和實(shí)現(xiàn)的規(guī)范和標(biāo)準(zhǔn) 。
4.3 可見構(gòu)件
實(shí)現(xiàn)的GUI可見構(gòu)件說明 。
4.4 UIDS描述
用戶界面開發(fā)系統(tǒng)描述 。
5.0約束、限制和系統(tǒng)參數(shù)
會影響軟件的規(guī)格說明、設(shè)計(jì)和實(shí)現(xiàn)的特殊事件 。
6.0測試標(biāo)準(zhǔn)
測試策略和預(yù)備測試用例描述 。
6.1 測試的類別
規(guī)定實(shí)施測試的類別,包括盡量詳細(xì)的描述 。這里是針對黑盒測試現(xiàn)象的描述 。
6.2期待軟件反饋
測試期待的結(jié)果描述 。
6.3執(zhí)行界線
特殊執(zhí)行需要的說明 。
6.4 重要構(gòu)件確認(rèn)
決定性構(gòu)件或者需要特殊注意的構(gòu)件的測試確認(rèn) 。
7.0附錄
設(shè)計(jì)說明的補(bǔ)充信息 。
7.1系統(tǒng)可跟蹤矩陣
一個(gè)定期回歸系統(tǒng)規(guī)格跟蹤軟件需求的矩陣 。
7.2 產(chǎn)品戰(zhàn)略
如果規(guī)格說明書是為一個(gè)產(chǎn)品設(shè)計(jì)的,描述相關(guān)的產(chǎn)品戰(zhàn)略 。
7.3 使用分析算法
描述所有分析活動(dòng)所使用到的分析算法 。
7.4 補(bǔ)充信息 (如果有需要特別說明的)
做軟件項(xiàng)目設(shè)計(jì)文檔怎么寫啊按照以下格式填就好了,不過是我自己寫的,有不好的地方大家互相學(xué)習(xí)修改一下~
詳細(xì)設(shè)計(jì)文檔規(guī)范
1.0概述
這部分提供對整個(gè)設(shè)計(jì)文檔的概述 。描述了所有數(shù)據(jù) , 結(jié)構(gòu),接口和軟件構(gòu)件級別的設(shè)計(jì) 。
1.1 目標(biāo)和對象
描述軟件對象的所有目標(biāo) 。
1.2 陳述范圍
軟件描述 。主要輸入,過程功能,輸出的描述,不考慮詳細(xì)細(xì)節(jié) 。
1.3 軟件內(nèi)容
軟件被置于商業(yè)或者產(chǎn)品線中,討論相關(guān)的戰(zhàn)略問題 。目的是讓讀者能夠?qū)Α昂陥D”有所了解 。
1.4 主要系統(tǒng)參數(shù)
任何商務(wù)軟件或者產(chǎn)品線都包含軟件規(guī)定、設(shè)計(jì)、實(shí)現(xiàn)和測試的說明和規(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ù)庫描述
作為應(yīng)用程序的一部分,描述數(shù)據(jù)庫結(jié)構(gòu) 。
3.0 結(jié)構(gòu)化和構(gòu)件級別設(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)件過程敘述(PSPEC)
描述構(gòu)件的過程 。
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 軟件接口描述
軟件對外界的接口描述
3.3.1機(jī)器對外接口
與其他機(jī)器或者設(shè)備的接口描述 。
3.3.2系統(tǒng)對外接口
對其它系統(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 對象和操作
所有屏幕對象和操作的定義 。
4.2 界面設(shè)計(jì)規(guī)范
用戶界面的設(shè)計(jì)和實(shí)現(xiàn)的規(guī)范和標(biāo)準(zhǔn) 。
4.3 可見構(gòu)件
實(shí)現(xiàn)的GUI可見構(gòu)件說明 。
4.4 UIDS描述
用戶界面開發(fā)系統(tǒng)描述 。
5.0約束、限制和系統(tǒng)參數(shù)
會影響軟件的規(guī)格說明、設(shè)計(jì)和實(shí)現(xiàn)的特殊事件 。
6.0測試標(biāo)準(zhǔn)
測試策略和預(yù)備測試用例描述 。
6.1 測試的類別
規(guī)定實(shí)施測試的類別,包括盡量詳細(xì)的描述 。這里是針對黑盒測試現(xiàn)象的描述 。
6.2期待軟件反饋
測試期待的結(jié)果描述 。
6.3執(zhí)行界線
特殊執(zhí)行需要的說明 。
6.4 重要構(gòu)件確認(rèn)
決定性構(gòu)件或者需要特殊注意的構(gòu)件的測試確認(rèn) 。
7.0附錄
設(shè)計(jì)說明的補(bǔ)充信息 。
7.1系統(tǒng)可跟蹤矩陣
一個(gè)定期回歸系統(tǒng)規(guī)格跟蹤軟件需求的矩陣 。
7.2 產(chǎn)品戰(zhàn)略
如果規(guī)格說明書是為一個(gè)產(chǎn)品設(shè)計(jì)的,描述相關(guān)的產(chǎn)品戰(zhàn)略 。
7.3 使用分析算法
描述所有分析活動(dòng)所使用到的分析算法 。
7.4 補(bǔ)充信息 (如果有需要特別說明的)
如何寫軟件設(shè)計(jì)文檔?1 引言
1.1 編寫目的
說明編寫這份詳細(xì)設(shè)計(jì)說明書的目的,指出預(yù)期的讀者范圍 。
1.2 背景
說明:
a. 待開發(fā)的軟件系統(tǒng)的名稱;
b. 列出本項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶以及將運(yùn)行該項(xiàng)軟件的單位 。
1.3 定義
列出本文件中用到的專門術(shù)語的定義和縮寫詞的原詞組 。
1.4 參考資料
列出要用到的參考資料,如:
a. 本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級機(jī)關(guān)的批文;
b. 屬于本項(xiàng)目的其他已發(fā)表的文件;
c. 本文件中各處引用的文件、資料,包括所要用到的軟件開發(fā)標(biāo)準(zhǔn) 。
列出這些文件的標(biāo)題、文件編號、發(fā)表日期和出版單位 , 說明能夠得到這些文件資料的來源 。
軟件開發(fā)文檔怎么寫這要看你的文檔是基于什么用途的銷售用途:要有產(chǎn)品白皮書,產(chǎn)品未來方向報(bào)告,使用性能報(bào)告,兼容性報(bào)告,產(chǎn)品演示文稿說明設(shè)計(jì)用途的 。產(chǎn)品功能需求文件 , 產(chǎn)品的底層設(shè)計(jì) , 產(chǎn)品詳細(xì)設(shè)計(jì)內(nèi)容 。產(chǎn)品用途的 。產(chǎn)品目錄,自訴文件,幫助文件,使用手冊,產(chǎn)品授權(quán)書 。客服用途 。已知問題列表,常見問題解答,危機(jī)處理指南,問題診斷指南 。有個(gè)模板可以看下國家標(biāo)準(zhǔn)軟件開發(fā)文檔模板GB856Thttp://www.cndzz.com/down/down.asp?id=65584&no=1
如何寫詳細(xì)設(shè)計(jì)文檔在大多數(shù)軟件項(xiàng)目中,要末不作詳細(xì)設(shè)計(jì),要么開發(fā)完成后再補(bǔ)詳細(xì)設(shè)計(jì)文檔,質(zhì)量也不容樂觀 , 文檔與系統(tǒng)往往不能同步,使詳細(xì)設(shè)計(jì)文檔完全流于形式,對工作沒有起到實(shí)際的幫助 。
·
詳細(xì)設(shè)計(jì)是相對概要設(shè)計(jì)而言的,是瀑布開發(fā)流程的一個(gè)重要環(huán)節(jié),在概要設(shè)計(jì)的高層設(shè)計(jì)的基礎(chǔ)上,從邏輯上實(shí)現(xiàn)了每一模塊的功能 , 是編碼階段的主要參考資料,是從高層到低層、逐步精化思想的具體實(shí)現(xiàn) 。
詳細(xì)設(shè)計(jì)文檔的內(nèi)容包括各個(gè)模塊的算法設(shè)計(jì) ,
接口設(shè)計(jì),
數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì),交互設(shè)計(jì)等 。必須寫清楚各個(gè)模塊/接口/公共對象的定義,列明各個(gè)模塊程序的
各種執(zhí)行條件與期望的運(yùn)行效果 , 還要正確處理各種可能的異常 。
·
在開發(fā)過程中,由需求及設(shè)計(jì)不正確、不完整所導(dǎo)致的問題是項(xiàng)目進(jìn)度拖延、失敗的一個(gè)主要因素,而軟件系統(tǒng)的一個(gè)重要特性就是需求和設(shè)計(jì)的不斷構(gòu)建和改進(jìn),在寫詳細(xì)設(shè)計(jì)文檔過程中,
詳細(xì)設(shè)計(jì)實(shí)際上是對系統(tǒng)的一次邏輯構(gòu)建,可以有效驗(yàn)證需求的完整性及正確性 。
如果不寫詳細(xì)設(shè)計(jì)文檔,一般就從概設(shè)直接進(jìn)入編碼階段,這時(shí)開發(fā)人員所能參考的資料就是需求規(guī)格說明書及頁面原型、數(shù)據(jù)庫設(shè)計(jì)等,不能直接進(jìn)行開發(fā) , 需要進(jìn)行信息的溝通,把頁面原型不能體現(xiàn)的設(shè)計(jì)講清楚,這樣既容易遺忘,也容易發(fā)生問題,詳細(xì)設(shè)計(jì)文檔可以作為需求人員、總體設(shè)計(jì)人員與開發(fā)人員的溝通工具,把靜態(tài)頁面無法體現(xiàn)的設(shè)計(jì)體現(xiàn)出來 , 包含整體設(shè)計(jì)對模塊設(shè)計(jì)的規(guī)范 , 體現(xiàn)對設(shè)計(jì)上的一些決策,例如選用的算法,對一些關(guān)鍵問題的設(shè)計(jì)考慮等等,使開發(fā)人員能快速進(jìn)入開發(fā) , 提高溝通效率,減少溝通問題 。
對于系統(tǒng)功能的調(diào)整,后期的維護(hù),詳設(shè)文檔提供了模塊設(shè)計(jì)上的考慮、決策,包括模塊與整體設(shè)計(jì)的關(guān)系、模塊所引用的數(shù)據(jù)庫設(shè)計(jì)、重要操作的處理流程、重要的業(yè)務(wù)規(guī)則實(shí)現(xiàn)設(shè)計(jì)等等信息,提供了對模塊設(shè)計(jì)的概述性信息 , 闡明了模塊設(shè)計(jì)上的決策,配合代碼注釋 , 可以相對輕松讀懂原有設(shè)計(jì) 。
·存在的問題要由專門的人寫,是比較麻煩的,也是很需要時(shí)間的,會對進(jìn)度造成壓力 , 也容易形成工作瓶頸,使設(shè)計(jì)人員負(fù)擔(dān)過重,而開發(fā)人員無事可作 。對于現(xiàn)在一般的以數(shù)據(jù)庫為中心的管理系統(tǒng)而言,這個(gè)工作始終是要作的,區(qū)別只不過是不是形成專門文檔,形成文檔可能會多花一兩周時(shí)間,但相對于規(guī)避的風(fēng)險(xiǎn)和問題來說,也是值得的,另外由于現(xiàn)在高級語言的流行,所以更詳細(xì)的設(shè)計(jì)應(yīng)該直接體現(xiàn)在代碼的設(shè)計(jì)上,而文檔則只體現(xiàn)設(shè)計(jì)上的一些決策,協(xié)調(diào)整體設(shè)計(jì)與模塊設(shè)計(jì)的關(guān)系,把頁面原型所不能體現(xiàn)的設(shè)計(jì)情況文檔化,所以所花費(fèi)的時(shí)間是有限的 。
設(shè)計(jì)內(nèi)容容易過細(xì),但設(shè)計(jì)階段是不能考慮特別清楚地,時(shí)間也不允許 。
對于這個(gè)問題,一個(gè)對策是上邊所提到的 , 文檔只體現(xiàn)設(shè)計(jì)上的決策 , 頁面原型所不能反映的信息 , 詳細(xì)設(shè)計(jì)只體現(xiàn)總體設(shè)計(jì)對模塊設(shè)計(jì)的一些考慮,例如對功能的數(shù)據(jù)庫設(shè)計(jì)等等 , 而具體的實(shí)現(xiàn)實(shí)現(xiàn),則到代碼中再去實(shí)現(xiàn),相關(guān)的設(shè)計(jì)也僅體現(xiàn)在代碼中 。
需求、設(shè)計(jì)需要不斷的被更新、構(gòu)建 , 則設(shè)計(jì)文檔需要不斷的重新調(diào)整,文檔的維護(hù)需要跟上,否則文檔和系統(tǒng)的同步就很難得到保障了,且造成多余的工作量 。文檔的內(nèi)容易流于形勢,質(zhì)量糟糕,不能成為開發(fā)人員的參考手冊 , 一是要建立起相關(guān)制度,如有修改 , 先改文檔 , 后作開發(fā),從工作流程上切實(shí)保障文檔與系統(tǒng)的同步,二是要規(guī)范文檔質(zhì)量,對文檔該寫什么,不該寫什么,標(biāo)準(zhǔn)是什么,粒度是什么,語法應(yīng)該如何組織,有明確的標(biāo)準(zhǔn)和考慮 , 同時(shí) , 建立審計(jì)文檔評審、審核制度,充分保障系統(tǒng)的使用 。·
首先是文檔的內(nèi)容 , 根據(jù)項(xiàng)目和團(tuán)隊(duì)的不同,詳細(xì)設(shè)計(jì)文檔的內(nèi)容也有所不同,一般說來,粒度不宜過細(xì),不能代替開發(fā)人員的設(shè)計(jì)和思考,但要把有關(guān)設(shè)計(jì)的決策考慮進(jìn)去,包括與其他模塊、整體設(shè)計(jì)的關(guān)系、操作的處理流程,對業(yè)務(wù)規(guī)則的設(shè)計(jì)考慮等,有一個(gè)標(biāo)準(zhǔn)為,凡是頁面原型、需求規(guī)格說明書所不能反映的設(shè)計(jì)決策,而開發(fā)人員又需要了解的 , 都要寫入文檔 。
其次是文檔所面向的讀者,主要為模塊開發(fā)人員、后期維護(hù)人員,模塊開發(fā)人員通過詳細(xì)設(shè)計(jì)文檔和頁面原型來了解所開發(fā)的功能,后期維護(hù)人員通過實(shí)際系統(tǒng)、模塊代碼、詳細(xì)設(shè)計(jì)文檔來了解一個(gè)功能 。
再有就是誰來寫文檔 , 因?yàn)槲臋n主要考慮的是設(shè)計(jì)上的決策 , 所以寫文檔的人應(yīng)該為負(fù)責(zé)、參加設(shè)計(jì)的技術(shù)經(jīng)理、資深程序員,根據(jù)團(tuán)隊(duì)情況和項(xiàng)目規(guī)模、復(fù)雜度的不同,也有所不同 。
還需要保證文檔的可讀性、準(zhǔn)確性、一致性 , 要建立嚴(yán)格的文檔模板及標(biāo)準(zhǔn),保證文檔的可讀性及準(zhǔn)確性,同時(shí)建立審核及設(shè)計(jì)評審制度,來保障設(shè)計(jì)及文檔的質(zhì)量,另外在工作流程中要強(qiáng)調(diào),要先設(shè)計(jì)、先寫文檔,再進(jìn)行開發(fā) 。
一個(gè)軟件項(xiàng)目要寫哪些文檔,又該怎樣寫簡單的列一下:
立項(xiàng)前:市場調(diào)查報(bào)告 , 項(xiàng)目計(jì)劃書
需求階段:用戶需求規(guī)格說明書,技術(shù)可行性報(bào)告,風(fēng)險(xiǎn)評估報(bào)告
設(shè)計(jì)階段:概要設(shè)計(jì)說明書,詳細(xì)設(shè)計(jì)說明書
編碼階段:編碼規(guī)范
測試階段:測試計(jì)劃 測試分析報(bào)告
發(fā)布階段:項(xiàng)目開發(fā)總結(jié)報(bào)告 用戶手冊
軟件工程課程設(shè)計(jì)的項(xiàng)目文檔怎么寫?東西發(fā)給你了,可以給我分了 。
怎么寫項(xiàng)目開發(fā)的文檔?軟件開發(fā)中文檔的編寫是一個(gè)不可缺少的環(huán)節(jié),常見的如《需求分析》、《概要分析》、《數(shù)據(jù)庫設(shè)計(jì)》等 。在“軟件人”的陣營里向來存在兩種觀點(diǎn),注重文檔還是關(guān)心代碼 。我這里寫一個(gè)《用戶信息模塊的概要設(shè)計(jì)文檔》,只列舉主要內(nèi)容了1.功能描述:用于完成系統(tǒng)用戶信息的新增、刪除、修改、查詢;2.功能用例:一個(gè)主用例用戶信息,附加新增、刪除、修改、查詢4個(gè)子用例,操作人員為管理員,圖形就不畫了,很簡單的;3.業(yè)務(wù)流程:查詢有效范圍用戶信息——》新增用戶信息——》判斷當(dāng)前帳號是否存在——》存在給出提示,反之保存成功提示 。4.約束限制:超級管理員可操作所有(包含刪除,我這里考慮僅是邏輯刪除、非物理刪除)的用戶信息;系統(tǒng)管理員可操作除系統(tǒng)管理員、超級管理員外的全部用戶信息;單位管理員可操作本單位用戶信息;用戶帳號信息系統(tǒng)內(nèi)全局唯一;5.系統(tǒng)性能:要求同時(shí)支持500個(gè)并發(fā)操作;頁面操作響應(yīng)時(shí)間小于1s;頁面大小小于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)說明,這里僅需要注明符合系統(tǒng)架構(gòu)異常處理方式即可 。9.外部接口:輸入—用戶ID,輸出—用戶信息;10.其他說明:用戶帳號必須定義為字母開頭 , 數(shù)字與字母組合 , 并保證全局唯一;用戶密碼采用md5算法加密,系統(tǒng)架構(gòu)已提供相關(guān)接口 。11.注意事項(xiàng):用戶帳號不能為空,不能存在空格,不能超過6位;超級用戶信息僅在系統(tǒng)初始化中完成其信息寫入操作 , 其他用戶無權(quán)對其進(jìn)行修改 。項(xiàng)目組中也不是所有人都必須參與文檔的編寫,通常業(yè)務(wù)需求人員、設(shè)計(jì)人員、架構(gòu)師、項(xiàng)目經(jīng)理、小組長占大多數(shù),而且這些人中很多也不是專注于寫代碼的角色 。
軟件設(shè)計(jì)文檔都包括哪幾部分?一、概論1、編寫目的2、編寫背景3、對系統(tǒng)的大致描述
二、業(yè)務(wù)概述和邏輯設(shè)計(jì)1、對系統(tǒng)幾大主體的描述2、對系統(tǒng)幾大業(yè)務(wù)流程描述3、用UML對其進(jìn)行總體描述
三、技術(shù)架構(gòu)在此章決定使用那種技術(shù)體系,具體的技術(shù)有那些,描述他們之間是怎么協(xié)同運(yùn)作的 。
四、功能模塊設(shè)計(jì)描述系統(tǒng)有那些主要功能,這些功能應(yīng)該用何種技術(shù) , 大致是如何實(shí)現(xiàn)的,
五、接口設(shè)計(jì)
六、應(yīng)急系統(tǒng)設(shè)計(jì)
七、安全設(shè)計(jì)描述系統(tǒng)應(yīng)該具有的安全級別 , 以及達(dá)到此安全等級的所采用的技術(shù)措施
八、運(yùn)行環(huán)境設(shè)計(jì)從硬件網(wǎng)絡(luò)方面描述概要設(shè)計(jì)的目的就是希望一個(gè)從來沒有接觸過的人一看就能從各個(gè)方面都對系統(tǒng)的作用,功能,實(shí)現(xiàn)方面有一個(gè)大概了解 , 并為以后的各類詳細(xì)設(shè)計(jì)文檔提供一個(gè)指引和方向 。
軟件詳細(xì)設(shè)計(jì)包含哪些內(nèi)容??目錄1基本內(nèi)容基本內(nèi)容詳細(xì)設(shè)計(jì)詳細(xì)設(shè)計(jì)的主要任務(wù)是設(shè)計(jì)每個(gè)模塊的實(shí)現(xiàn)算法、所需的局部數(shù)據(jù)結(jié)構(gòu) 。詳細(xì)設(shè)計(jì)的目標(biāo)有兩個(gè):實(shí)現(xiàn)模塊功能的算法要邏輯上正確和算法描述要簡明易懂 。主要任務(wù):1.為每個(gè)模塊確定采用的算法,選擇某種適當(dāng)?shù)墓ぞ弑磉_(dá)算法的過程 , 寫出模塊的詳細(xì)過程性描述;2.確定每一模塊使用的數(shù)據(jù)結(jié)構(gòu);3.確定模塊接口的細(xì)節(jié),包括對系統(tǒng)外部的接口和用戶界面,對系統(tǒng)內(nèi)部模塊的接口,以及模塊輸入數(shù)據(jù)、輸出數(shù)據(jù)及局部數(shù)據(jù)的全部細(xì)節(jié) 。在詳細(xì)設(shè)計(jì)結(jié)束時(shí),應(yīng)該把上述結(jié)果寫入詳細(xì)設(shè)計(jì)說明書,并且通過復(fù)審形成正式文檔 。交付給下一階段(編碼階段)的工作依據(jù) 。4.要為每一個(gè)模塊設(shè)計(jì)出一組測試用例,以便在編碼階段對模塊代碼(即程序)進(jìn)行預(yù)定的測試 , 模塊的測試用例是軟件測試計(jì)劃的重要組成部分 , 通常應(yīng)包括輸入數(shù)據(jù),期望輸出等內(nèi)容 。詳細(xì)設(shè)計(jì)的工具:1.圖形工具利用圖形工具可以把過程的細(xì)節(jié)用圖形描述出來 。2.表格工具可以用一張表來描述過程的細(xì)節(jié),在這張表中列出了各種可能的操作和相應(yīng)的條件 。用某種高級語言(稱之為偽碼)來描述過程的細(xì)節(jié) 。
在軟件開發(fā)過程中 , 詳細(xì)設(shè)計(jì)(LLD)、概要設(shè)計(jì)(HLD)、需求規(guī)格說明書(SRS)三個(gè)文檔所描述的內(nèi)容 。軟件開發(fā)過程:立項(xiàng)、需求分析、概要設(shè)計(jì)、詳細(xì)設(shè)計(jì)、編碼、測試、運(yùn)行及維護(hù);
單元測試 參照 詳細(xì)設(shè)計(jì)說明說(LLD)
集成測試 參照 概要設(shè)計(jì)說明書(HLD)
系統(tǒng)測試 參照 需求規(guī)格說明說(SRS)
需求規(guī)格說明書 是為使用用戶和軟件開發(fā)者雙方對該軟件的初始規(guī)定有一個(gè)共同的理解,使之成為整個(gè)開發(fā)工作的基礎(chǔ) 。
概要設(shè)計(jì) 就是設(shè)計(jì)軟件的結(jié)構(gòu),包括組成模塊 , 模塊的層次結(jié)構(gòu),模塊的調(diào)用關(guān)系,每個(gè)模塊的功能等等 。
詳細(xì)設(shè)計(jì) 就是為每個(gè)模塊完成的功能進(jìn)行具體的描述,要把功能描述轉(zhuǎn)變?yōu)榫_的、結(jié)構(gòu)化的過程描述 。
軟件開發(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ì)文檔可以使交接過程變得簡單,否則先前的設(shè)計(jì)可能會白做了在管理層面,項(xiàng)目負(fù)責(zé)人需要詳細(xì)的文檔 , 以便總結(jié)開發(fā)設(shè)計(jì)過程,使設(shè)計(jì)完整綜上所述,除非微小項(xiàng)目,一般都需要詳細(xì)的設(shè)計(jì)文檔,尤其是團(tuán)隊(duì)軟件開發(fā)場合更是必須
軟件開發(fā)的技術(shù)實(shí)現(xiàn)文檔要怎么寫很多額,比如1 。開發(fā)背景2.可行性分析3.硬件環(huán)境4.概要設(shè)計(jì)5.詳細(xì)設(shè)計(jì)6.數(shù)據(jù)庫設(shè)計(jì)7.測試報(bào)告等
怎么寫項(xiàng)目開發(fā)的文檔?1.1.1 項(xiàng)目名稱
項(xiàng)目名稱(項(xiàng)目類型)
1.1.2 項(xiàng)目開發(fā)者
成員一:**
成員二:***
成員三:***
1.1.3 項(xiàng)目開發(fā)環(huán)境
MyEclipse + Tomcat5.5和MyEclipse(自帶)+ SQLServer 2005
1.1.4 系統(tǒng)功能設(shè)定
品紅商業(yè)網(wǎng)分為2大模塊:
1.前臺系統(tǒng)
## 設(shè)定新聞,商品以及購物相關(guān)功能:
NEWS:對新聞的增加、刪除和查詢操作,并且增加上下條功能進(jìn)行查詢,以及最新新聞的顯示與增加 。
PRODUCT:對商品的增加、刪除、修改和查詢操作,并且增加分頁技術(shù)進(jìn)行查詢 , 以及最新商品的展示與增加;增設(shè)對商品的選購,打印清單、結(jié)算功能 。
TALKING:用戶之間的在線聊天,進(jìn)行互動(dòng)交流,洽談業(yè)務(wù),對信息發(fā)表自己的看法等,并設(shè)有廣告介紹,讓用戶了解最新信息 。
MESSAGE:客戶留言?。攵愿髦稚糖?,業(yè)務(wù)交流進(jìn)行離線留言,站外,站內(nèi)用戶可以通過此信息及時(shí)了解最新資訊,了解用戶反饋信息等 。
ABOUT:介紹了公司對客戶的信心 , 誠意做出了誠懇的表態(tài) 。
AFTER:介紹了公司關(guān)于商品的售后服務(wù)條例等,給客戶提供更滿意的服務(wù) 。
COPYRIGHT:介紹了公司的版權(quán)信息,以及法律授權(quán)及其相關(guān) 。
2.后臺管理系統(tǒng)
## 設(shè)定對管理員,用戶以及管理員對新聞和商品信息的相關(guān)操作 。
ADMIN:對用戶的查詢和刪除 , 對新聞的增加,刪除和查詢,對商品的增加、刪除、修改和查詢,都增設(shè)了分頁技術(shù)更有規(guī)范的查詢 。并附有時(shí)間,讓操作人員在任何時(shí)候都能得到精準(zhǔn)時(shí)間 , 以提高管理員的時(shí)間觀念 。
1.1.5 項(xiàng)目開發(fā)技術(shù)
JSP + JavaScript + HTML
1.1.6 設(shè)計(jì)思路
通過相關(guān)技術(shù),一一實(shí)現(xiàn)對管理員,站外,站內(nèi)用戶,公司新聞信息,商品信息進(jìn)行實(shí)用的操作 。
1.1.7 項(xiàng)目背景
本著為客戶提供最優(yōu)質(zhì)的服務(wù),項(xiàng)目從多角度考慮需求,以求達(dá)到客戶所需要的功能,實(shí)現(xiàn)零距離的操作 。
1.1.8 主要模塊講解
1.1.8.1 模塊一
1. 名稱:管理員模塊
2. 簡介:管理員的登錄,對相應(yīng)信息操作
實(shí)現(xiàn)了管理員對用戶,管理員的操作:
1. 對用戶的查詢,刪除(必要的刪除),使用分頁技術(shù)給管理員更好的視覺效果 。
2. 添加管理員使用了MD5加密技術(shù),登錄及相關(guān)操作時(shí)的各種精密驗(yàn)證 , 達(dá)到更高的保密性,安全性 。
1.1.8.2 模塊二
1. 名稱:新聞模塊
2. 簡介:新聞?wù)故?nbsp;, 更新,增加和刪除
1.對新聞的查詢和刪除,使用分頁技術(shù)給管理員提供更好的操作性能
1.1.8.3 模塊三
1. 名稱:商品模塊
2. 簡介:商品展示,更新,增加和刪除
1. 對商品的查詢、刪除、增加和更新 , 分別使用分頁技術(shù)給管理員提供更好的操作
1.1.8.4 模塊四
1. 名稱:用戶模塊
2. 簡介:可以進(jìn)行授權(quán)的操作,登錄在線聊天進(jìn)行交流,登錄購物臺進(jìn)行?。?購 。
1.1.8.5 模塊五
1. 名稱:論壇模塊
2. 簡介:可以查看所有的論壇信息,并進(jìn)行篩選,刪除不健康、不文明留言
求1份軟件設(shè)計(jì)文檔的樣文(最好關(guān)于財(cái)務(wù)管理軟件)做了這么多年的軟件開發(fā)工作,從一個(gè)純碎的軟件編碼人員,到現(xiàn)在的掛上一個(gè)項(xiàng)目經(jīng)理的名頭,擔(dān)負(fù)起一些系統(tǒng)設(shè)計(jì)及項(xiàng)目管理方面的工作 , 我一直覺得軟件設(shè)計(jì)文檔這方面是我的最大軟肋,在這方面也花了好些精力去探索它,總希望能夠找到一種適合自己的軟件設(shè)計(jì)文檔編寫方法,但一直都沒有找到,也曾嘗試著去套一些國標(biāo)之類的文檔模板,但總是感覺設(shè)計(jì)思想是有,但寫起文檔來卻力不從心,沒辦法將系統(tǒng)及子模塊設(shè)計(jì)思想真實(shí)的反映到文檔上 , 也經(jīng)常是事后修修補(bǔ)補(bǔ)還是不盡如人意,以前總聽人說,如果你能夠?qū)⒛闼磉_(dá)的事物清楚的傳遞給別人,那就說明你對這個(gè)事物有真正足夠的了解了,看來我的真正的軟肋不是在設(shè)計(jì)文檔 , 而是我的系統(tǒng)設(shè)計(jì)能夠還十分欠缺,以致于我沒辦法將自己的設(shè)計(jì)思想用文字表達(dá)清楚吧 。
當(dāng)然,在這些探索過程中,也不是完全沒有收獲,基本上,還是搞清了一些文檔編寫的基本原則,真著今日在家中偷閑 , 將這點(diǎn)積累總結(jié)一下,省得明天又給忘了,呵 。
在學(xué)寫文檔初期,我總想去套一些國標(biāo)的文檔模板,套了半天,經(jīng)常發(fā)現(xiàn)寫出來的文檔,連我自己都沒有看懂,因此 , 也總結(jié)出來一條基本道理:生搬硬套某些文檔模板,機(jī)械式的對文檔模板進(jìn)行填表的操作并不能夠得到系統(tǒng)所真正需要的設(shè)計(jì)文檔 。
編寫設(shè)計(jì)文檔會起到兩個(gè)作用:
一,在編寫設(shè)計(jì)文檔的過程中對系統(tǒng)進(jìn)行一個(gè)全面思考的過程,由于設(shè)計(jì)文檔也由需求分析,系統(tǒng)設(shè)計(jì),詳細(xì)設(shè)計(jì)這樣逐層深入的設(shè)計(jì)的過程,因此這有助于系統(tǒng)設(shè)計(jì)者站在各個(gè)不同角度來思考系統(tǒng) , 十分有助于全面深入整理整套系統(tǒng)以及發(fā)現(xiàn)一些潛在問題 , 這是系統(tǒng)開發(fā)的一個(gè)十分重要的過程 。
二,我們都知道,現(xiàn)在在企業(yè)里開發(fā)軟件,一般都不會是一個(gè)人從頭到尾進(jìn)行開發(fā),多數(shù)系統(tǒng)都是有一個(gè)團(tuán)隊(duì)進(jìn)行設(shè)計(jì)開發(fā),這個(gè)時(shí)候,設(shè)計(jì)文檔就起到了一個(gè)十分重要的信息傳遞溝通的作用,而且在系統(tǒng)開發(fā)完成,交付使用后,后期也會有很多的維護(hù)工作,這個(gè)時(shí)候,文檔就更顯其作用了 。
基于以上兩個(gè)作用 , 我覺得編寫文檔要了解以下幾點(diǎn):
一,我們了解我們所要寫的是什么文檔,它的作用是什么,它應(yīng)該包含的內(nèi)容都有哪一些 , 這是寫文檔的基本前提 。
二,編寫文檔一定不能是應(yīng)付式的 , 一定要認(rèn)真的思考,否則 , 你就失去這個(gè)良好的思考過程 。
三,文檔是為了表達(dá)信息,不是為了符合某種標(biāo)準(zhǔn) , 所以 , 不要過于遷強(qiáng)去適應(yīng)某種標(biāo)準(zhǔn) , 但是,如果既能符種一些通用的文檔規(guī)范,又能將信息表達(dá)清楚 , 那當(dāng)然更好了 。
三 , 文檔的格式應(yīng)該清晰明了 , 要讓人一看目錄大綱 , 就對文檔整體分布了然于胸,
四,內(nèi)容表達(dá)重在清楚,關(guān)鍵是要將設(shè)計(jì)思想表達(dá)出來 , 不在寫太多冗余性的文字,盡可能配上一些圖形來表達(dá)思想 , 因?yàn)椋藢D像信息的吸收比文字來得快 。
所謂磨刀不誤砍柴工,寫文檔就是一個(gè)磨刀的過程,刀是砍柴的工具,同樣,設(shè)計(jì)文檔也是軟件系統(tǒng)設(shè)計(jì)的一個(gè)基本工具,古人不是也有過精辟的結(jié)論嘛:“工欲善其事,必先利于器”,我們在系統(tǒng)開發(fā)前期,將這些工作完善了,那么系統(tǒng)開發(fā)起來就會更加順利,項(xiàng)目的成功率也就更高 , 后期維護(hù)也會更輕松,因此,設(shè)計(jì)文檔同時(shí)也是一種功能當(dāng)代 , 利在千秋的工作,一定要注意做好 。
求軟件工程設(shè)計(jì)文檔范例dsf
求!HR軟件開發(fā)文檔~~~~軟件開發(fā)模式有哪些?快速原型模型:(需要迅速造一個(gè)可以運(yùn)行的軟件原型,以便理解和澄清問題)快速原型模型允許在需求分析階段對軟件的需求進(jìn)行初步的非完全的分析和定義,快速設(shè)計(jì)開發(fā)出軟件系統(tǒng)的原型(展示待開發(fā)軟件的全部或部分功能和性能(過程:用戶對該原型進(jìn)行測試評定,給出具體改善的意見以及豐富的細(xì)化軟件需求,開發(fā)人員進(jìn)行修改完善)優(yōu)點(diǎn):克服瀑布模型的缺點(diǎn) , 減少由于軟件需求不明確帶來的開發(fā)風(fēng)險(xiǎn)缺點(diǎn):A、 所選用的開發(fā)技術(shù)和工具不一定符合主流的發(fā)展B、 快速建立起來的系統(tǒng)加上連續(xù)的修改可能會造成 產(chǎn)品質(zhì)量底下增量模型:(采用隨著日程時(shí)間的進(jìn)展而交錯(cuò)的線性序列,每一個(gè)線性徐磊產(chǎn)生軟件的一個(gè)可發(fā)布的“增量”,第一個(gè)增量往往就是核心的產(chǎn)品)與其他模型共同之處:它與原型實(shí)現(xiàn)模型和其他演化方法一樣 , 本質(zhì)都是迭代與原型實(shí)現(xiàn)模型不同之處:它強(qiáng)調(diào)每一個(gè)增量均發(fā)布一個(gè)可操作產(chǎn)品,(它不需要等到所有需求都出來,只要摸個(gè)需求的增量包出來即可進(jìn)行開發(fā))優(yōu)點(diǎn):1、 人員分配靈活,一開始不需要投入大量人力資源2、 當(dāng)配備人員不能在限定的時(shí)間內(nèi)完成產(chǎn)品時(shí),它可以提供一種先推出核心產(chǎn)品的途徑,可現(xiàn)發(fā)布部分功能給用戶(對用戶起鎮(zhèn)靜作用)3、 增量能夠有計(jì)劃的管理技術(shù)風(fēng)險(xiǎn)缺點(diǎn):1、 如果增量包之間存在相交的情況且未很好處理,則必須做全盤系統(tǒng)分析注:這種模型將功能細(xì)化后分別開發(fā)的方法較適應(yīng)于需求經(jīng)常改變的軟件開發(fā)過程原型模型:(樣品模型,采用逐步求精的方法完善原型)主要思想:先借用已有系統(tǒng)作為原型模型,通過“樣品”不斷改進(jìn),使得最后的產(chǎn)品就是用戶所需要的 。原型模型通過向用戶提供原型獲取用戶的反?。?使開發(fā)出的軟件能夠真正反映用戶的需求 , 采用方法:原型模型采用逐步求精的方法完善原型,使得原型能夠“快速”開發(fā),避免了像瀑布模型一樣在冗長的開發(fā)過程中難以對用戶的反饋?zhàn)鞒隹焖俚捻憫?yīng)優(yōu)點(diǎn):(1)開發(fā)人員和用戶在“原型”上達(dá)成一致 。這樣一來,可以減少設(shè)計(jì)中的錯(cuò)誤和開發(fā)中的風(fēng)險(xiǎn),也減少了對用戶培訓(xùn)的時(shí)間,而提高了系統(tǒng)的實(shí)用、正確性以及用戶的滿意程度 。(2)縮短了開發(fā)周期 , 加快了工程進(jìn)度 。(3)降低成本 。缺點(diǎn):1、當(dāng)重新生產(chǎn)該產(chǎn)品時(shí) , 難以讓用戶接收,給工程繼續(xù)開展帶來不利因素 。2、不宜利用原型系統(tǒng)作為最終產(chǎn)品 。采用原型模型開發(fā)系統(tǒng),用戶和開發(fā)者必須達(dá)成一致: 噴泉模型:(以用戶需求為動(dòng)力,以對象為驅(qū)動(dòng)的模型 , 主要用于采用對象技術(shù)的軟件開發(fā)項(xiàng)目)它認(rèn)為軟件開發(fā)過程自下而上周期的各階段是相互迭代和無間隙的特性相互迭代:軟件的摸個(gè)部分常常被重復(fù)工作多次,相關(guān)對象在每次迭代中隨之加入漸進(jìn)的軟件成分無間隙:它在各項(xiàng)活動(dòng)之間沒有明顯邊界(如分析和設(shè)計(jì)活動(dòng)之間)優(yōu)點(diǎn):1、 可以提高軟件項(xiàng)目開發(fā)效率,節(jié)省開發(fā)時(shí)間,適應(yīng)于面向?qū)ο蟮能浖_發(fā)過程不便之處:1、由于噴泉模型在各個(gè)開發(fā)階段是重疊的,因此在開發(fā)過程中需要大量的開發(fā)人員,因此不利于項(xiàng)目的管理 。2、這種模型要求嚴(yán)格管理文檔,使得審核的難度加大,尤其是面對可能隨時(shí)加入各種信息、需求與資料的情況螺旋模型:(適合用于需求經(jīng)常變化的項(xiàng)目)它主要是風(fēng)險(xiǎn)分析與評估,沿著螺線進(jìn)行若干次迭代,過程:1、 制定計(jì)劃:確定軟件目標(biāo),選定實(shí)施方案,弄清項(xiàng)目開發(fā)的限制條件2、 風(fēng)險(xiǎn)分析:分析評估所選方案,考慮如何識別和消除風(fēng)險(xiǎn)3、 實(shí)施工程:實(shí)施軟件開發(fā)和驗(yàn)證;4、 客戶評估:評價(jià)開發(fā)工作,提出修正建議,制定下一步計(jì)劃 。優(yōu)點(diǎn):1、 它由風(fēng)險(xiǎn)驅(qū)動(dòng),強(qiáng)調(diào)可選方案和約束條件從而支持軟件的重用,有助于將軟件質(zhì)量作為特殊目標(biāo)融入產(chǎn)品開發(fā)中缺點(diǎn):1、 難以讓用戶確信這種煙花方法的結(jié)果是可以控制的2、 建設(shè)周期長(而軟件技術(shù)發(fā)展比較快,所以經(jīng)常會出現(xiàn)軟件開發(fā)完畢后 , 和當(dāng)前的技術(shù)水平有很大的差距,無法滿足當(dāng)前用戶的需求)3、 除非軟件開發(fā)人員擅長尋找可能的風(fēng)險(xiǎn),準(zhǔn)確的分析風(fēng)險(xiǎn) , 否則將會帶來更大的風(fēng)險(xiǎn)瀑布模型:(從本質(zhì)來講,瀑布模型是一個(gè)軟件開發(fā)架構(gòu),重復(fù)應(yīng)用)(核心思想:按工序?qū)栴}化簡 , 將功能的實(shí)現(xiàn)與設(shè)計(jì)分開,便于分工協(xié)作,采用結(jié)構(gòu)化的分析與設(shè)計(jì)方法將邏輯實(shí)現(xiàn)與物理實(shí)現(xiàn)分開 , 依照軟件生命周期自上而下,相互銜接的次序)缺點(diǎn):1、 在項(xiàng)目各個(gè)階段之間極少有反?。鞲黿錐蔚幕滯耆潭?,階段之間產(chǎn)生大量的文檔,增加了工作量2、 用戶只有在項(xiàng)目生命周期的后期才能看到結(jié)果 , 增加了開發(fā)的風(fēng)險(xiǎn)3、 需要過多的強(qiáng)制完成日期和里程碑來跟蹤各個(gè)項(xiàng)目的階段4、 在每個(gè)階段都會產(chǎn)生循環(huán)反?。ㄈ綣行畔⑽幢桓哺腔蚴欠⑾治侍飭耍?必須返回到上一個(gè)階段并進(jìn)行適當(dāng)?shù)男薷?只有當(dāng)上一階段都被確認(rèn)后才進(jìn)行下一階段)5、 早期的錯(cuò)誤可能要等到開發(fā)后期的測試階段才能發(fā)現(xiàn),進(jìn)而帶來嚴(yán)重的后果優(yōu)點(diǎn):1、 為項(xiàng)目提供了按階段分的檢查點(diǎn)2、 當(dāng)完成一個(gè)階段后 , 只需要去關(guān)注后續(xù)階段3、 可在迭代模型中應(yīng)用瀑布模型按照瀑布模型的階段劃分,軟件測試可以分為單元測試,集成測試,系統(tǒng)測試注:由于每個(gè)階段都會產(chǎn)生循環(huán)反饋 , 對于經(jīng)常變化的項(xiàng)目而言,瀑布模型毫無價(jià)值,這種模型的線性過程太理想化,已不適合現(xiàn)代的軟件開發(fā)模式
軟件開發(fā)需要準(zhǔn)備哪些文檔?模塊開發(fā)卷宗(GB8567——88)
1標(biāo)題
軟件系統(tǒng)名稱和標(biāo)識符
模塊名稱和標(biāo)識符(如果本卷宗包含多于一個(gè)的模塊,則用這組模塊的功能標(biāo)識代替模塊名)
程序編制員簽名
卷宗的修改文本序號
修改完成日期
卷宗序號(說明本卷宗在整個(gè)卷宗中的序號)
編排日期(說明整個(gè)卷宗最近的一次編排日期)
2模塊開發(fā)情況表
3功能說明
扼要說明本模塊(或本組模塊)的功能,主要是輸入、要求的處理、輸出 。可以從系統(tǒng)設(shè)計(jì)說明書中摘錄 。同時(shí)列出在軟件需求說明書中對這些功能的說明的章、條、款 。
4設(shè)計(jì)說明
說明本模塊(或本組模塊)的設(shè)計(jì)考慮,包括:
a. 在系統(tǒng)設(shè)計(jì)說明書中有關(guān)對本模塊(或本組模塊)設(shè)計(jì)考慮的敘述,包括本模塊在軟件系統(tǒng)中所處的層次 , 它同其他模塊的接口;
b. 在程序設(shè)計(jì)說明書中有關(guān)對本模塊(或本組模塊)的設(shè)計(jì)考慮,包括本模塊的算法、處理流程、牽涉到的數(shù)據(jù)文卷設(shè)計(jì)限制、驅(qū)動(dòng)方式和出錯(cuò)信息等;
c. 在編制目前已通過全部測試的源代碼時(shí)實(shí)際使用的設(shè)計(jì)考慮 。
5原代碼清單
要給出所產(chǎn)生的本模塊(或本組模塊)的第一份無語法錯(cuò)的源代碼清單以及已通過全部測試的當(dāng)前有效的源代碼清單 。
6測試說明
說明直接要經(jīng)過本模塊(或本組模塊)的每一項(xiàng)測試,包括這些測試各自的標(biāo)識符和編號、進(jìn)行這些測試的目的、所用的配置和輸入、預(yù)期的輸出及實(shí)際的輸出 。
7復(fù)審的結(jié)論
把實(shí)際測試的結(jié)果,同軟件需求說明書、系統(tǒng)設(shè)計(jì)說明書、程序設(shè)計(jì)說明書中規(guī)定的要求進(jìn)行比較和給出結(jié)論 。
軟件開發(fā)項(xiàng)目中,過程管理文檔包括哪些在軟件項(xiàng)目開發(fā)過程中,應(yīng)該按軟件開發(fā)要求撰寫十三類文檔,文檔編制要求具有針對性、精確性、清晰性、完整性、靈活性、可追溯性!
需求階段
1、可行性分析報(bào)告
說明該軟件開發(fā)項(xiàng)目的實(shí)現(xiàn)在技術(shù)上、經(jīng)濟(jì)上和社會因素上的可行性,評述為了合理地達(dá)到開發(fā)目標(biāo)可供選擇的各種可能實(shí)施方案,說明并論證所選定實(shí)施方案的理由 。
2、項(xiàng)目開發(fā)計(jì)劃
為軟件項(xiàng)目實(shí)施方案制訂出具體計(jì)劃,應(yīng)該包括各部分工作的負(fù)責(zé)人員、開發(fā)的進(jìn)度、開發(fā)經(jīng)費(fèi)的預(yù)算、所需的硬件及軟件資源等 。
3、軟件需求說明書(軟件規(guī)格說明書)
對所開發(fā)軟件的功能、性能、用戶界面及運(yùn)行環(huán)境等作出詳細(xì)的說明 。它是在用戶與開發(fā)人員雙方對軟件需求取得共同理解并達(dá)成協(xié)議的條件下編寫的 , 也是實(shí)施開發(fā)工作的基礎(chǔ) 。該說明書應(yīng)給出數(shù)據(jù)邏輯和數(shù)據(jù)采集的各項(xiàng)要求,為生成和維護(hù)系統(tǒng)數(shù)據(jù)文件做好準(zhǔn)備 。
設(shè)計(jì)階段
4、概要設(shè)計(jì)說明書
該說明書是概要實(shí)際階段的工作成果,它應(yīng)說明功能分配、模塊劃分、程序的總體結(jié)構(gòu)、輸入輸出以及接口設(shè)計(jì)、運(yùn)行設(shè)計(jì)、數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì)和出錯(cuò)處理設(shè)計(jì)等,為詳細(xì)設(shè)計(jì)提供基礎(chǔ) 。
5、詳細(xì)設(shè)計(jì)說明書
著重描述每一模塊是怎樣實(shí)現(xiàn)的,包括實(shí)現(xiàn)算法、邏輯流程等 。
開發(fā)階段
6、開發(fā)進(jìn)度月報(bào)
該月報(bào)系軟件人員按月向管理部門提交的項(xiàng)目進(jìn)展情況報(bào)告,報(bào)告應(yīng)包括進(jìn)度計(jì)劃與實(shí)際執(zhí)行情況的比較、階段成果、遇到的問題和解決的辦法以及下個(gè)月的打算等 。
測試階段
7、測試計(jì)劃
為做好集成測試和驗(yàn)收測試,需為如何組織測試制訂實(shí)施計(jì)劃 。計(jì)劃應(yīng)包括測試的內(nèi)容、進(jìn)度、條件、人員、測試用例的選取原則、測試結(jié)果允許的偏差范圍等 。
8、測試分析報(bào)告
測試工作完成以后,應(yīng)提交測試計(jì)劃執(zhí)行情況的說明 , 對測試結(jié)果加以分析 , 并提出測試的結(jié)論意見 。
收尾階段
9、用戶操作手冊
本手冊詳細(xì)描述軟件的功能、性能和用戶界面,使用戶對如何使用該軟件得到具體的了解,為操作人員提供該軟件各種運(yùn)行情況的有關(guān)知識,特別是操作方法的具體細(xì)節(jié) 。
10、項(xiàng)目開發(fā)總結(jié)報(bào)告
軟件項(xiàng)目開發(fā)完成以后,應(yīng)與項(xiàng)目實(shí)施計(jì)劃對照,總結(jié)實(shí)際執(zhí)行的情況,如進(jìn)度、成果、資源利用、成本和投入的人力,此外,還需對開發(fā)工作做出評價(jià),總結(jié)出經(jīng)驗(yàn)和教訓(xùn) 。
11、軟件維護(hù)手冊
主要包括軟件系統(tǒng)說明、程序模塊說明、操作環(huán)境、支持軟件的說明、維護(hù)過程的說明,便于軟件的維護(hù) 。
維護(hù)階段
12、軟件問題報(bào)告
指出軟件問題的登記情況,如日期、發(fā)現(xiàn)人、狀態(tài)、問題所屬模塊等,為軟
件修改提供準(zhǔn)備文檔 。
13、軟件修改報(bào)告
軟件產(chǎn)品投入運(yùn)行以后,發(fā)現(xiàn)了需對其進(jìn)行修正、更改等問題,應(yīng)將存在的問題、修改的考慮以及修改的影響作出詳細(xì)的描述,提交審批 。
軟件開發(fā)過程中需要寫的文檔?http://wenku.baidu.com/view/8f2422d33186bceb19e8bbe2.html
根據(jù)你的問題 , 給你找了一份關(guān)于軟件開發(fā)過程中所涉及到的文檔,
更多軟件開發(fā)知識,軟件定制服務(wù),可以到麥軟軟件了解
什么是軟件開發(fā)文檔開發(fā)文檔也就相當(dāng)于是做開發(fā)前的前期準(zhǔn)備,包括對客戶需求的理解、數(shù)據(jù)分析、操作流程圖、頁面設(shè)計(jì)等
軟件開發(fā)文檔說明(又全又詳細(xì))在軟件行業(yè)有一句話:一個(gè)軟件能否順利的完成并且功能是否完善 , 重要是看這個(gè)軟件有多少文檔,軟件開發(fā)文檔是一個(gè)軟件的支柱,如果你的開發(fā)文檔漏洞百出,那么你所開發(fā)出來的軟件也不可能會好;開發(fā)文檔的好壞可以直接影響到所開發(fā)出來軟件的成功與否 。
一、軟件開發(fā)設(shè)計(jì)文檔:軟件開發(fā)文檔包括軟件需求說明書、數(shù)據(jù)要求說有書、概要設(shè)計(jì)說明書、詳細(xì)設(shè)計(jì)說明書 。
1.軟件需求說明書:也稱為軟件規(guī)格說明 。該說明書對所開發(fā)軟件的功能、性能、用戶 界面及運(yùn)行環(huán)境等做出詳細(xì)的說明 。它是用戶與開發(fā)人員雙方對軟件需求取得共同理 解基礎(chǔ)上達(dá)成的協(xié)議,也是實(shí)施開發(fā)工作的基礎(chǔ) 。軟件需求說明書的編制目的的就是 為了使用戶和軟件開發(fā)者雙方對該軟件的初始規(guī)定有一個(gè)共同的理解、并使之面成為 整個(gè)開發(fā)工作的基礎(chǔ) 。
其格式要求如下:
1 引言 1.1 編寫目的 。1.2 背景 1.3 定義
2 任務(wù)概述 2.1 目標(biāo) 2.2 用戶的特點(diǎn) 2.3 假定和約束
3 需求規(guī)定 3.1 對功能的規(guī)定 3.2 對性能的規(guī)定 3.2.1 精度 3.2.2 時(shí)間特性的需求 3.2.3 靈活性 3.3 輸入輸出要求 3.4 數(shù)據(jù)管理能力要求 3.5 故障處理要求 3.6 其他專門要求
4 運(yùn)行環(huán)境規(guī)定 4.1 設(shè)備 4.2 支持軟件 4.3 接口 4.4 控制
2.概要設(shè)計(jì)說明書:3 接口設(shè)計(jì) 3.1 用戶接口 3.2 外部接口 3. 。3 內(nèi)部接口4 所建議的系統(tǒng) 4.1 對所建議系統(tǒng)的說明 4.2 處理流程和數(shù)據(jù)流程 4.3 改進(jìn)之處 4.4 影響 4.4.1 結(jié)
軟件開發(fā)文檔范例-詳細(xì)設(shè)計(jì)說明書1
《五.詳細(xì)設(shè)計(jì)說明書》
1、引言:
1、1編寫目的:
在前一階段(概要設(shè)計(jì)說明書)中,已解決了實(shí)現(xiàn)該系統(tǒng)需求的程序模塊設(shè)計(jì)問題 。包括如何把該系統(tǒng)劃分成若干個(gè)模塊、決定各個(gè)模塊之間的接口、模塊之間傳遞的信息,以及數(shù)據(jù)結(jié)構(gòu)、模塊結(jié)構(gòu)的設(shè)計(jì)等 。在以下的詳細(xì)設(shè)計(jì)報(bào)告中將對在本階段中對系統(tǒng)所做的所有詳細(xì)設(shè)計(jì)進(jìn)行說明 。在本階段中,確定應(yīng)該如何具體地實(shí)現(xiàn)所要求的系統(tǒng) , 從而在編碼階段可以把這個(gè)描述直接翻譯成用具體的程序語言書寫的程序 。主要的工作有:根據(jù)在《需求分析說明書》中所描述的數(shù)據(jù)、功能、運(yùn)行、性能需求 , 并依照《概要設(shè)計(jì)說明書》所確定的處理流程、總體結(jié)構(gòu)和模塊外部設(shè)計(jì),設(shè)計(jì)軟件系統(tǒng)的結(jié)構(gòu)設(shè)計(jì)、逐個(gè)模塊的程序描述(包括各模塊的功能、性能、輸入、輸出、算法、程序邏輯、接口等等),解決如何1.接受:旅客信息及取票通知和帳單;2.輸出:取票通知和帳單及機(jī)票;3.網(wǎng)絡(luò)輸出和加密,輸入和解密;4.分辨信息的種類并采取相應(yīng)的處理步驟;5.判斷信息的正誤并采取相應(yīng)的處理步驟;6.進(jìn)行數(shù)據(jù)庫的查詢、修改工作;7.接受并判斷錯(cuò)誤,輸出相應(yīng)的出錯(cuò)消息;在以下的各個(gè)階段中,《用戶操作手冊》將與本階段的工作緊密結(jié)合 , 努力作到讓用戶易懂易學(xué) 。《測試報(bào)告》和《維護(hù)報(bào)告》也將參考本說明書,檢驗(yàn)本系統(tǒng)的各項(xiàng)性能指標(biāo),及時(shí)發(fā)現(xiàn)紕漏及時(shí)修補(bǔ),一定要把功能強(qiáng)大、穩(wěn)定可靠、便于維護(hù)的機(jī)票預(yù)定系統(tǒng)交到用戶手中 。
1、2項(xiàng)目
軟件開發(fā)文檔干什么的?在軟件的生產(chǎn)過程中,總是伴隨著大量的信息要記錄、要使用 。因此,軟件文檔在產(chǎn)品的開發(fā)生產(chǎn)過程中起著重要的作用 。
1)提高軟件開發(fā)過程的能見度 。把開發(fā)過程中發(fā)生的事件以某種可閱讀的形式記錄在文檔中 。管理人員可把這些記載下來的材料作為檢查軟件開發(fā)進(jìn)度和開發(fā)質(zhì)量的依據(jù),實(shí)現(xiàn)對軟件開發(fā)的工程管理 。
2)提高開發(fā)效率 。軟件文檔的編制,使得開發(fā)人員對各個(gè)階段的工作都進(jìn)行周密思考、全盤權(quán)衡、從而減少返工 。并且可在開發(fā)早期發(fā)現(xiàn)錯(cuò)誤和不一致性,便于及時(shí)加以糾正 。
3)作為開發(fā)人員在一定階段的工作成果和結(jié)束標(biāo)志 。
4)記錄開發(fā)過程中的有關(guān)信息,便于協(xié)調(diào)以后的軟件、開發(fā)、使用和維護(hù) 。
5)提供對軟件的運(yùn)行、維護(hù)和培訓(xùn)的有關(guān)信息 , 便于管理人員、開發(fā)人員、操作人員、用戶之間的協(xié)作、交流和了解 。使軟件開發(fā)活動(dòng)更科學(xué)、更有成效 。
6)便于潛在用戶了解軟件的功能、性能等各項(xiàng)指標(biāo),為他們選購符合自己需要的軟件提供依據(jù) 。
文檔在各類人員、計(jì)算機(jī)之間的多種橋梁作用中看出:
既然軟件已經(jīng)從手工藝人的開發(fā)方式發(fā)展到工業(yè)化的生產(chǎn)方式,文檔在開發(fā)過程中就起到關(guān)鍵作用 。從某種意義上來說 , 文檔是軟件開發(fā)
規(guī)范的體現(xiàn)和指南 。按規(guī)范要求生成一整套文檔的過程 , 就是按照軟件開發(fā)規(guī)范完成一個(gè)軟件開發(fā)的過程 。所以 , 在使用工程化的原理和方法來指導(dǎo)軟件的開發(fā)和維護(hù)時(shí),應(yīng)當(dāng)充分注意軟件文檔的編制和管理 。
PS:軟件開發(fā)文檔包括:
操作手冊
維護(hù)修改建議
軟件需求(規(guī)格)說明書
開發(fā)文檔 軟件需求(規(guī)格)說明書
數(shù)據(jù)要求說明書
概要設(shè)計(jì)說明書
詳細(xì)設(shè)計(jì)說明書
可行性研究報(bào)告
項(xiàng)目開發(fā)計(jì)劃
管理文檔 項(xiàng)目開發(fā)計(jì)劃
測試計(jì)劃
測試報(bào)告
開發(fā)進(jìn)度月報(bào)
開發(fā)總結(jié)報(bào)告
軟件開發(fā)文檔說明(完整流程)在軟件行業(yè)有一句話:一個(gè)軟件能否順利的完成并且功能是否完善 , 重要是看這個(gè)軟件有多少文檔,軟件開發(fā)文檔是一個(gè)軟件的支柱 , 如果你的開發(fā)文檔漏洞百出,那么你所開發(fā)出來的軟件也不可能會好;開發(fā)文檔的好壞可以直接影響到所開發(fā)出來軟件的成功與否 。
一、軟件開發(fā)設(shè)計(jì)文檔:軟件開發(fā)文檔包括軟件需求說明書、數(shù)據(jù)要求說有書、概要設(shè)計(jì)說明書、詳細(xì)設(shè)計(jì)說明書 。1、軟件需求說明書:也稱為軟件規(guī)格說明 。該說明書對所開發(fā)軟件的功能、性能、用戶 界面及運(yùn)行環(huán)境等做出詳細(xì)的說明 。它是用戶與開發(fā)人員雙方對軟件需求取得共同理 解基礎(chǔ)上達(dá)成的協(xié)議,也是實(shí)施開發(fā)工作的基礎(chǔ) 。軟件需求說明書的編制目的的就是 為了使用戶和軟件開發(fā)者雙方對該軟件的初始規(guī)定有一個(gè)共同的理解、并使之面成為 整個(gè)開發(fā)工作的基礎(chǔ) 。
其格式要求如下:
1 引言
1.1 編寫目的 。1.2 背景
1.3 定義
2 任務(wù)概述
2.1 目標(biāo)
2.2 用戶的特點(diǎn)
2.3 假定和約束
3 需求規(guī)定
3.1 對功能的規(guī)定
3.2 對性能的規(guī)定
3.2.1 精度
3.2.2 時(shí)間特性的需求
3.2.3 靈活性
3.3 輸入輸出要求
3.4 數(shù)據(jù)管理能力要求
3.5 故障處理要求
3.6 其他專門要求2332 模塊開發(fā)情況表:其格式要求如下: 4.3.6 恢復(fù)過程
APP軟件開發(fā)項(xiàng)目文檔模板1.引言1.1編寫目的·闡明開發(fā)本軟件的目的;1.2項(xiàng)目背景·標(biāo)識待開發(fā)軟件產(chǎn)品的名稱、代碼;·列出本項(xiàng)目的任務(wù)提出者、項(xiàng)目負(fù)責(zé)人項(xiàng)目負(fù)責(zé)人、系統(tǒng)分析員、系統(tǒng)設(shè)計(jì)員、程序設(shè)計(jì)員、程序員、資料員以及與本項(xiàng)目開展工作直接有關(guān)的人員和用戶;·說明該軟件產(chǎn)品與其他有關(guān)軟件產(chǎn)品的相互關(guān)系 。1.3術(shù)語說明列出本文檔中所用到的專門術(shù)語的定義和英文縮寫詞的原文 。1.4參考資料(可有可無)列舉編寫軟件需求規(guī)格說明時(shí)所參考的資料,包括項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合同、引用的標(biāo)準(zhǔn)和規(guī)范、項(xiàng)目開發(fā)計(jì)劃、需求規(guī)格說明、使用實(shí)例文檔 , 以及相關(guān)產(chǎn)品的軟件需求規(guī)格說明 。在這里應(yīng)該給出詳細(xì)的信息,包括標(biāo)題、作者、版本號、發(fā)表日期、出版單位或資料來源 。2.項(xiàng)目概述2.1待開發(fā)軟件的一般描述描述待開發(fā)軟件的背景,所應(yīng)達(dá)到的目標(biāo) , 以及市場前景等 。2.2待開發(fā)軟件的功能簡述待開發(fā)軟件所具有的主要功能 。為了幫助每個(gè)讀者易于理解,可以使用列表或圖形的方法進(jìn)行描述 。使用圖形表示 , 可以采用:·頂層數(shù)據(jù)流圖;·用例UseCase圖;·系統(tǒng)流程圖;·層次方框圖 。
2.3用戶特征和水平(是哪類人使用)描述最終用戶應(yīng)具有的受教育水平、工作經(jīng)驗(yàn)及技術(shù)專長 。2.4運(yùn)行環(huán)境描述軟件的運(yùn)行環(huán)境,包括硬件平臺、硬件要求、操作系統(tǒng)和版本,以及其他的軟件或與其共存的應(yīng)用程序等 。2.5條件與限制給出影響開發(fā)人員在設(shè)計(jì)軟件時(shí)的約束條款,
請問“軟件工程國家標(biāo)準(zhǔn)文檔”(GB開頭的)有官方下載地址嗎?資料包含了軟件工程國家標(biāo)準(zhǔn)文檔:操作手冊、測試分析報(bào)告、試報(bào)告、概要設(shè)計(jì)說明書、可行性研究報(bào)告、模塊開發(fā)卷宗、軟件需求說明書、數(shù)據(jù)說明要求書、數(shù)據(jù)庫要求說明書、文件給制實(shí)施規(guī)定的實(shí)例(GB8567-88)、詳細(xì)設(shè)計(jì)說明書(GB8567——88)、項(xiàng)目開發(fā)計(jì)劃(GB856T——88)、項(xiàng)目開發(fā)總結(jié)報(bào)告(GB8567——88)、銀行計(jì)算機(jī)儲蓄系統(tǒng)可行性分析報(bào)告書 [文檔在線提供]/用戶手冊(GB8567——88)/中華人民共和國國家標(biāo)準(zhǔn) 。這是對軟件開發(fā)必不可少的設(shè)計(jì)要求,有了它 , 你將可以運(yùn)用自己在軟件開發(fā)上的天賦,設(shè)計(jì)出自己想要,并且符合國家標(biāo)準(zhǔn)的軟件!
軟件開發(fā)流程規(guī)范軟
件
開
發(fā)
流
程
規(guī)
范
V1.0
德聯(lián)軟件有限責(zé)任公司
編制人:侯秀美審核人:2015年8月19日
本文制定煙臺開發(fā)區(qū)德聯(lián)軟件有限責(zé)任公司計(jì)算機(jī)軟件開發(fā)規(guī)范文檔 。本規(guī)范的目的是使公司軟件開發(fā)項(xiàng)目階段清晰、要求明確、任務(wù)具體、編寫的代碼規(guī)范,使之規(guī)范化、系統(tǒng)化和工程化,向公司內(nèi)從事軟件開發(fā)的工程師和管理人員提出一系列規(guī)范和要求,從而有利于開發(fā)過程的控制和管理,提高所開發(fā)軟件系統(tǒng)的質(zhì)量,縮短開發(fā)時(shí)間,減少開發(fā)和維護(hù)費(fèi)用 , 以保證項(xiàng)目高質(zhì)量、順利進(jìn)行 。
本規(guī)范包含:開發(fā)流程規(guī)范和開發(fā)代碼規(guī)范等,開發(fā)流程規(guī)范需要技術(shù)開發(fā)人員編寫相關(guān)內(nèi)容,希望每個(gè)技術(shù)人員形成習(xí)慣 , 如有新的內(nèi)容更新會及時(shí)通知大家,如有好的規(guī)范要求也可通知編制人員及時(shí)更新 。
本規(guī)范為煙臺開發(fā)區(qū)德聯(lián)軟件有限責(zé)任公司內(nèi)部材料,嚴(yán)禁其他商業(yè)應(yīng)用 。
接受開發(fā)任務(wù) , 詳細(xì)閱讀軟件技術(shù)規(guī)范或技術(shù)文檔,如對技術(shù)文檔有疑義或者不清楚的地方及時(shí)與項(xiàng)目總工或用戶溝通,根據(jù)文檔和溝通內(nèi)容編寫項(xiàng)目開發(fā)計(jì)劃,必須包括但不限于系統(tǒng)軟硬件開發(fā)環(huán)境、系統(tǒng)架構(gòu)、系統(tǒng)功能模塊設(shè)計(jì)、系統(tǒng)功能開發(fā)流程圖、開發(fā)修改記錄 。
開發(fā)環(huán)境的搭建,最好形成文檔 , 便于以后同樣工作的使用 。開發(fā)人員要明確系統(tǒng)開發(fā)擬采用的數(shù)據(jù)庫、操作系統(tǒng)、開發(fā)語言、開發(fā)工具、服務(wù)器等(具體到版本) 。明確整個(gè)系統(tǒng)開發(fā)工作流程,至少應(yīng)該包括以下流程 。2.☆☆即:變量名= ☆一般說來每
軟件工程需求分析文檔模板軟件開發(fā)中心
SoftwareDevelopmentCenter需求分析報(bào)告
項(xiàng)目名稱
文檔類別
文檔編號
版本
密級
二〇一〇年十二月二十日版本修訂記錄
版本|日期|描述|作者|審核|
目錄
1引言31.1編寫目的31.2背景31.3術(shù)語定義31.4參考資料32系統(tǒng)概述32.1系統(tǒng)功能框架32.2運(yùn)行環(huán)境32.3開發(fā)環(huán)境32.4用戶特點(diǎn)32.5條件與限制33功能描述33.1功能分解33.2各功能描述34數(shù)據(jù)描述35性能描述36接口描述37其他要求38未盡事宜3附件3{簡要說明編寫這份需求分析報(bào)告的目的,指出預(yù)期的讀者 。
本軟件需求分析報(bào)告的編寫目的是為了提供一個(gè)由用戶(或委托者)和開發(fā)者雙方共同確定的開發(fā)系統(tǒng)的業(yè)務(wù)需求目標(biāo),并對所實(shí)現(xiàn)的軟件功能做全面的規(guī)格描述 。
同時(shí),在用戶業(yè)務(wù)需求的基礎(chǔ)上,經(jīng)過需求分析和數(shù)據(jù)整理 , 以向整個(gè)開發(fā)期提供關(guān)于軟件系統(tǒng)的業(yè)務(wù)和數(shù)據(jù)的技術(shù)信息和整體描述,成為軟件開發(fā)的技術(shù)基礎(chǔ),也作為系統(tǒng)設(shè)計(jì)和實(shí)現(xiàn)的目標(biāo)及驗(yàn)收依據(jù) 。
本軟件需求分析報(bào)告的適用讀者,一般為:軟件客戶、軟件需求分析人員、軟件設(shè)計(jì)及開發(fā)者和相關(guān)的測試人員}
{1.說明待開發(fā)的軟件系統(tǒng)的名稱
2.列出本項(xiàng)目的任務(wù)委托單位、開發(fā)單位、協(xié)作單位、用戶單位
3.說明項(xiàng)目背景,敘述該項(xiàng)軟件開發(fā)的意圖、應(yīng)用目標(biāo)、作用范圍以及其他應(yīng)向讀者說明的有關(guān)該軟件開發(fā)的背景材料 。如果本次開發(fā)的軟件系統(tǒng)是一個(gè)更大的系統(tǒng)的一個(gè)組成部分,
Android APP開發(fā)需求文檔范本【軟件設(shè)計(jì)文檔】軟件需求文檔格式的標(biāo)準(zhǔn)寫法
1.引言
1.1編寫目的
· 闡明開發(fā)本軟件的目的;
1.2項(xiàng)目背景
· 標(biāo)識待開發(fā)軟件產(chǎn)品的名稱、代碼;
· 列出本項(xiàng)目的任務(wù)提出者、項(xiàng)目負(fù)責(zé)人、系統(tǒng)分析員、系統(tǒng)設(shè)計(jì)員、程序設(shè)計(jì)員、程序員、資料員以及與本項(xiàng)目開展工作直接有關(guān)的人員和用戶;
· 說明該軟件產(chǎn)品與其他有關(guān)軟件產(chǎn)品的相互關(guān)系 。
1.3術(shù)語說明
列出本文檔中所用到的專門術(shù)語的定義和英文縮寫詞的原文 。
1.4參考資料(可有可無)
列舉編寫軟件需求規(guī)格說明時(shí)所參考的資料,包括項(xiàng)目經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書、合
同、引用的標(biāo)準(zhǔn)和規(guī)范、項(xiàng)目開發(fā)計(jì)劃、需求規(guī)格說明、使用實(shí)例文檔 , 以及相關(guān)產(chǎn)品
的軟件需求規(guī)格說明 。
在這里應(yīng)該給出詳細(xì)的信息,包括標(biāo)題、作者、版本號、發(fā)表日期、出版單位或資
料來源 。
2.項(xiàng)目概述
2.1待開發(fā)軟件的一般描述
描述待開發(fā)軟件的背景,所應(yīng)達(dá)到的目標(biāo),以及市場前景等 。
2.2待開發(fā)軟件的功能
簡述待開發(fā)軟件所具有的主要功能 。為了幫助每個(gè)讀者易于理解,可以使用列表或
圖形的方法進(jìn)行描述 。使用圖形表示,可以采用:
· 頂層數(shù)據(jù)流圖;
· 用例UseCase圖;
· 系統(tǒng)流程圖;
· 層次方框圖 。
2.3用戶特征和水平(是哪類人使用)
描述最終用戶應(yīng)具有的受教育水平、工作經(jīng)驗(yàn)及技術(shù)專長 。
2.4運(yùn)行環(huán)境
描述軟件的運(yùn)行環(huán)境 , 包括硬件平臺、硬件要求、操作系統(tǒng)和版本 , 以及其他的軟
件或與其共存的應(yīng)用程序等 。
2.5條件與限制
給出影響開發(fā)人員在設(shè)計(jì)軟件時(shí)的約束條款 , 例如:
· 必須使用或避免使用的特定技術(shù)、工具、編程語言和數(shù)據(jù)庫;
· 硬件限制;
· 所要求的開發(fā)規(guī)范或標(biāo)準(zhǔn) 。
3.功能需求
3.1功能劃分
列舉出所開發(fā)的軟件能實(shí)現(xiàn)的全部功能,可采用文字、圖表或數(shù)學(xué)公式等多種方法
進(jìn)行描述 。
3.2功能描述
對各個(gè)功能進(jìn)行詳細(xì)的描述 。
4.外部接口需求
4.1用戶界面
對用戶希望該軟件所具有的界面特征進(jìn)行描述 。以下是可能要包括的一些特征:
· 將要采用的圖形用戶界面標(biāo)準(zhǔn)或產(chǎn)品系列的風(fēng)格;
· 屏幕布局;
· 菜單布局;
· 輸入輸出格式;
· 錯(cuò)誤信息顯示格式;
建議采用RAD開發(fā)工具,比如Visio,構(gòu)造用戶界面 。
4.2硬件接口
描述系統(tǒng)中軟件產(chǎn)品和硬件設(shè)備每一接口的特征,以及硬件接口支持的設(shè)備、軟件與硬件接口之間,以及硬件接口與支持設(shè)備之間的約定,包括交流的數(shù)據(jù)和控制信息的性質(zhì)以及所使用的通信協(xié)議 。
4.3軟件接口
描述該軟件產(chǎn)品與其有關(guān)軟件的接口關(guān)系,并指出這些外部軟件或組件的名字和版本號 。比如運(yùn)行在什么操作系統(tǒng)上,訪問何種類型的數(shù)據(jù)庫,使用什么數(shù)據(jù)庫連接組件,和什么商業(yè)軟件共享數(shù)據(jù)等 。
4.4通信接口
描述和本軟件產(chǎn)品相關(guān)的各種通信需求,包括電子郵件、Web瀏覽器、網(wǎng)絡(luò)通信協(xié)議等 。
4.5故障處理
對可能的軟件、硬件故障以及對各項(xiàng)性能而言所產(chǎn)生的后果進(jìn)行處理 。
5.性能需求
5.1數(shù)據(jù)精確度
輸出結(jié)果的精度 。
5.2時(shí)間特性
時(shí)間特性可包括如下幾方面
·響應(yīng)時(shí)間;
·更新處理時(shí)間;
·數(shù)據(jù)轉(zhuǎn)換與傳輸時(shí)間;
·運(yùn)行時(shí)間等 。
5.3適應(yīng)性
在操作方式、運(yùn)行環(huán)境、與其他軟件的接口以及開發(fā)計(jì)劃等發(fā)生變化時(shí),軟件的適應(yīng)能力 。
6.其他需求
列出在本文的其他部分未出現(xiàn)的需求 。如果不需要增加其他需求,可省略這一部分 。
7.?dāng)?shù)據(jù)描述
7.1靜態(tài)數(shù)據(jù)
7.2動(dòng)態(tài)數(shù)據(jù)
包括輸入數(shù)據(jù)和輸出數(shù)據(jù) 。
7.3數(shù)據(jù)庫描述
給出使用數(shù)據(jù)庫的名稱和類型 。
7.4數(shù)據(jù)字典
對于數(shù)據(jù)流圖、層次方框圖中出現(xiàn)的所有圖形元素在數(shù)據(jù)字典中都要作為一個(gè)詞條加以定義 , 使得每一個(gè)圖形元素都有唯一的一個(gè)清晰明確的解釋 。
數(shù)據(jù)字典中所有的定義必須是嚴(yán)密的、精確的,不可有二意性 。
7.5數(shù)據(jù)采集
·列出提供輸入數(shù)據(jù)的機(jī)構(gòu)、設(shè)備和人員
·列出數(shù)據(jù)輸入的手段、介質(zhì)和設(shè)備;
·列出數(shù)據(jù)生成的方法、介質(zhì)和設(shè)備 。
8.附錄
包括分析模型,待定問題圖表等 。
求一份APP前端設(shè)計(jì)(包括從流程圖到效果圖,到前端開發(fā)實(shí)現(xiàn))的開發(fā)時(shí)間評估文檔模板前端工作是指售前?、
還是說開發(fā)展現(xiàn)層?
j2ee方向的我給你提供點(diǎn)信息吧:
1、JSP , HTML,CSS,JS(常用的庫,和基本語法)、ajax技術(shù) 。
2、java基礎(chǔ)語法 , 常用的框架,如:struts , hibernate,spring , ibatis,mybatis
3、數(shù)據(jù)庫:MYSQL,sqlserver,oracle等
4、工具:數(shù)據(jù)庫設(shè)計(jì)工工具 , 流程圖工具,office,郵件
5、服務(wù)器:linux,windows
6、計(jì)算機(jī)相關(guān):硬件 , 內(nèi)存,操作系統(tǒng)相關(guān)知識等等 。
太多了,你具體說說你想知道哪些?
娛樂方面的APP程序的PPT從哪些方面講電影四大片種主要是指故事片、美術(shù)片、新聞紀(jì)錄片和科學(xué)教育片 。
(1)故事片是指綜合文學(xué)、戲劇、音樂、美術(shù)諸藝術(shù)因素,以塑造人物為主,具有故事情節(jié)(反映生活)并由演員扮演人物的影片 。由演員演出是其區(qū)別于其他片種的基本特征 。故事片取材范圍廣泛,如歷史、神話、科學(xué)幻想等,但以現(xiàn)實(shí)生活為主 。故事片一般的被別人印制和拷貝最多 , 發(fā)行量最大,觀眾最廣 。它經(jīng)過集中概括等藝術(shù)手法 , 塑造人物,組織結(jié)構(gòu)、提煉情節(jié),表達(dá)一定的主題思想 。
(2)美術(shù)片是運(yùn)用繪畫或其他造型手段創(chuàng)作的影片,特別受少年兒童歡迎,主要包括動(dòng)畫片、木偶片、剪紙片和折紙片四種 。
(3)新聞紀(jì)錄片是以真實(shí)生活為創(chuàng)作素材,以真人真事為表現(xiàn)對象,并對其進(jìn)行藝術(shù)的加工與展現(xiàn),以展現(xiàn)真實(shí)為本質(zhì) , 并用真實(shí)引發(fā)人們思考的電影或電視藝術(shù)形式 。
(4)科學(xué)教育片是運(yùn)用電影技術(shù)手段來傳播科學(xué)文化知識的片種,簡稱科教片 。科學(xué)教育片具有鮮明的形象性、直觀性,因此用來傳播科學(xué)技術(shù)和文化知識能收到很好的效果,對促進(jìn)科研、發(fā)展經(jīng)濟(jì)建設(shè)、提高人民的文化水平起著重要作用
開發(fā)一個(gè)視頻直播類軟件APP需要多少錢開發(fā)一個(gè)視頻直播類軟件APP多少錢?根據(jù)我們的軟件開發(fā)經(jīng)驗(yàn)來來看,開發(fā)一個(gè)視頻直播類軟件APP多少錢,源要看你的需求文檔的要求 。軟件都是不一樣的,哪怕同樣是直播軟件,斗魚、虎牙、BILIBILI等直播軟件里的各種功能也是不同的,不同的功能自然會導(dǎo)致長短不一的工期,導(dǎo)致報(bào)價(jià)不同 。就目前的市場行情來看,如果只是搭建直播平臺,價(jià)格會低一些,如果需要源碼或者需要二次開發(fā),價(jià)格會更高些 。
- 房屋設(shè)計(jì)軟件
- 工程項(xiàng)目管理軟件
- 自拍神器軟件
- html轉(zhuǎn)js
- 自動(dòng)搶紅包軟件
- wps是什么
- 常用辦公軟件
- 圖表制作軟件
- 360卸載軟件
- 制作網(wǎng)頁的軟件
