軟件公司軟件項目研發(fā)管理制度版

1、一、總述2二、項目計劃2三、項目組織3四、項目管理44.1、軟件開發(fā)規(guī)范44.1、命名體系44.1.2、編碼風(fēng)格44.1.3、界面風(fēng)格44.1.4、版本控制54.1.5、通用約束54.1.6> 開發(fā)方法54.1.7、開發(fā)流程54.1.8、交流制度64.1.9、代碼標(biāo)進(jìn)化管理64.1.10、備份制度64.11、文檔管理64.1.12、項目交付管理74.1.13、項目歸檔管理74.2、任務(wù)分解與分目標(biāo)制定74.3、進(jìn)度檢查與績效考評84.3.1、考評原則84.3.2、考評標(biāo)準(zhǔn)94.3.4、考評矩陣94.4、應(yīng)對一些突發(fā)事件（協(xié)調(diào)與調(diào)整）124.5、與有利害關(guān)系的人共享信息12附錄41項目開發(fā)

2、計劃13附錄4-2軟件需求說明書15附錄4-3詳細(xì)設(shè)計說明書17附錄44用戶手冊19附錄45數(shù)據(jù)要求說明書22附錄46項目開發(fā)總結(jié)報告24附錄5-1java編碼規(guī)范26附錄5-2應(yīng)用結(jié)構(gòu)定義與命名規(guī)范32附錄53數(shù)據(jù)庫對象命名規(guī)范32.總述項目管理覆蓋整個項目生命周期，管理制度就是落實到管理過程中的一些基 本要素，這里我們將其概括為三項基本業(yè)務(wù)：i、項目計劃 指明要取得的各種結(jié)果 指定進(jìn)度表 估計所需資源ii、項目組織落實項目體系中的角色配置與角色的職責(zé)iii、項目管理 約束 任務(wù)分解與分目標(biāo)制定 進(jìn)度檢查與質(zhì)量評估 應(yīng)對一些突發(fā)事件（協(xié)調(diào)與調(diào)整） 與有利害關(guān)系的人共享信息二、項目計劃項目計劃

3、的結(jié)果體現(xiàn)為“項目開發(fā)計劃”書面形式，其中要對開發(fā)過程中各 項工作的負(fù)責(zé)人、開發(fā)進(jìn)度、進(jìn)度衡量的標(biāo)準(zhǔn)、完成進(jìn)度所需經(jīng)費預(yù)算以及所需 軟、硬件條件等問題詳盡的羅列出來，以便根據(jù)本計劃開展和檢查本項目的開發(fā) 工作。附錄4-1給出計劃書模板。三、項目組織項目組織包括項目角色定義、角色責(zé)任定義、角色間關(guān)系定義。角色定義是 根據(jù)項目需求配置（調(diào)配、招聘）具備相應(yīng)素質(zhì)與能力的成員。角色責(zé)任定義就 是將具體的任務(wù)分解到每個角色；角色間關(guān)系定義指明報告與檢查體系；一般情 況下為三級組織：業(yè)務(wù)與商務(wù)協(xié)調(diào)組（商務(wù)洽談、目標(biāo)與進(jìn)度及資源定義與落實調(diào)整）項目經(jīng)理開發(fā)組系統(tǒng)支持組負(fù)責(zé)主機(jī)、網(wǎng)絡(luò)、應(yīng)用支撐軟件的安裝調(diào)試開

4、發(fā)經(jīng)理系統(tǒng)架構(gòu)組負(fù)責(zé)系統(tǒng)的體系結(jié)構(gòu)與應(yīng)用框架設(shè)計詳細(xì)設(shè)計組落實到具體語言的功能實現(xiàn)質(zhì)量控制組（負(fù)責(zé)功能、性能、可用性、可維護(hù)性、穩(wěn)定性、壓力測試）質(zhì)量經(jīng)理業(yè)務(wù)與商務(wù)協(xié)調(diào)組一般由客我雙方成員共同組成，負(fù)責(zé)項目的總體需求、總 體目標(biāo)、里程碑，關(guān)鍵技術(shù)路徑定義。在制定項目總體目標(biāo)、里程碑定義與關(guān)鍵 技術(shù)路徑時候要與開發(fā)經(jīng)理聯(lián)合統(tǒng)籌，并以項目經(jīng)理意見為主。開發(fā)組的責(zé)任人是開發(fā)經(jīng)理，系統(tǒng)體系結(jié)構(gòu)與框架由開發(fā)經(jīng)理與開發(fā)組主力 程序員聯(lián)合統(tǒng)籌，并以開發(fā)經(jīng)理意見為主，具體功能實現(xiàn)一般以主力程序員（系 統(tǒng)分析員、高級程序員）意見為主?！跋到y(tǒng)支持”屬于臨時調(diào)配，很可能是外部 資源，但工作質(zhì)量由開發(fā)經(jīng)理檢查。質(zhì)量控

5、制由質(zhì)量經(jīng)理、開發(fā)經(jīng)理、項目經(jīng)理聯(lián)合統(tǒng)籌，以質(zhì)量經(jīng)理意見為主。整個項目生命周期中一般角色責(zé)任定義如下：軟件開發(fā)可分為：據(jù)、定義、設(shè)計、編碼、系統(tǒng)測試、接收、移植、運行等過程。a®階段職責(zé)文角色定義需要定義問題說明書項目經(jīng)理/分析員開始項目規(guī)劃項目規(guī)劃分析員設(shè)計設(shè)計方案設(shè)計說明書分析員編碼編寫程序編碼說明書分析員倚級程序員將程序集成到系統(tǒng)中集戚測試說明書程序員測試驗證系統(tǒng)功能與性能系統(tǒng)測試說明書測試員/分析員接收向客戶演示系統(tǒng)操作說明書項目經(jīng)理器戶移植移植最終運行環(huán)境移植說明書分析員信級程序員數(shù)據(jù)采集及導(dǎo)入分析員雁序員運仃用戶培訓(xùn)用戶培訓(xùn)文檔分析員/用戶監(jiān)控系統(tǒng)運行性能用戶/分析員四.

6、 項目管理4.1.軟件開發(fā)規(guī)范這里只是給岀我司軟件開發(fā)必須遵從的原則，具體內(nèi)容應(yīng)該由項目經(jīng)理或開 發(fā)經(jīng)理根據(jù)具體項口制定詳盡約定。在羅列規(guī)范z前，開發(fā)組織（團(tuán)隊）必須遵 從一個最基本的約定一一統(tǒng)一開發(fā)環(huán)境：os：操作系統(tǒng)；ide：集成開發(fā)工具；debug：調(diào)試工具；sc：源代碼控制器；im:即時交流工具；dd:文檔工具（計劃，任務(wù)，報告）；asm:間接交流工具，一般以mail為主。另外還要為團(tuán)隊固定一些一些角色，builder / server administrator（dba&osa）。嚴(yán)格區(qū)分開發(fā)平臺與生產(chǎn)平臺之間的界限（安全、測試、性能）4.1.k命名體系a）數(shù)據(jù)庫與數(shù)據(jù)庫對象

7、命名；b）開發(fā)語言的元素命名（類、對象、文件、命名空間、組件、函數(shù)、方法等）;c）頁面與頁面元素命名.d）文件目錄體系縮進(jìn)、換行、塊大小、文件大小、注釋4.1.3、界面風(fēng)格組件類別、大小、前景、背景、字體、鼠標(biāo)敏感、邊框、布局4.1.4.版本控制創(chuàng)建權(quán)限、創(chuàng)建分之權(quán)限、更新頻度、提交準(zhǔn)則。4.1.5、通用約束向?qū)гO(shè)置、數(shù)據(jù)校驗、提示信息、響應(yīng)時間與響應(yīng)方式4丄6、開發(fā)方法鑒于用戶需求的不容易澄清性與變動頻繁這一特點，所有項目均采用迭代開 發(fā)方法。這就是說不要指望在明確的需求調(diào)硏階段能把問題搞清楚，弄清楚個大 概即可，以不超過兩周的迭代間隔快速的交互原型，以便反饋更進(jìn)一步的需求、 這樣一步步逼近

8、用戶的真實想法。這里要特別強(qiáng)調(diào)的是多與用戶交流，項冃組內(nèi) 有關(guān)設(shè)計方法與策略也要頻繁地交流。純粹從開發(fā)的角度我們將項目周期劃分為兩個階段，每個階段要完成的的如下:-初角j 階、段4.1.8、交流制度項目組每周至少要進(jìn)行不少于兩次的集體交流，否則就是開發(fā)經(jīng)理或項目經(jīng) 理失職（交流不限制時間長短、方式、內(nèi)容可以從需要到設(shè)計到實現(xiàn)、其至是抱 怨）。4.1.9.代碼標(biāo)準(zhǔn)化管理小組內(nèi)成員必須開展互測，項目經(jīng)理要督促進(jìn)行。如果一般性的缺陷被質(zhì)量 組測試發(fā)現(xiàn)，項目經(jīng)理可以作出警告、取消休假、扌ii發(fā)獎金等處理措施。項目經(jīng) 理或開發(fā)經(jīng)理可抽查成員代碼，對比規(guī)范作出人員基本技術(shù)素養(yǎng)評測，計入期末 （項目結(jié)束）考

9、核（去留）。應(yīng)用系統(tǒng)的所有資料代碼（程序、腳本塊、數(shù)據(jù)庫腳本）、文檔、數(shù)據(jù), 除了數(shù)據(jù)以外，全部納入源代碼控制系統(tǒng)。數(shù)據(jù)每天備份一次媒介是磁盤,代 碼（程序腳本、數(shù)據(jù)庫腳本）、文檔每周一次媒介是磁盤,所有信息每月備份 一次媒介是光盤。4.1.1k文檔管理沒有文檔的軟件是一種災(zāi)難。代碼不是傳達(dá)系統(tǒng)原理和結(jié)構(gòu)的理想媒介；開 發(fā)團(tuán)隊更需要編制易于閱讀的文擋，來對系統(tǒng)及其設(shè)計決策的依據(jù)進(jìn)行描述。然而，過多的文檔比過少的文檔更糟。編制眾多的文檔需要花費大量的時間, 并且要使這些文檔和代碼保持同步：就要花費更多的時間。如果文檔和代碼z間 失去同步，那么文檔就會變成龐大的、復(fù)雜的謊言.會造成重大的誤導(dǎo)；對于

10、團(tuán)隊來說，編寫并維護(hù)一份系統(tǒng)原理和結(jié)構(gòu)方而的文擋將總是一個好主 慝，但是那份文檔應(yīng)該是短小、突出主題的。為此我們擬定所有項fi都必須編制 以下文檔。1項目開發(fā)計劃書，模板見附錄4-12軟件需求說明書，模板見附錄4-23詳細(xì)設(shè)計說明書,模板見附錄4-34用戶手冊，模板見附錄4-45數(shù)據(jù)庫需求說明，模板見附錄4-56項目開發(fā)總結(jié)報告,模板見附錄4-64.1.12、項目交付管理軟件交付應(yīng)用，源代碼文檔交付視技術(shù)合同要求交付的內(nèi)容而定運行維護(hù)技術(shù)交付：系統(tǒng)、數(shù)據(jù)庫、應(yīng)用的日常管理與維護(hù)。系統(tǒng)安全性交付：操作系統(tǒng)管理與應(yīng)用賬號、數(shù)據(jù)庫管理與應(yīng)用開發(fā)賬號、應(yīng)用 服務(wù)器的管理與應(yīng)用開發(fā)賬號。4丄13、項目歸

11、檔管理項目執(zhí)行過程的所有資料程序、腳本、數(shù)據(jù)、文檔以光盤作媒介，并附上 資料清單，交給公司行政部。4.2、任務(wù)分解與分目標(biāo)制定組織中的負(fù)責(zé)人負(fù)責(zé)具體的任務(wù)分解并落實到組織中的每個人。形式如下：軟件開發(fā)任務(wù)單項目名稱：任務(wù)編號子項名稱按“子系統(tǒng)f模塊f功能”最多三級劃分功能描述技術(shù)要求復(fù)雜度（業(yè)務(wù)與技術(shù)兩個層次）任務(wù)發(fā)岀人任務(wù)承接人限時開始yyyy/mmdd限時結(jié)束yyyy/mmdd考核標(biāo)準(zhǔn)（百分制）分值考評項目301、時效性：（是否按時完成）402、客戶關(guān)注點：（功能、可靠性、易用性、高效性、 可維護(hù)性、可移植性）表現(xiàn)如何103、規(guī)范與標(biāo)準(zhǔn)54、復(fù)用與創(chuàng)新85、團(tuán)隊精神26、奉獻(xiàn)精神57、溝通

12、精神4.3、進(jìn)度檢查與績效考評4.3.k考評原則軟件開發(fā)人員的績效考評是所有軟件公司都深感棘手但又必須而對的問題。 棘手的原因是既不能進(jìn)行計時處理、也不能進(jìn)行計件處理。計時會造成出工不出 力，計件（一般按代碼條數(shù)）會挫傷優(yōu)秀軟件人員的積極性（同樣實現(xiàn)一個功能, 差的軟件人員成百上千行，而優(yōu)秀軟件人員只有幾十行，且好用）。但是只要尊 重一些必要的原則，還是能夠加以評估的。這里提岀六條原則：1、被考核對象必須有明確的任務(wù)項目經(jīng)理或開發(fā)經(jīng)理必須發(fā)出明確的任務(wù)書：任務(wù)書中指定任務(wù)名稱、任務(wù) 內(nèi)容、完成時限之、考核標(biāo)準(zhǔn)、向誰負(fù)責(zé)、任務(wù)的難易程度（業(yè)務(wù)與技術(shù)兩個方 面）。難易程度由項目組成員集體評價。沒有

13、明確的任務(wù)當(dāng)然就無法考評（見表 4-2 ）o2、考評標(biāo)準(zhǔn)要綜合計量量與非計量量。計量量如：完成時間、完成了對少功能、測試出多少缺陷等，非計量量如：用戶接受程度如何、項目組合作情況如何等等，要將這些因素綜合考慮。3、要體現(xiàn)多勞多得、獎勤罰懶。高效、高質(zhì)完成任務(wù)的人員必須得到區(qū)別對待（調(diào)資、休假、獎金）。4、考評結(jié)果要及吋與被考評對象溝通，容許爭議協(xié)調(diào)。5、考評時間不得跨度太大，一般為兩周一次，不符合這種周期的，項 目經(jīng)理與開發(fā)經(jīng)理需要適當(dāng)對任務(wù)做進(jìn)一步分解。6、被考評要提供周報月報之類的內(nèi)容，但不作為考評的依據(jù)。我們只 注重結(jié)果，也就是說根據(jù)結(jié)果認(rèn)定過程。432、考評標(biāo)準(zhǔn)1、時效性：不管是承攬項

14、目還是產(chǎn)品研發(fā)都有一定的時間限定，愈期就意味著成本增加 甚至是失敗。所以能否按時完成任務(wù)是績效考評的一個重要標(biāo)致。2、客戶關(guān)注點客戶關(guān)注點也就是軟件的品質(zhì)，涉及的內(nèi)容很多，按國家標(biāo)準(zhǔn)分為六個層面, 即：功能、可靠性、易用性、高效性、可維護(hù)性、可移植性。這六個項目的次序 也就是我們考察的順序，首先必須完成功能，然后再衡量功能是否可靠，再然后 才其他幾個方面，如果以百分制來衡量，這六個指標(biāo)的比例大致是 50, 25, 15, 10, 5, 5o也就是說必須保證前四項。而功能、可靠性又是重中之重75%。3、規(guī)范與標(biāo)準(zhǔn)不以規(guī)矩不能成方園，不遵從標(biāo)準(zhǔn)的與規(guī)范的設(shè)計開發(fā)必將造成巨大的維護(hù) 成本與技術(shù)積累成

15、本，同時也給軟件交流與究錯設(shè)置障礙，所以必須強(qiáng)調(diào)規(guī)范化 與標(biāo)準(zhǔn)化。4、復(fù)用與倉ij新性這是軟件開發(fā)人員設(shè)計與開發(fā)綜合能力的一個集屮體現(xiàn)。5、團(tuán)隊精神沒有團(tuán)隊精神的軟件開發(fā)人員堅決辭退：開發(fā)過程中團(tuán)隊精神主要表現(xiàn)在： 一、對測試出的問題是互相推委，還是協(xié)商解決；二、接口設(shè)計各行其事還是共 同制訂；三、發(fā)現(xiàn)他人犯錯是善意提醒還是沉默不語；四、不注重版本管理。6、奉獻(xiàn)精神任務(wù)比較緊張時候，是否不計較個人得失主動加班加點趕任務(wù)。7、溝通精神不懂問題是拖延時間還是主動尋求幫助，技術(shù)經(jīng)驗是否主動分享。434、考評矩陣開發(fā)人員當(dāng)期任務(wù)評測表任務(wù)書編號:項目1指標(biāo)時效率按時未按時x%(x=100)完成未完成x

16、%y%客戶關(guān)注點功能可靠易用性能維護(hù)移植功能可靠易用性能維護(hù)移植a <50%bw25%cw15%dw10%ew5%fw5%a <50%bw25%cw15%dw10%ew5%fw5%規(guī)范與標(biāo)準(zhǔn)好中差gn6gw4g二 0復(fù)用與創(chuàng)新性好小并h33hw2h=0團(tuán)隊精神好中差t35tw4two-2奉獻(xiàn)精神好中差jel.5-2. 0j 二0. 5j=0.0溝通精神好中差kn3kw2k=0. 0記分(30 + (a+b+c+d+e+f)*40+g+h+i+j+k)*x%功能：實現(xiàn)的結(jié)果是否體現(xiàn)的客戶的意圖，與客戶意圖之間的差距(x%),功能測評比例(lx%)*50% 可靠性：主要以測試出的缺陷多

17、少來衡量，如果一個最低級功能被測出超過三個缺陷，可靠性為零。易用性：重要從數(shù)據(jù)校驗與否、出錯提示信息明細(xì)程度，輸入數(shù)據(jù)量多少，是否符合輸入習(xí)慣四個方面進(jìn)行衡量;性能：主要是響應(yīng)速度可維護(hù)性與可移植性要看與規(guī)范與標(biāo)準(zhǔn)的差距4.4、應(yīng)對一些突發(fā)事件協(xié)調(diào)與調(diào)整）項目可能造成的結(jié)果人員流動招聘、調(diào)配、項目延期突發(fā)性需求商務(wù)談判、項目延期技術(shù)更新利潤損失、技術(shù)積累損失、項目延期法律問題無法進(jìn)展其它4.5. 與有利害關(guān)系的人共享信息項目共享范圍一般信息共享核心信息有限共享專有信息不共享附錄41項目開發(fā)計劃編制項目開發(fā)計劃的目的是用文件的形式，把對于在開發(fā)過程中各項工作的負(fù)責(zé)人員、 開發(fā)進(jìn)度、所需經(jīng)費預(yù)算、

18、所需軟、硬件條件等問題作出的安排記載下來，以便根據(jù)本計 劃開展和檢查本項目的開發(fā)工作。編制內(nèi)容要求如下：1引言1. 1編寫目的說明編寫這份項目開發(fā)計劃的目的，并指出預(yù)期的讀者。1. 2背景說明：a. 待開發(fā)的軟件系統(tǒng)的名稱；b. 本項目的任務(wù)提出者、開發(fā)者、用戶及實現(xiàn)該軟件的計算中心或計算機(jī)網(wǎng)絡(luò)；c.該軟件系統(tǒng)同其他系統(tǒng)或其他機(jī)構(gòu)的基本的相互來往關(guān)系。1. 3定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1. 4參考資料列出用得著的參考資料，如：a. 本項目的經(jīng)核準(zhǔn)的汁劃任務(wù)書或合同、上級機(jī)關(guān)的批文；b. 屬于本項目的英他已發(fā)表的文件；c.本文件中各處引用的文件、資料，包扌舌所

19、要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件 資料的標(biāo)題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。2項目概述2. 1工作內(nèi)容簡要地說明在本項目的開發(fā)中須進(jìn)行的各項主要工作。2. 2主要參加人員扼要說明參加木項目開發(fā)工作的主要人員的情況，包括他們的技術(shù)水平。2. 3產(chǎn)品2. 31稈序列出需移交給用戶的程序的名稱、所用的編程語言及存儲程序的媒體形式，并通過引用 有關(guān)文件，逐項說明其功能和能力。2. 3. 2文件列出需移交給用戶的每種文件的名稱及內(nèi)容要點。2.3.3服務(wù)列出需向用戶提供的各項服務(wù)，如培訓(xùn)安裝、維護(hù)和運行支持等，應(yīng)逐項規(guī)定開始日期、 所提供支持的級別和服務(wù)的期限。2. 3.

20、 4非移交的產(chǎn)品說明開發(fā)集體應(yīng)向本單位交出但不必向用戶移交的產(chǎn)品（文件甚至某些程序）。2. 4驗收標(biāo)進(jìn)對于上述這些應(yīng)交出的產(chǎn)品和服務(wù)，逐項說明或引用資料說明驗收標(biāo)準(zhǔn)。2. 5完成項目的員遲用限2. 6本計劃的批準(zhǔn)者和批準(zhǔn)h期3實施計劃3. 1工作任務(wù)的分門與人員分工對于項日開發(fā)中需完成的各項工作，從需求分析、設(shè)計、實現(xiàn)、測試直到維護(hù)，包括文 件的編制、審批、打印、分發(fā)工作，用戶培訓(xùn)工作，軟件安裝工作等，按層次進(jìn)行分解，指 明每項任務(wù)的負(fù)責(zé)人和參加人員。3. 2接口人員說明負(fù)責(zé)接口工作的人員及他們的職責(zé)，包括：a .負(fù)責(zé)本項目同用戶的接口人員；b. 負(fù)責(zé)本項目同本單位各管理機(jī)構(gòu)，如合同計劃管理部

21、門、財務(wù)部門、質(zhì)量管理部門 等的接口人員；c. 負(fù)責(zé)本項目同各分合同負(fù)責(zé)單位的接口人員等。3. 3進(jìn)度對于需求分析、設(shè)計、編碼實現(xiàn)、測試、移交、培訓(xùn)和安裝等工作，給出每項工作任務(wù) 的預(yù)。定開始口期、完成口期及所需資源，規(guī)定各項工作任務(wù)完成的先后順序以及表征每項 工作任務(wù)完成的標(biāo)志性事件（即所謂“里程碑”）。3. 4預(yù)算逐項列出本開發(fā)項目所需要的勞務(wù)（包括人員的數(shù)量和時i'可）以及經(jīng)費的預(yù)算（包括辦 公費、差旅費、機(jī)時費、資料費、通訊設(shè)備和專用設(shè)備的租金等）和來源。3. 5關(guān)鍵問題逐項列出能夠影響整個項冃成敗的關(guān)鍵問題、技術(shù)難點和風(fēng)險，指出這些問題對項目的 影響。4支持條件說明為支持本項

22、目的開發(fā)所需要的各種條件和設(shè)施。4. 1計算機(jī)系統(tǒng)支持逐項列出開發(fā)中和運行時所需的計算機(jī)系統(tǒng)支持，包括計算機(jī)、外圍設(shè)備、通訊設(shè)備、 模擬器、編譯（或匯編）程序、操作系統(tǒng)、數(shù)據(jù)管理程序包、數(shù)據(jù)存儲能力和測試支持能 力等，逐項給出有關(guān)到貨日期、使用時間的要求。4. 2需由用戶承擔(dān)的工作逐項列出需要用戶承擔(dān)的工作和完成期限。包括需由用戶提供的條件及提供時間。4. 3由外單位提供的條件逐項列出需要外單位分合同承包者承擔(dān)的工作和完成的時間，包括需要由外單位提供的 條件和提供的時間。5專題計劃要點說明本項目開發(fā)中需制訂的各個專題計劃（如分合同計劃、開發(fā)人員培訓(xùn)計劃、測試計 劃、安全保密計劃、質(zhì)量保證計劃、

23、配置管理計劃、用戶培訓(xùn)計劃、系統(tǒng)安裝計劃等）的 要點。附錄42軟件需求說明書軟件需求說明書的編制是為了使用戶和軟件開發(fā)者雙方對該軟件的初始規(guī)定有一個 共同的理解，使之成為整個開發(fā)工作的基礎(chǔ)。編制軟件需求說明書的內(nèi)容要求如下：1引言1. 1編寫目的說明編寫這份軟件需求說明書的冃的，指出預(yù)期的讀者。1. 2背景說明：a. 待開發(fā)的軟件系統(tǒng)的名稱；b. 本項目的任務(wù)提出者、開發(fā)者、用戶及實現(xiàn)該軟件的計算中心或計算機(jī)網(wǎng)絡(luò)；c.該軟件系統(tǒng)同其他系統(tǒng)或其他機(jī)構(gòu)的基本的相互來往關(guān)系。13定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1. 4參考資料列出用得著的參考資料，如：a. 本項目的經(jīng)核

24、準(zhǔn)的計劃任務(wù)書或合同、上級機(jī)關(guān)的批文；b. 屬于本項目的其他已發(fā)表的文件；c. 本文件中各處引用的文件、資料、包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件資 料的標(biāo)題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。2任務(wù)概述2. 1目標(biāo)敘述該項軟件開發(fā)的意圖、應(yīng)用目標(biāo)、作用范圍以及其他應(yīng)向讀者說明的有關(guān)該軟件開 發(fā)的背景材料。解釋被開發(fā)軟件與其他有關(guān)軟件之間的關(guān)系。如果本軟件產(chǎn)品是一項獨立的 軟件，而且全部內(nèi)容自含，則說明這一點。如果所定義的產(chǎn)品是一個更大的系統(tǒng)的一個組成 部分，則應(yīng)說明本產(chǎn)品與該系統(tǒng)中其他各組成部分之間的關(guān)系，為此可使用一張方框圖來說 明該系統(tǒng)的組成和木產(chǎn)品同其他

25、各部分的聯(lián)系和接口。i2. 2用戶的特點列出本軟件的最終用戶的特點，充分說明操作人員、維護(hù)人員的教育水平和技術(shù)專長， 以及本軟件的預(yù)期使甩頻度。這些是軟件設(shè)計工作的重要約朿2. 3假定和約束列出進(jìn)行木軟件開發(fā)工作的假定和約束，例如經(jīng)費限制、開發(fā)期限等。3需求規(guī)定3. 1對功能的規(guī)定用列表的方式（例如ipo表即輸入、處理、輸出表的形式），逐項定量和定性地敘述對 軟件所提出的功能要求，說明輸入什么量、經(jīng)怎樣的處理、得到什么輸出，說明軟件應(yīng)支持 的終端數(shù)和應(yīng)支持的并行操作的用戶數(shù)。3. 2對性能的規(guī)定3. 2. 1精度說明對該軟件的輸入、輸出數(shù)據(jù)精度的要求，可能包括傳輸過程中的精度。3. 2. 2時

26、間特性要求說明對于該軟件的時間特性要求，如對：a. 響應(yīng)時間;b. 更新處理時間；c. 數(shù)據(jù)的轉(zhuǎn)換和傳送時i'可；d. 解題時間；等的要求。3. 2. 3靈活性說明對該軟件的靈活性的要求，即當(dāng)需求發(fā)生某些變化時，該軟件對這些變化的適應(yīng)能 力，如：a. 操作方式上的變化；b. 運行環(huán)境的變化；c. 同其他軟件的接口的變化；d. 精度和有效時限的變化；e. 計劃的變化或改進(jìn)。對于為了提供這些靈活性而進(jìn)行的專門設(shè)計的部分應(yīng)該加以標(biāo)明。3. 3輸人輸出要求解釋各輸入輸出數(shù)據(jù)類型，并逐項說明其媒體、格式、數(shù)值范圍、精度等。對軟件的數(shù) 據(jù)輸出及必須標(biāo)明的控制輸出暈進(jìn)行解釋并舉例，包括對硬拷貝報告（

27、止常結(jié)果輸出、狀態(tài) 輸出及異常輸出）以及圖形或顯示報告的描述。3. 4數(shù)據(jù)管理能力要求說明需要管理的文卷和記錄的個數(shù)、表和文卷的大小規(guī)模，要按可預(yù)見的增長對數(shù)據(jù)及 其分量的存儲要求作出估算。3. 5故障處理要求列出可能的軟件、硬件故障以及對各項性能而言所產(chǎn)生的后果和對故障處理的要求。3. 6其他專門要求如用戶單位對安全保密的要求，對使用方便的要求，對可維護(hù)性、可補(bǔ)充性、易讀性、 可靠性、運行環(huán)境可轉(zhuǎn)換性的特殊要求等。4運行環(huán)境規(guī)定4. 1設(shè)備列出運行該軟件所需要的硬設(shè)備。說明其屮的新型設(shè)備及其專門功能，包括：a. 處理器型號及內(nèi)存容量；b. 外存容量、聯(lián)機(jī)或脫機(jī)、媒體及其存儲格式，設(shè)備的型號及

28、數(shù)量；c. 輸入及輸出設(shè)備的型號和數(shù)量，聯(lián)機(jī)或脫機(jī)；d. 數(shù)據(jù)通信設(shè)備的型號和數(shù)量；e. 功能鍵及其他專用硬件4. 2支持軟件列出支持軟件，包扌舌要用到的操作系統(tǒng)、編譯（或匯編）程序、測試支持軟件等。4. 3 接口說明該軟件同其他軟件之間的接口、數(shù)據(jù)通信協(xié)議等。4. 4控制說明控制該軟件的運行的方法和控制信號，并說明這些控制信號的來源。附錄43詳細(xì)設(shè)計說明書1引言1. 1編寫目的說明編寫這份詳細(xì)設(shè)計說明書的目的，指出預(yù)期的讀者。1. 2背景說明：a. 待開發(fā)軟件系統(tǒng)的名稱；b. 本項目的任務(wù)提出者、開發(fā)者、用戶和運行該程序系統(tǒng)的計算中心。1. 3定義列出本文件中用到專門術(shù)語的定義和外文首字母組

29、詞的原詞組。1. 4參考資料列出有關(guān)的參考資料，如：a. 本項目的經(jīng)核準(zhǔn)的汁劃任務(wù)書或合同、上級機(jī)關(guān)的批文；b. 屬于本項目的英他已發(fā)表的文件；c. 本文件中各處引用到的文件資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件的 標(biāo)題、文件編號、發(fā)表日期和出版單位，說明能夠取得這些文件的來源。2程序系統(tǒng)的結(jié)構(gòu)用一系列圖表列出本程序系統(tǒng)內(nèi)的每個程序（包括每個模塊和子程序）的名稱、標(biāo)識符 和它們之間的層次結(jié)構(gòu)關(guān)系。3程序1 （標(biāo)識符）設(shè)計說明從本章開始，逐個地給出各個層次中的每個程序的設(shè)計考慮。以下給出的提綱是針對一 般情況的。對于一個具體的模塊，尤其是層次比較低的模塊或子程序，其很多條目的內(nèi)容 往往與

30、它所隸屬的上一層模塊的對應(yīng)條目的內(nèi)容相同，在這種情況下，只要簡單地說明這 一點即可。3. 1程序描述給出對該程序的簡要描述，主要說明安排設(shè)計本程序的目的意義，并且，還要說明本程 序的特點（如是常駐內(nèi)存還是非常駐？是否子程序？是可重人的還是不可重人的？有無覆 蓋要求？是順序處理還是并發(fā) 處理卜等）。3. 2功能說明該程序應(yīng)具有的功能，可采用ipo圖（即輸入一處理一輸出圖）的形式。3. 3性能說明對該程序的全部性能要求，包括對精度、靈活性和時間特性的要求。3. 4輸人項給出對每一個輸入項的特性，包括名稱、標(biāo)識、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范圍、 輸入的方式。數(shù)量和頻度、輸入媒體、輸入數(shù)據(jù)的來源和

31、安全保密條件等等。3.5輸出項給出對每一個輸出項的特性，包括名稱、標(biāo)識、數(shù)據(jù)的類型和格式，數(shù)據(jù)值的有效范圍, 輸出的形式、數(shù)量和頻度，輸出媒體、對輸出圖形及符號的說明、安全保密條件等等。3. 6算法詳細(xì)說明本程序所選用的算法，具體的計算公式和計算步驟。3. 7流程邏輯用圖表（例如流程圖、判定表等）輔以必要的說明來表示木程序的邏輯流程。3. 8 接口用圖的形式說明本程序所隸屬的上一層模塊及隸屬于本程序的下一層模塊、子程序，說 明參數(shù)賦值和調(diào)用方式，說明與本程序相直接關(guān)聯(lián)的數(shù)據(jù)結(jié)構(gòu)（數(shù)據(jù)庫、數(shù)據(jù)文卷）。3. 9存儲分配根據(jù)需要，說明木程序的存儲分配。3. 10注釋設(shè)計說明準(zhǔn)備在本程序中安排的注釋，

32、如：a. 加在模塊首部的注釋；b. 加在各分枝點處的注釋；對各變量的功能、范圉、缺省條件等所加的注釋；d. 對使用的邏輯所加的注釋等等。3. 11限制條件說明本程序運行中所受到的限制條件。3. 12測試計劃說明對本程序進(jìn)行單體測試的計劃，包插對測試的技術(shù)要求、輸入數(shù)據(jù)、預(yù)期結(jié)果、進(jìn) 度安排、人員職責(zé)、設(shè)備條件驅(qū)動程序及樁模塊等的規(guī)定。3. 13尚未解決的問題說明在本程序的設(shè)計屮尚未解決而設(shè)計者認(rèn)為在軟件完成之前應(yīng)解決的問題。4程序2（標(biāo)識符）設(shè)計說明用類似3的方式，說明第2個程序乃至第n個程序的設(shè)計考慮。附錄44用戶手冊1引言1. 1編寫目的說明編寫這份用戶手冊的目的，指出預(yù)期的讀者。1. 2

33、背景說明：a. 這份用戶手冊所描述的軟件系統(tǒng)的名稱；b. 該軟件項目的任務(wù)提出者、開發(fā)者、用戶（或首批用戶）及安裝此軟件的計算中心。1. 3定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1. 4參考資料列出有用的參考資料，如：a. 項目的經(jīng)核準(zhǔn)的汁劃任務(wù)書或合同、上級機(jī)關(guān)的批文；b. 屬于本項目的英他已發(fā)表文件；c. 本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件資 料的標(biāo)題、文件編號、發(fā)表日期和出版單位，說明能夠取得這些文件資料的來源。2用途2. 1功能結(jié)合本軟件的開發(fā)目的逐項地說明本軟件所具有各項功能以及它們的極限范圍。2. 2性能2. 21精度逐項

34、說明對各項輸入數(shù)據(jù)的精度要求和木軟件輸出數(shù)據(jù)達(dá)到的精度，包括傳輸屮的精度 要求。2. 2. 2時間特性定量地說明本軟件的時間特性，如響應(yīng)時間，更新處理時間，數(shù)據(jù)傳輸、轉(zhuǎn)換時間，計 算時間等。2. 2. 3靈活性說明本軟件所具有的靈活性，即當(dāng)用戶需求（如對操作方式、運行環(huán)境、結(jié)果精度、時 間特性等的要求）有某些變化時，本軟件的適應(yīng)能力。2. 3安全保密說明木軟件在安全、保密方面的設(shè)計考慮和實際達(dá)到的能力。3運行環(huán)境3. 1硬設(shè)備列出為運行本軟件所要求的硬設(shè)備的最小配置，如：a. 處理機(jī)的型號、內(nèi)存容量；b. 所要求的外存儲器、媒體、記錄格式、設(shè)備的型號和臺數(shù)、聯(lián)機(jī)/脫機(jī)；c. i/o設(shè)備（聯(lián)機(jī)/

35、脫機(jī)？）；d. 數(shù)據(jù)傳輸設(shè)備和轉(zhuǎn)換設(shè)備的型號、臺數(shù)。3. 2支持軟件說明為運行本軟件所需要的支持軟件，如：a. 操作系統(tǒng)的名稱、版本號；b. 程序語言的編譯/匯編系統(tǒng)的名稱和版本號；c. 數(shù)據(jù)庫管理系統(tǒng)的名稱和版本號；d. 其他支持軟件。3. 3數(shù)據(jù)結(jié)構(gòu)列出為支持本軟件的運行所需要的數(shù)據(jù)庫或數(shù)據(jù)文卷。4使用過程在本章，首先用圖表的形式說明軟件的功能同系統(tǒng)的輸入源機(jī)構(gòu)、輸出接收機(jī)構(gòu)z間的 關(guān)系。4. 1安裝與初始化一步一步地說明為使用本軟件而需進(jìn)行的安裝與初始化過程，包扌舌程序的存儲形式、安 裝與初始化過程屮的全部操作命令、系統(tǒng)對這些命令的反應(yīng)與答復(fù)。表征安裝工作完成的測 試實例等。如果有的話，

36、還應(yīng)說明安裝過程中所需用到的專用軟件。4. 2輸入規(guī)定輸入數(shù)據(jù)和參量的準(zhǔn)備要求。4. 2. 1輸入數(shù)據(jù)的現(xiàn)實背景說明輸入數(shù)據(jù)的現(xiàn)實背景，主要是乩情況-例如人員變動、庫存'缺貨；b. 情況出現(xiàn)的頻度-例如是周期性的、隨機(jī)的、一項操作狀態(tài)的函數(shù).c. 情況來源一例如人事部門、倉庫管理部門；d. 輸入媒體例如鍵盤、穿孔卡片、磁帶；e. 限制-出于安全、保密考慮而對訪問這些輸入數(shù)據(jù)所加的限制；f質(zhì)量管理-例如對輸入數(shù)據(jù)合理性的檢驗以及當(dāng)輸入數(shù)據(jù)有錯誤時應(yīng)釆取的措施，如 建立出錯情況的記錄等；g.支配-例如如何確定輸入數(shù)據(jù)是保留還是廢棄，是否要分配給其他的接受者等。4. 2. 2輸入格式說明對初

37、始輸入數(shù)據(jù)和參暈的格式要求，包括語法規(guī)則和有關(guān)約定，如：a. 長度一例如字符數(shù)/行，字符數(shù)/項；b. 格式基準(zhǔn)-例如以左面的邊沿為基準(zhǔn)；c. 標(biāo)號例如標(biāo)記或標(biāo)識符；d. 順序例如各個數(shù)據(jù)項的次序及位置；e. 標(biāo)點-例如用來表示行、數(shù)據(jù)組等的開始或結(jié)束而使用的空格、斜線、星號、字符 組等。f. 詞匯表-給出允許使用的字符組合的列表，禁止使用*的字符組合的列表等；g. 省略和重復(fù)給出用來表示輸人元素可省略或重復(fù)的表示方式；h. 控制-給出用來表示輸入開始或結(jié)束的控制信息。h. 4. 2. 3輸入舉例為每個完整的輸入形式提供樣本，包括：a. 控制或首部-例如用來表示輸入的種類和類型的信息，標(biāo)識符輸入

38、日期，正文起點 和對所用編碼的規(guī)定：b. 主體輸入數(shù)據(jù)的主體，包括數(shù)據(jù)文卷的輸入表述部分；c. 尾部-用來表示輸入結(jié)束的控制信息，累計字符總數(shù)等；d. 省略-指出哪些輸入數(shù)據(jù)是可省略的；e. 重復(fù)指出哪些輸入數(shù)據(jù)是重復(fù)的。4. 3輸出對每項輸出作出說明.4. 31輸岀數(shù)據(jù)的現(xiàn)實背景，說明輸岀數(shù)據(jù)的現(xiàn)實背景，主要是：a. 使用“這些輸出數(shù)據(jù)是給誰的，用來干什么；b. 使用頻度-例如每周的、定期的或備查閱的；c. 媒體-打印、cri顯示、磁帶、卡片、磁盤，d. 質(zhì)量管理一例如關(guān)于合理性檢驗、出錯糾正的規(guī)定；e. 支配-例如如何確定輸出數(shù)據(jù)是保留還是廢棄，是否要分配給其他接受者等。4. 3. 2輸出

39、格式給出對每一類輸出信息的解釋，主要是：a. 首部如輸出數(shù)據(jù)的標(biāo)識符，輸出日期和輸出編號；b. 主體-輸出信息的主體，包括分欄標(biāo)題；c. 尾部包括累計總數(shù)，結(jié)束標(biāo)記。4. 3. 3輸出舉例為每種輸出類型提供例子。對例子中的每一項，說明：a. 定義每項輸出信息的意義和用途；b. 來源-是從特定的輸入中抽出、從數(shù)據(jù)庫文卷屮取出、或從軟件的計算過程屮得到c. 特性-輸出的值域、計量單位、在什么情況下可缺省等。4. 4文卷查詢這一條的編寫針對具有查詢能力的軟件，內(nèi)容包括：同數(shù)據(jù)庫查詢有關(guān)的初始化、準(zhǔn)備、 及處理所需耍的詳細(xì)規(guī)定，說明查詢的能力、方式，所使用的命令和所要求的控制規(guī)定。4. 5出錯處理和恢

40、復(fù)列出由軟件產(chǎn)生的出錯編碼或條件以及應(yīng)由用戶承擔(dān)的修改糾正工作。指出為了確保再 啟動和恢復(fù)的能力，用戶必須遵循的處理過程。4. 6終端操作當(dāng)軟件是在多終端系統(tǒng)上工作時，應(yīng)編寫本條，以說明終端的配置安排、連接步釋、數(shù) 據(jù)和參數(shù)輸入步驟以及控制規(guī)定.說明通過終端操作進(jìn)行查詢、檢索、修改數(shù)據(jù)文卷的能 力、語言、過程以及輔助性程 序等。附錄45數(shù)據(jù)要求說明書1引言1. 1編寫目的說明編寫這份數(shù)據(jù)要求說明書的目的，指出預(yù)期的讀者。1. 2背景說明：a. 待開發(fā)軟件系統(tǒng)的名稱；b. 列出本項目的任務(wù)提出者、開發(fā)者、用戶以及將運行該項軟件的計算站（中心）或 計算機(jī)網(wǎng)絡(luò)系統(tǒng)。1. 3定義列出本文件中用到的專門

41、術(shù)語的定義和外文首字母組詞的原詞組。1. 4參考資料列出有關(guān)的參考資料，如：a. 本項目的經(jīng)核準(zhǔn)的計劃任務(wù)書或合同，上級機(jī)關(guān)的批文；b. 屬于本項目的其他已發(fā)表文件；c. 本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件的 標(biāo)題、文件編號、發(fā)表日期和出版單位。說明能夠得到這些文件資料的來源。2數(shù)據(jù)的邏輯描述対數(shù)據(jù)進(jìn)行邏輯描述時可把數(shù)據(jù)分為動態(tài)數(shù)據(jù)和靜態(tài)數(shù)據(jù)。所謂靜態(tài)數(shù)據(jù)，指在運行過 程中主要作為參考的數(shù)據(jù)，它們在很長的一段時間內(nèi)不會變化，一般不隨運行而改變。所 謂動態(tài)數(shù)據(jù).包扌舌所有在運行中要發(fā)生變化的數(shù)據(jù)以及在運行中耍輸入、輸出的數(shù)據(jù)。進(jìn) 行描述時應(yīng)把各數(shù)據(jù)元素邏輯地分

42、成若干 組，列如函數(shù)、源數(shù)據(jù)或?qū)τ谄鋺?yīng)用更為恰當(dāng)?shù)?邏輯分組。給出每一數(shù)據(jù)元的名稱（包括縮寫和代碼）、定義（或物理意義）度量單位、值 域、格式和類型等有關(guān)信息。2. 1靜態(tài)數(shù)據(jù)列出所有作為控制或參考用的靜態(tài)數(shù)據(jù)元素。2. 2動態(tài)輸人數(shù)據(jù)列出動態(tài)輸入數(shù)據(jù)元素（包括在常規(guī)運行中或聯(lián)機(jī)操作中要改變的數(shù)據(jù)）。2. 3動態(tài)輸出數(shù)據(jù)列出動態(tài)輸出數(shù)據(jù)元素（包括在常規(guī)運行中或聯(lián)機(jī)操作中要改變的數(shù)據(jù)）。2. 4內(nèi)部生成數(shù)據(jù)列出向用戶或開發(fā)單位中的維護(hù)調(diào)試人員提供的內(nèi)部生成數(shù)據(jù)。2. 5數(shù)據(jù)約定說明對數(shù)據(jù)要求的制約。逐條列出對進(jìn)一步擴(kuò)充或使用方面的考慮而提出的對數(shù)據(jù)要求 的限制（容量、文卷、記錄和數(shù)據(jù)元的個數(shù)的最

43、大值）。對于在設(shè)計和開發(fā)中確定是臨界性 的限制更要明確指出。3數(shù)據(jù)的采集3. 1要求和范圍按數(shù)據(jù)元的邏輯分組來說明數(shù)據(jù)采集的要求和范圍，指明數(shù)據(jù)的釆集方法，說明數(shù)據(jù)采 集工作的承擔(dān)者是用戶還是開發(fā)者。具體的內(nèi)容包括：a.輸入數(shù)據(jù)的來源，例如是單個操作員、數(shù)據(jù)輸入站，專業(yè)的數(shù)據(jù)輸入公司或它們的一個分組；b.數(shù)據(jù)輸入（指把數(shù)據(jù)輸入處理系統(tǒng)內(nèi)部）所用的媒體和碩設(shè)備。如果只有指定的輸 入點的輸入才是合法的，則必須對此加以說明；c.接受者說明輸出數(shù)據(jù)的接受者；d. 輸岀數(shù)據(jù)的形式和設(shè)備列出輸出數(shù)據(jù)的形式和硬設(shè)備。無論接受者將接收到的數(shù)據(jù) 是打印輸出，還是crt上的一組字符、一幀圖形，或一聲警鈴，或向開關(guān)

44、線圈提供的一個 電脈沖，或常用介質(zhì)如磁盤、磁帶、穿孔卡片等，均應(yīng)具體說明；e. 數(shù)據(jù)值的范圍給出每一個數(shù)據(jù)元的合法值的范圍；f. 量綱給出數(shù)字的度量單位、增量的步長、零點的定標(biāo)等。在數(shù)據(jù)是非數(shù)字量的情況 下，要給出每一種合法值的形式和含意；g. 更新和處理的頻度給出預(yù)定的對輸入數(shù)據(jù)的更新和處理的頻度。如果數(shù)據(jù)的輸入是 隨機(jī)的，應(yīng)給出更新處理的頻度的平均值，或變化情況的某種其他度量。3. 2輸人的承擔(dān)者說明預(yù)定的對數(shù)據(jù)輸入工作的承擔(dān)者。如果輸入數(shù)據(jù)同某一接口軟件有關(guān)，還應(yīng)說明該 接口軟件的來源。3. 3預(yù)處理對數(shù)據(jù)的采集和預(yù)處理過程提出專門的規(guī)定，包括適合應(yīng)用的數(shù)據(jù)格式、預(yù)定的數(shù)據(jù)通 信媒體和對

45、輸入的時間要求等。對于需經(jīng)模擬轉(zhuǎn)換或數(shù)字轉(zhuǎn)換處理的數(shù)據(jù)量，要給出轉(zhuǎn)換方 法和轉(zhuǎn)換因子等有關(guān)信息，以便軟件系統(tǒng)使用這些數(shù)據(jù)。3. 4影響說明這些數(shù)據(jù)要求對于設(shè)備、軟件、用戶、開發(fā)單位所可能產(chǎn)生的影響，例如要求用戶單位增設(shè)某個機(jī)構(gòu)等。附錄46項目開發(fā)總結(jié)報告i引言1. 1編寫目的說明編寫這份項目開發(fā)總結(jié)報告的目的，指出預(yù)期的閱讀范圍。1. 2背景說明：a. 本項目的名稱和所開發(fā)出來的軟件系統(tǒng)的名稱；b. 此軟件的任務(wù)提出者、開發(fā)者、用戶及安裝此軟件的計算中心。i. 3定義列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。1. 4參考資料列出要用到的參考資料，如：a. 本項目的已核準(zhǔn)的汁劃任

46、務(wù)書或合同、上級機(jī)關(guān)的批文；b. 屬于本項目的英他已發(fā)表的文件；c. 本文件中各處所引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。列出這些文件 的標(biāo)題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。2實際開發(fā)結(jié)果2. 1產(chǎn)品說明最終制成的產(chǎn)品，包括：a. 程序系統(tǒng)中各個程序的名字，它們之間的層次關(guān)系，以千字節(jié)為單位的各個程序的 程序量、存儲媒體的形式和數(shù)量；b. 程序系統(tǒng)共有哪兒個版本，各自的版本號及它們之間的區(qū)別；c. 每個文件的名稱；d. 所建立的每個數(shù)據(jù)庫。如果開發(fā)中制訂過配置管理計劃，要同這個計劃相比較。2. 2主要功能和性能逐項列出木軟件產(chǎn)品所實際具有的主要功能和性能

47、，對照可行性研究報告、項目開發(fā)計 劃、功能需.求說明書的有關(guān)內(nèi)容，說明原定的開發(fā)目標(biāo)是達(dá)到了、未完全達(dá)到、或超過 了。2. 3基本流程用圖給出本程序系統(tǒng)的實際的基本的處理流程。2. 4進(jìn)度列出原定計劃進(jìn)度與實際進(jìn)度的對比，明確說明，實際進(jìn)度是提前了、還是延遲了，分 析主要原因。2. 5費用列出原定計劃費用與實際支出費用的對比，包括：a. 工時，以人月為單位，并按不同級別統(tǒng)計；b. 計算機(jī)的使用時間，區(qū)別cpu時間及其他設(shè)備時間；c. 物料消耗、出差費等其他支出。明確說明，經(jīng)費是超出了、還是節(jié)余了，分析其主要原因。3開發(fā)工作評價3. 1對生產(chǎn)效率的評價給出實際生產(chǎn)效率，包括：a. 程序的平均生產(chǎn)

48、效率，即每人月生產(chǎn)的行數(shù)；b. 文件的平均生產(chǎn)效率，即每人月生產(chǎn)的千字?jǐn)?shù)；并列出原訂計劃數(shù)作為對比。3. 2對產(chǎn)品質(zhì)量的評價說明在測試屮檢查出來的程序編制屮的錯誤發(fā)生率，即每干條指令（或語句）屮的錯誤 指令數(shù)（或語句數(shù)）。如果開發(fā)小制訂過質(zhì)量保證計劃或配置管理計劃，要同這些計劃相比 較。3. 3對技術(shù)方法的評價給出對在開發(fā)中所使用的技術(shù)、方法、工具、手段的評價。3. 4出錯原因的分析給出對于開發(fā)中出現(xiàn)的錯誤的原因分析。4經(jīng)驗與教訓(xùn)列出從這項開發(fā)工作中所得到的最主要的經(jīng)驗與教訓(xùn)及對今后的項目開發(fā)工作的建議。附錄5-1 java編碼規(guī)范1、命名規(guī)范定義這個規(guī)范的目的是讓項目中所有的文檔都看起來像一

49、個人寫的，增加可 讀性，減少項目組中因為換人而帶來的損失。命名一般以簡介單詞構(gòu)成。1、package的命名package的名字應(yīng)該都是由一個小寫單詞組成。package com. neu. util2> class的命名class的名字必須由大寫字母開頭而其他字母都小寫的單詞組成，對于所有 標(biāo)識符，其中包含的所有單詞都應(yīng)緊靠在一起，而且大寫中間單詞的首字母。public class thisaclassname 3、class變量的命名變量的名字必須用一個小寫字母開頭。后面的單詞用大寫字母開頭uscrnamc , thisaclassme thod4、static final變量的命名s

50、tatic final變量的名字應(yīng)該都大寫，并且指岀完整含義。public static final stringdb_config_file_patll 二"com. neu. etrain, dbconfig"5、參數(shù)的命名參數(shù)的名字必須和變量的命名規(guī)范一致。6、數(shù)組的命名數(shù)組應(yīng)該總是用下面的方式來命名: byte buffer;而不是：byte buffer;7、方法的參數(shù)使用有意義的參數(shù)命名，如果可能的話，使用和要賦值的字段一樣的名 字：sctcountcr(int size) this, size = size;2、注視規(guī)范java的注釋有三種/注釋一行/* */

51、注釋若干行/* */注釋若干行，并寫入javadoc文檔，也叫java文檔注釋注釋要簡單明了。string username = null; /用戶名邊寫代碼邊注釋，修改代碼同時修改相應(yīng)的注釋，以保證注釋與代碼的一致 性。在必要的地方注釋，注釋量要適中。注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確， 防止注釋二義性。保持注釋與其描述的代碼相鄰，即注釋的就近原則。對代碼的注釋應(yīng)放在其上方相鄰位置，不可放在下面。對數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng) 放在其上方相鄰位置，不可放在下面；對結(jié)構(gòu)中的每個域的注釋應(yīng)放在此域 的右方；同一結(jié)構(gòu)中不同域的注釋要對齊。變量、常量的注釋應(yīng)放在其上方相鄰位置或右方。全局變量要有較詳細(xì)的注釋，包括

52、對其功能、取值范圍、哪些函數(shù)或過程存 取它以及存取時注意事項等的說明。在每個源文件的頭部要有必要的注釋信息，包括：文件名；版本號；作者； 生成日期；模塊功能描述(如功能、主要算法、內(nèi)部各部分之間的關(guān)系、該 文件與其它文件關(guān)系等)；主要函數(shù)或過程清單及本文件歷史修改記錄等。/* copy right in forma tion:st soft* pro jec t:jscbmis* jdk version used:jdkl. 5. 09* comments:config pa th* version:1. 01* modification history:2007. 5. 1* srdatem

53、odified by why & what is modified* 1.2003. 5.2 david li new在每個函數(shù)或過程的前面要有必要的注釋信息，包括：函數(shù)或過程名稱；功 能描述；輸入、輸出及返回值說明；調(diào)用關(guān)系及被調(diào)用關(guān)系說明等/* description :checkout 提款* param hash table cart info* param ordcrbean order info* rcturn string*/public string checkout (hashtable htcart,orderbean orderbean) throws excep

54、tion javadoc注釋標(biāo)簽語法author對類的說明標(biāo)明開發(fā)該類模塊的作者version對類的說明標(biāo)明該類模塊的版本see對類、屬性、方法的說明參考轉(zhuǎn)向，也就是相關(guān)主題param對方法的說明對方法中某參數(shù)的說明return對方法的說明對方法返回值的說明©exception對方法的說明對方法可能拋出的異常進(jìn)行說明3、排版規(guī)范1. 關(guān)鍵詞和操作符z間加適當(dāng)?shù)目崭瘛?. 相對獨立的程序塊與塊之間加空行3. 較長的語句、表達(dá)式等要分成多行書寫。4. 劃分出的新行要進(jìn)行適應(yīng)的縮進(jìn)，使排版整齊，語句可讀。5. 長表達(dá)式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首。6. 循環(huán)、判斷等語句中若有較長的表達(dá)式或語句，則要進(jìn)行適應(yīng)的劃分。7. 若函數(shù)或過程中的參數(shù)較長，則要進(jìn)行適當(dāng)?shù)膭澐帧?amp;不允許把多個短語句寫在一行中，即一行只寫一條語句。9. 函數(shù)或過程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷等語句中的代碼都要采用 縮進(jìn)風(fēng)格。10. c/c+語言是用大括號和界定一段程序塊的，