實(shí)用文檔03軟件公司軟件項(xiàng)目研發(fā)管理制度版

1、2目錄一、總述 2二、項(xiàng)目計(jì)劃三、項(xiàng)目組織四、項(xiàng)目管理4.1、軟件開(kāi)發(fā)規(guī)范 44.1.1、命名體系 4.1.2、編碼風(fēng)格 4.1.3、界面風(fēng)格 4.1.4、版本控制 4.1.5、通用約束 4.1.6、開(kāi)發(fā)方法 4.1.7、開(kāi)發(fā)流程 4.1.8、交流制度 4.1.9、代碼標(biāo)準(zhǔn)化管理 4.1.10、備份制度 6 4.1.11、文檔管理 6 4.1.12、項(xiàng)目交付管理 4.1.13、項(xiàng)目歸檔管理4.2 、任務(wù)分解與分目標(biāo)制定4.3 、進(jìn)度檢查與績(jī)效考評(píng)4.3.1、考評(píng)原則 4.3.2、考評(píng)標(biāo)準(zhǔn) 4.3.4、考評(píng)矩陣附錄 附錄 附錄 附錄 附錄 附錄 附錄 附錄 附錄4.4、應(yīng)對(duì)一些突發(fā)事件（協(xié)調(diào)與調(diào)

2、整） 11 4.5 、與有利害關(guān)系的人共享信息 11 4-1 項(xiàng)目開(kāi)發(fā)計(jì)劃 11 4-2 軟件需求說(shuō)明書 4-3 詳細(xì)設(shè)計(jì)說(shuō)明書 4-4 用戶手冊(cè) 164-5 數(shù)據(jù)要求說(shuō)明書1315194-6 項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告 205-1 JAVA 編碼規(guī)范 225-2 應(yīng)用結(jié)構(gòu)定義與命名規(guī)范 275-3 數(shù)據(jù)庫(kù)對(duì)象命名規(guī)范 28、總述項(xiàng)目管理覆蓋整個(gè)項(xiàng)目生命周期，管理制度就是落實(shí)到管理過(guò)程中的一些基 本要素，這里我們將其概括為三項(xiàng)基本業(yè)務(wù)：I、項(xiàng)目計(jì)劃 指明要取得的各種結(jié)果 指定進(jìn)度表 估計(jì)所需資源U、項(xiàng)目組織落實(shí)項(xiàng)目體系中的角色配置與角色的職責(zé)m、項(xiàng)目管理 約束 任務(wù)分解與分目標(biāo)制定 進(jìn)度檢查與質(zhì)量評(píng)估

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

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

5、統(tǒng)支持”屬于臨時(shí)調(diào)配，很可能是外部資源，但工作質(zhì)量由開(kāi)發(fā)經(jīng)理檢查。質(zhì)量控制由質(zhì)量經(jīng)理、開(kāi)發(fā)經(jīng)理、項(xiàng)目經(jīng)理聯(lián)合統(tǒng)籌，以質(zhì)量經(jīng)理意見(jiàn)為主。整個(gè)項(xiàng)目生命周期中一般角色責(zé)任定義如下:軟件開(kāi)發(fā)可分弼 過(guò)程，宣義、役計(jì).細(xì)碼、系城測(cè)試、制移植、遠(yuǎn)行等過(guò)程.職責(zé)角色定義需要定丈問(wèn)題說(shuō)明書項(xiàng)目經(jīng)理扮析員開(kāi)始項(xiàng)目規(guī)劃項(xiàng)目規(guī)劃分析員設(shè)計(jì)設(shè)計(jì)肓翼設(shè)計(jì)說(shuō)明書分析員編碼編碼說(shuō)明書井析員彌級(jí)程序費(fèi)將程序霽咸到系統(tǒng)中霽咸測(cè)試說(shuō)開(kāi)書程序員測(cè)試驗(yàn)證系統(tǒng)功能與性能系統(tǒng)測(cè)試說(shuō)朋書測(cè)試員/分新員接收向客戶演示系統(tǒng)操作說(shuō)明書項(xiàng)目經(jīng)理膳戶移植移植最終運(yùn)行環(huán)境移植說(shuō)明書分析員倚級(jí)程序員數(shù)據(jù)采集圧導(dǎo)入分析員傕仔員運(yùn)行用戶培訓(xùn)用戶堵訓(xùn)文檔井析

6、員/用戶監(jiān)控系統(tǒng)運(yùn)行性能用戶第析員四、項(xiàng)目管理4.1、軟件開(kāi)發(fā)規(guī)范這里只是給出我司軟件開(kāi)發(fā)必須遵從的原則，具體內(nèi)容應(yīng)該由項(xiàng)目經(jīng)理或開(kāi)發(fā)經(jīng)理根據(jù)具體項(xiàng)目制定詳盡約定。在羅列規(guī)范之前，開(kāi)發(fā)組織（團(tuán)隊(duì)）必須遵 從一個(gè)最基本的約定一一統(tǒng)一開(kāi)發(fā)環(huán)境：OS:操作系統(tǒng)；IDE :集成開(kāi)發(fā)工具；DEBUG :調(diào)試工具;SC：源代碼控制器；IM:即時(shí)交流工具；DD:文檔工具（計(jì)劃，任務(wù)，報(bào)告）；ASM:間接交流工具，一般以mail為主。另外還要為團(tuán)隊(duì)固定一些一些角色，builder / Server administrator（ dba&oss）。嚴(yán)格區(qū)分開(kāi)發(fā)平臺(tái)與生產(chǎn)平臺(tái)之間的界限（安全、測(cè)試、性能）4.1.

7、1、命名體系數(shù)據(jù)庫(kù)與數(shù)據(jù)庫(kù)對(duì)象命名；B)C)頁(yè)面與頁(yè)面元素命名.D)文件目錄體系開(kāi)發(fā)語(yǔ)言的元素命名（類、對(duì)象、文件、命名空間、組件、函數(shù)、方法等）；4.1.2、編碼風(fēng)格縮進(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àn)、提示信息、響應(yīng)時(shí)間與響應(yīng)方式4.1.6、開(kāi)發(fā)方法鑒于用戶需求的不容易澄清性與變動(dòng)頻繁這一特點(diǎn)， 所有項(xiàng)目均采用迭代開(kāi) 發(fā)方法。這就是說(shuō)不要指望在明確的需求調(diào)研階段能把問(wèn)題搞清楚，弄清楚個(gè)大概即可，以不超過(guò)兩周的迭代間隔快

8、速的交互原型，以便反饋更進(jìn)一步的需求、 這樣一步步逼近用戶的真實(shí)想法。 這里要特別強(qiáng)調(diào)的是多與用戶交流，項(xiàng)目組內(nèi) 有關(guān)設(shè)計(jì)方法與策略也要頻繁地交流。4.1.7、開(kāi)發(fā)流程純粹從開(kāi)發(fā)的角度我們將項(xiàng)目周期劃分為兩個(gè)階段，每個(gè)階段要完成的的如下:業(yè)務(wù)需求調(diào)研（業(yè)務(wù)需求規(guī)范說(shuō)明書網(wǎng)站風(fēng)格整體設(shè)計(jì)制定C項(xiàng)目開(kāi)發(fā)計(jì)劃技術(shù)方S實(shí)施說(shuō)明書項(xiàng)目約定書開(kāi)發(fā)環(huán)境的淮備制定項(xiàng)目開(kāi)發(fā)管理規(guī)范書業(yè)務(wù)贏程總體設(shè)計(jì)書*k數(shù)據(jù)庫(kù)關(guān)系設(shè)計(jì)圖&任務(wù)分配文檔V4.1.8、交流制度項(xiàng)目組每周至少要進(jìn)行不少于兩次的集體交流， 否則就是開(kāi)發(fā)經(jīng)理或項(xiàng)目經(jīng) 理失職（交流不限制時(shí)間長(zhǎng)短、方式、內(nèi)容可以從需要到設(shè)計(jì)到實(shí)現(xiàn)、甚至是抱 怨）。4.1.9

9、、代碼標(biāo)準(zhǔn)化管理小組內(nèi)成員必須開(kāi)展互測(cè)，項(xiàng)目經(jīng)理要督促進(jìn)行。如果一般性的缺陷被質(zhì)量 組測(cè)試發(fā)現(xiàn)，項(xiàng)目經(jīng)理可以作出警告、取消休假、扣發(fā)獎(jiǎng)金等處理措施。項(xiàng)目經(jīng) 理或開(kāi)發(fā)經(jīng)理可抽查成員代碼，對(duì)比規(guī)范作出人員基本技術(shù)素養(yǎng)評(píng)測(cè)， 計(jì)入期末 （項(xiàng)目結(jié)束）考核（去留）。4.1.10、備份制度應(yīng)用系統(tǒng)的所有資料代碼（程序、腳本塊、數(shù)據(jù)庫(kù)腳本）、文檔、數(shù)據(jù)， 除了數(shù)據(jù)以外，全部納入源代碼控制系統(tǒng)。數(shù)據(jù)每天備份一次 媒介是磁盤，代 碼（程序腳本、數(shù)據(jù)庫(kù)腳本）、文檔每周一次媒介是磁盤，所有信息每月備份 一次媒介是光盤。4.1.11、文檔管理沒(méi)有文檔的軟件是一種災(zāi)難。代碼不是傳達(dá)系統(tǒng)原理和結(jié)構(gòu)的理想媒介； 開(kāi) 發(fā)團(tuán)隊(duì)

10、更需要編制易于閱讀的文擋，來(lái)對(duì)系統(tǒng)及其設(shè)計(jì)決策的依據(jù)進(jìn)行描述。然而，過(guò)多的文檔比過(guò)少的文檔更糟。編制眾多的文檔需要花費(fèi)大量的時(shí)間， 并且要使這些文檔和代碼保持同步：就要花費(fèi)更多的時(shí)間。如果文檔和代碼之間 失去同步，那么文檔就會(huì)變成龐大的、復(fù)雜的謊言.會(huì)造成重大的誤導(dǎo)；對(duì)于團(tuán)隊(duì)來(lái)說(shuō)，編寫并維護(hù)一份系統(tǒng)原理和結(jié)構(gòu)方而的文擋將總是一個(gè)好主慝， 但是那份文檔應(yīng)該是短小、突出主題的。為此我們擬定所有項(xiàng)目都必須編制以下 文檔。項(xiàng)目開(kāi)發(fā)計(jì)劃書，模板見(jiàn)附錄4-1軟件需求說(shuō)明書，模板見(jiàn)附錄4-2詳細(xì)設(shè)計(jì)說(shuō)明書，模板見(jiàn)附錄4-3用戶手冊(cè)，模板見(jiàn)附錄4-45數(shù)據(jù)庫(kù)需求說(shuō)明，模板見(jiàn)附錄 4-5 6項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告，模

11、板見(jiàn)附錄 4-64.1.12、項(xiàng)目交付管理 軟件交付應(yīng)用，源代碼 文檔交付視技術(shù)合同要求交付的內(nèi)容而定 運(yùn)行維護(hù)技術(shù)交付：系統(tǒng)、數(shù)據(jù)庫(kù)、應(yīng)用的日常管理與維護(hù)。應(yīng)用系統(tǒng)安全性交付：操作系統(tǒng)管理與應(yīng)用賬號(hào)、數(shù)據(jù)庫(kù)管理與應(yīng)用開(kāi)發(fā)賬號(hào)、 服務(wù)器的管理與應(yīng)用開(kāi)發(fā)賬號(hào)。4.1.13、項(xiàng)目歸檔管理項(xiàng)目執(zhí)行過(guò)程的所有資料程序、腳本、數(shù)據(jù)、文檔以光盤作媒介，并附上 資料清單，交給公司行政部。4.2、任務(wù)分解與分目標(biāo)制定 組織中的負(fù)責(zé)人負(fù)責(zé)具體的任務(wù)分解并落實(shí)到組織中的每個(gè)人。形式如下:軟件開(kāi)發(fā)任務(wù)單任務(wù)編號(hào)項(xiàng)目名稱:子項(xiàng)名稱按“子系統(tǒng)T模塊T功能”最多三級(jí)劃分功能描述技術(shù)要求復(fù)雜度（業(yè)務(wù)與技術(shù)兩個(gè)層次）任務(wù)發(fā)出

12、人任務(wù)承接人限時(shí)開(kāi)始yyyy/MMdd限時(shí)結(jié)束yyyy/MMdd考核標(biāo)準(zhǔn)（百分制）分值考評(píng)項(xiàng)目301、時(shí)效性：（是否按時(shí)完成）402、客戶關(guān)注點(diǎn)：（功能、可靠性、易用性、咼效性、 可維護(hù)性、可移植性）表現(xiàn)如何103、規(guī)范與標(biāo)準(zhǔn)54、復(fù)用與創(chuàng)新85、團(tuán)隊(duì)精神26、奉獻(xiàn)精神57、溝通精神4.3、進(jìn)度檢查與績(jī)效考評(píng)4.3.1、考評(píng)原則軟件開(kāi)發(fā)人員的績(jī)效考評(píng)是所有軟件公司都深感棘手但又必須面對(duì)的問(wèn)題。 棘手的原因是既不能進(jìn)行計(jì)時(shí)處理、也不能進(jìn)行計(jì)件處理。計(jì)時(shí)會(huì)造成出工不出 力，計(jì)件（一般按代碼條數(shù)）會(huì)挫傷優(yōu)秀軟件人員的積極性（同樣實(shí)現(xiàn)一個(gè)功能， 差的軟件人員成百上千行，而優(yōu)秀軟件人員只有幾十行，且好用

13、）。但是只要尊重一些必要的原則，還是能夠加以評(píng)估的。這里提出六條原則：1、被考核對(duì)象必須有明確的任務(wù)項(xiàng)目經(jīng)理或開(kāi)發(fā)經(jīng)理必須發(fā)出明確的任務(wù)書： 任務(wù)書中指定任務(wù)名稱、任務(wù) 內(nèi)容、完成時(shí)限之、考核標(biāo)準(zhǔn)、向誰(shuí)負(fù)責(zé)、任務(wù)的難易程度（業(yè)務(wù)與技術(shù)兩個(gè)方 面）。難易程度由項(xiàng)目組成員集體評(píng)價(jià)。沒(méi)有明確的任務(wù)當(dāng)然就無(wú)法考評(píng)（見(jiàn)表 4-2）。2、考評(píng)標(biāo)準(zhǔn)要綜合計(jì)量量與非計(jì)量量。計(jì)量量如：完成時(shí)間、完成了對(duì)少功能、測(cè)試出多少缺陷等，非計(jì)量量如: 用戶接受程度如何、項(xiàng)目組合作情況如何等等，要將這些因素綜合考慮。3、要體現(xiàn)多勞多得、獎(jiǎng)勤罰懶。 高效、高質(zhì)完成任務(wù)的人員必須得到區(qū)別對(duì)待（調(diào)資、休假、獎(jiǎng)金） 。4、考評(píng)結(jié)果

14、要及時(shí)與被考評(píng)對(duì)象溝通，容許爭(zhēng)議協(xié)調(diào)。5、考評(píng)時(shí)間不得跨度太大，一般為兩周一次，不符合這種周期的，項(xiàng) 目經(jīng)理與開(kāi)發(fā)經(jīng)理需要適當(dāng)對(duì)任務(wù)做進(jìn)一步分解。6、被考評(píng)要提供周報(bào)月報(bào)之類的內(nèi)容，但不作為考評(píng)的依據(jù)。我們只 注重結(jié)果，也就是說(shuō)根據(jù)結(jié)果認(rèn)定過(guò)程。4.3.2、考評(píng)標(biāo)準(zhǔn)1、時(shí)效性：不管是承攬項(xiàng)目還是產(chǎn)品研發(fā)都有一定的時(shí)間限定， 愈期就意味著成本增加 甚至是失敗。所以能否按時(shí)完成任務(wù)是績(jī)效考評(píng)的一個(gè)重要標(biāo)致。2、客戶關(guān)注點(diǎn)客戶關(guān)注點(diǎn)也就是軟件的品質(zhì)， 涉及的內(nèi)容很多，按國(guó)家標(biāo)準(zhǔn)分為六個(gè)層面， 即：功能、可靠性、易用性、高效性、可維護(hù)性、可移植性。這六個(gè)項(xiàng)目的次序 也就是我們考察的順序， 首先必須完成

15、功能， 然后再衡量功能是否可靠， 再然后 才其他幾個(gè)方面，如果以百分制來(lái)衡量，這六個(gè)指標(biāo)的比例大致是 50,25,15,10,5,5 。也就是說(shuō)必須保證前四項(xiàng)。 而功能、可靠性又是重中之重 75%。3、規(guī)范與標(biāo)準(zhǔn)不以規(guī)矩不能成方園， 不遵從標(biāo)準(zhǔn)的與規(guī)范的設(shè)計(jì)開(kāi)發(fā)必將造成巨大的維護(hù) 成本與技術(shù)積累成本， 同時(shí)也給軟件交流與究錯(cuò)設(shè)置障礙， 所以必須強(qiáng)調(diào)規(guī)范化 與標(biāo)準(zhǔn)化。4、復(fù)用與創(chuàng)新性 這是軟件開(kāi)發(fā)人員設(shè)計(jì)與開(kāi)發(fā)綜合能力的一個(gè)集中體現(xiàn)。5、團(tuán)隊(duì)精神 沒(méi)有團(tuán)隊(duì)精神的軟件開(kāi)發(fā)人員堅(jiān)決辭退：開(kāi)發(fā)過(guò)程中團(tuán)隊(duì)精神主要表現(xiàn)在： 一、對(duì)測(cè)試出的問(wèn)題是互相推委，還是協(xié)商解決；二、接口設(shè)計(jì)各行其事還是共 同制訂；三

16、、發(fā)現(xiàn)他人犯錯(cuò)是善意提醒還是沉默不語(yǔ)；四、不注重版本管理。6、奉獻(xiàn)精神 任務(wù)比較緊張時(shí)候，是否不計(jì)較個(gè)人得失主動(dòng)加班加點(diǎn)趕任務(wù)。7、溝通精神 不懂問(wèn)題是拖延時(shí)間還是主動(dòng)尋求幫助，技術(shù)經(jīng)驗(yàn)是否主動(dòng)分享。4.3.4、考評(píng)矩陣開(kāi)發(fā)人員當(dāng)期任務(wù)評(píng)測(cè)表任務(wù)書編號(hào):項(xiàng)目指標(biāo)時(shí)效率按時(shí)未按時(shí)X%(X=100)完成未完成X%Y%客戶關(guān)注點(diǎn)功能可靠易用性能維護(hù)移植功能可靠易用性能維護(hù)移植AW 50%BW 25%CW 15%D 10%EW 5%FW 5%AW 50%BW 25%CW 15%D 10%E 6G 3HW 2H=0團(tuán)隊(duì)精神好中差I(lǐng) 5I 3KW 2K=0.0記分(30 + (A+B+C+D+E+F)*4

17、O+G+H+I+J+K)*X%功能：實(shí)現(xiàn)的結(jié)果是否體現(xiàn)的客戶的意圖，與客戶意圖之間的差距（X% ）,功能測(cè)評(píng)比例（1-x%）*50%可靠性：主要以測(cè)試出的缺陷多少來(lái)衡量，如果一個(gè)最低級(jí)功能被測(cè)出超過(guò)三個(gè)缺陷，可靠性為零。易用性：重要從數(shù)據(jù)校驗(yàn)與否、出錯(cuò)提示信息明細(xì)程度，輸入數(shù)據(jù)量多少，是否符合輸入習(xí)慣四個(gè)方面進(jìn)行衡量； 性能：主要是響應(yīng)速度可維護(hù)性與可移植性要看與規(guī)范與標(biāo)準(zhǔn)的差距4.4、應(yīng)對(duì)一些突發(fā)事件（協(xié)調(diào)與調(diào)整）項(xiàng)目可能造成的結(jié)果人員流動(dòng)招聘、調(diào)配、項(xiàng)目延期突發(fā)性需求商務(wù)談判、項(xiàng)目延期技術(shù)更新利潤(rùn)損失、技術(shù)積累損失、項(xiàng)目延期法律問(wèn)題無(wú)法進(jìn)展其它4.5、與有利害關(guān)系的人共享信息項(xiàng)目共享范圍一

18、般信息共享核心信息有限共享專有信息不共享附錄4-1項(xiàng)目開(kāi)發(fā)計(jì)劃編制項(xiàng)目開(kāi)發(fā)計(jì)劃的目的是用文件的形式，把對(duì)于在開(kāi)發(fā)過(guò)程中各項(xiàng)工作的負(fù)責(zé)人員、 開(kāi)發(fā)進(jìn)度、 所需經(jīng)費(fèi)預(yù)算、所需軟、硬件條件等問(wèn)題作出的安排記載下來(lái)，以便根據(jù)本計(jì) 劃開(kāi)展和檢查本項(xiàng)目的開(kāi)發(fā)工作。編制內(nèi)容要求如下：1引言1. 1編寫目的 說(shuō)明編寫這份項(xiàng)目開(kāi)發(fā)計(jì)劃的目的，并指出預(yù)期的讀者。1. 2背景說(shuō)明：a. 待開(kāi)發(fā)的軟件系統(tǒng)的名稱；b本項(xiàng)目的任務(wù)提出者、開(kāi)發(fā)者、用戶及實(shí)現(xiàn)該軟件的計(jì)算中心或計(jì)算機(jī)網(wǎng)絡(luò)；C 該軟件系統(tǒng)同其他系統(tǒng)或其他機(jī)構(gòu)的基本的相互來(lái)往關(guān)系。1. 3定義列出本文件中用到的專門術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。1. 4參考

19、資料列出用得著的參考資料，如：a. 本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文；b. 屬于本項(xiàng)目的其他已發(fā)表的文件；C.本文件中各處引用的文件、資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠得到這些文件資料的來(lái)源。2項(xiàng)目概述2. 1工作內(nèi)容簡(jiǎn)要地說(shuō)明在本項(xiàng)目的開(kāi)發(fā)中須進(jìn)行的各項(xiàng)主要工作。22 主要參加人員 扼要說(shuō)明參加本項(xiàng)目開(kāi)發(fā)工作的主要人員的情況，包括他們的技術(shù)水平。23 產(chǎn)品 2 31 程序 列出需移交給用戶的程序的名稱、 所用的編程語(yǔ)言及存儲(chǔ)程序的媒體形式， 并通過(guò)引用 有關(guān)文件， 逐項(xiàng)說(shuō)明其功能和能力。2 32 文件 列出需移交給

20、用戶的每種文件的名稱及內(nèi)容要點(diǎn)。233 服務(wù) 列出需向用戶提供的各項(xiàng)服務(wù)， 如培訓(xùn)安裝、 維護(hù)和運(yùn)行支持等， 應(yīng)逐項(xiàng)規(guī)定開(kāi)始日期、 所提供支持 的級(jí)別和服務(wù)的期限。234 非移交的產(chǎn)品 說(shuō)明開(kāi)發(fā)集體應(yīng)向本單位交出但不必向用戶移交的產(chǎn)品（文件甚至某些程序） 24 驗(yàn)收標(biāo)準(zhǔn) 對(duì)于上述這些應(yīng)交出的產(chǎn)品和服務(wù)，逐項(xiàng)說(shuō)明或引用資料說(shuō)明驗(yàn)收標(biāo)準(zhǔn)。25 完成項(xiàng)目的員遲用限26 本計(jì)劃的批準(zhǔn)者和批準(zhǔn)日期3 實(shí)施計(jì)劃31 工作任務(wù)的分門與人員分工 對(duì)于項(xiàng)目開(kāi)發(fā)中需完成的各項(xiàng)工作，從需求分析、設(shè)計(jì)、實(shí)現(xiàn)、測(cè)試直到維護(hù)，包括文 件的編制、審批、打印、分發(fā)工作，用戶培訓(xùn)工作，軟件安裝工作等，按層次進(jìn)行分解，指 明每項(xiàng)

21、任務(wù)的負(fù)責(zé)人和參加人員。3 2 接口人員 說(shuō)明負(fù)責(zé)接口工作的人員及他們的職責(zé)，包括： a 負(fù)責(zé)本項(xiàng)目同用戶的接口人員；b.負(fù)責(zé)本項(xiàng)目同本單位各管理機(jī)構(gòu)，如合同計(jì)劃管理部門、財(cái)務(wù)部門、質(zhì)量管理部門 等的接口人員；C.負(fù)責(zé)本項(xiàng)目同各分合同負(fù)責(zé)單位的接口人員等。3. 3 進(jìn)度 對(duì)于需求分析、設(shè)計(jì)、編碼實(shí)現(xiàn)、測(cè)試、移交、培訓(xùn)和安裝等工作，給出每項(xiàng)工作任務(wù) 的預(yù)。 定開(kāi)始日期、 完成日期及所需資源， 規(guī)定各項(xiàng)工作任務(wù)完成的先后順序以及表征每項(xiàng) 工作任務(wù)完成的標(biāo)志性事件（即所謂里程碑 ）。3. 4 預(yù)算 逐項(xiàng)列出本開(kāi)發(fā)項(xiàng)目所需要的勞務(wù) （包括人員的數(shù)量和時(shí)間） 以及經(jīng)費(fèi)的預(yù)算 （包括辦 公費(fèi)、差旅費(fèi)、機(jī)時(shí)

22、費(fèi)、資料費(fèi)、通訊設(shè)備和專用設(shè)備的租金等）和來(lái)源。技術(shù)難點(diǎn)和風(fēng)險(xiǎn)， 指出這些問(wèn)題對(duì)項(xiàng)目的3. 5 關(guān)鍵問(wèn)題 逐項(xiàng)列出能夠影響整個(gè)項(xiàng)目成敗的關(guān)鍵問(wèn)題、 影響。4 支持條件 說(shuō)明為支持本項(xiàng)目的開(kāi)發(fā)所需要的各種條件和設(shè)施。4. 1 計(jì)算機(jī)系統(tǒng)支持 逐項(xiàng)列出開(kāi)發(fā)中和運(yùn)行時(shí)所需的計(jì)算機(jī)系統(tǒng)支持，包括計(jì)算機(jī)、外圍設(shè)備、通訊設(shè)備、 模擬器、編譯 （或 匯編）程序、操作系統(tǒng)、數(shù)據(jù)管理程序包、數(shù)據(jù)存儲(chǔ)能力和測(cè)試支持能力等，逐項(xiàng)給出有關(guān)到貨日期、 使用時(shí)間的要求。4. 2 需由用戶承擔(dān)的工作 逐項(xiàng)列出需要用戶承擔(dān)的工作和完成期限。包括需由用戶提供的條件及提供時(shí)間。包括需要由外單位提供的4. 3 由外單位提供的條件

23、逐項(xiàng)列出需要外單位分合同承包者承擔(dān)的工作和完成的時(shí)間， 條件和提 供的時(shí)間。5 專題計(jì)劃要點(diǎn) 說(shuō)明本項(xiàng)目開(kāi)發(fā)中需制訂的各個(gè)專題計(jì)劃 （如分合同計(jì)劃、 開(kāi)發(fā)人員培訓(xùn)計(jì)劃、 測(cè)試計(jì) 劃、安全保密 計(jì)劃、質(zhì)量保證計(jì)劃、配置管理計(jì)劃、用戶培訓(xùn)計(jì)劃、系統(tǒng)安裝計(jì)劃等）的 要點(diǎn)。附錄 4-2 軟件需求說(shuō)明書軟件需求說(shuō)明書的編制是為了使用戶和軟件開(kāi)發(fā)者雙方對(duì)該軟件的初始規(guī)定有一個(gè)共同的理解， 使之成為整個(gè)開(kāi)發(fā)工作的基礎(chǔ)。編制軟件需求說(shuō)明書的內(nèi)容要求如下：1 引言11 編寫目的 說(shuō)明編寫這份軟件需求說(shuō)明書的目的，指出預(yù)期的讀者。12 背景說(shuō)明：a.待開(kāi)發(fā)的軟件系統(tǒng)的名稱；b本項(xiàng)目的任務(wù)提出者、開(kāi)發(fā)者、用戶及實(shí)現(xiàn)

24、該軟件的計(jì)算中心或計(jì)算機(jī)網(wǎng)絡(luò)；C 該軟件系統(tǒng)同其他系統(tǒng)或其他機(jī)構(gòu)的基本的相互來(lái)往關(guān)系。13 定義 列出本文件中用到的專門術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。1. 4參考資料列出用得著的參考資料，如：a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文；b屬于本項(xiàng)目的其他已發(fā)表的文件；C.本文件中各處引用的文件、資料、包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠得到這些文件資料的來(lái)源。2 任務(wù)概述2. 1 目標(biāo)敘述該項(xiàng)軟件開(kāi)發(fā)的意圖、 應(yīng)用目標(biāo)、 作用范圍以及其他應(yīng)向讀者說(shuō)明的有關(guān)該軟件開(kāi) 發(fā)的背景材料。 解釋被開(kāi)發(fā)軟件與其他有關(guān)軟件之間的關(guān)系。 如

25、果本軟件產(chǎn)品是一項(xiàng)獨(dú)立的 軟件， 而且全部?jī)?nèi)容自含， 則說(shuō)明這一點(diǎn)。 如果所定義的產(chǎn)品是一個(gè)更大的系統(tǒng)的一個(gè)組成 部分，則應(yīng)說(shuō)明本產(chǎn)品與該系統(tǒng)中其他各組成部分之間的關(guān)系， 為此可使用一張方框圖來(lái)說(shuō) 明該系統(tǒng)的組成和本產(chǎn)品同其他各部分的聯(lián)系和接口。|2. 2 用戶的特點(diǎn) 列出本軟件的最終用戶的特點(diǎn)，充分說(shuō)明操作人員、維護(hù)人員的教育水平和技術(shù)專長(zhǎng)， 以及本軟件的預(yù)期使甩頻度。這些是軟件設(shè)計(jì)工作的重要約束2. 3 假定和約束 列出進(jìn)行本軟件開(kāi)發(fā)工作的假定和約束，例如經(jīng)費(fèi)限制、開(kāi)發(fā)期限等。3 需求規(guī)定31 對(duì)功能的規(guī)定用列表的方式（例如 IPO 表即輸入、處理、輸出表的形式） ，逐項(xiàng)定量和定性地?cái)⑹鰧?duì)

26、 軟件所提出的功能要求，說(shuō)明輸入什么量、經(jīng)怎樣的處理、得到什么輸出，說(shuō)明軟件應(yīng)支持 的終端數(shù)和應(yīng)支持的并行操作的用戶數(shù)。32 對(duì)性能的規(guī)定321 精度 說(shuō)明對(duì)該軟件的輸入、輸出數(shù)據(jù)精度的要求，可能包括傳輸過(guò)程中的精度。322 時(shí)間特性要求 說(shuō)明對(duì)于該軟件的時(shí)間特性要求，如對(duì)：a. 響應(yīng)時(shí)間；b. 更新處理時(shí)間；C.數(shù)據(jù)的轉(zhuǎn)換和傳送時(shí)間；等的要求。d解題時(shí)間；323 靈活性說(shuō)明對(duì)該軟件的靈活性的要求， 即當(dāng)需求發(fā)生某些變化時(shí)， 該軟件對(duì)這些變化的適應(yīng)能 力，如：a.操作方式上的變化；b運(yùn)行環(huán)境的變化；C.同其他軟件的接口的變化；d精度和有效時(shí)限的變化；e.計(jì)劃的變化或改進(jìn)。 對(duì)于為了提供這些靈活

27、性而進(jìn)行的專門設(shè)計(jì)的部分應(yīng)該加以標(biāo)明。3. 3 輸人輸出要求 解釋各輸入輸出數(shù)據(jù)類型，并逐項(xiàng)說(shuō)明其媒體、格式、數(shù)值范圍、精度等。對(duì)軟件的數(shù) 據(jù)輸出及必須標(biāo)明的控制輸出量進(jìn)行解釋并舉例， 包括對(duì)硬拷貝報(bào)告 （正常結(jié)果輸出、 狀態(tài) 輸出及異常輸出）以及圖形或顯示報(bào)告的描述。3. 4 數(shù)據(jù)管理能力要求說(shuō)明需要管理的文卷和記錄的個(gè)數(shù)、 表和文卷的大小規(guī)模， 要按可預(yù)見(jiàn)的增長(zhǎng)對(duì)數(shù)據(jù)及 其分量的存儲(chǔ)要求作出估算。3. 5 故障處理要求 列出可能的軟件、硬件故障以及對(duì)各項(xiàng)性能而言所產(chǎn)生的后果和對(duì)故障處理的要求。3. 6 其他專門要求 如用戶單位對(duì)安全保密的要求，對(duì)使用方便的要求，對(duì)可維護(hù)性、可補(bǔ)充性、易讀性

28、、可靠性、運(yùn)行環(huán)境可轉(zhuǎn)換性的特殊要求等。4 運(yùn)行環(huán)境規(guī)定4. 1 設(shè)備 列出運(yùn)行該軟件所需要的硬設(shè)備。說(shuō)明其中的新型設(shè)備及其專門功能，包括：a.處理器型號(hào)及內(nèi)存容量；b外存容量、聯(lián)機(jī)或脫機(jī)、媒體及其存儲(chǔ)格式，設(shè)備的型號(hào)及數(shù)量；C.輸入及輸出設(shè)備的型號(hào)和數(shù)量，聯(lián)機(jī)或脫機(jī)；d數(shù)據(jù)通信設(shè)備的型號(hào)和數(shù)量；e.功能鍵及其他專用硬件4. 2 支持軟件列出支持軟件 ,包括要用到的操作系統(tǒng)、編譯（或匯編）程序、測(cè)試支持軟件等。 4 3 接口說(shuō)明該軟件同其他軟件之間的接口、數(shù)據(jù)通信協(xié)議等。44 控制 說(shuō)明控制該軟件的運(yùn)行的方法和控制信號(hào)，并說(shuō)明這些控制信號(hào)的來(lái)源。附錄 4-3 詳細(xì)設(shè)計(jì)說(shuō)明書1 引言11 編寫目

29、的 說(shuō)明編寫這份詳細(xì)設(shè)計(jì)說(shuō)明書的目的，指出預(yù)期的讀者。12 背景 說(shuō)明：a.待開(kāi)發(fā)軟件系統(tǒng)的名稱；b本項(xiàng)目的任務(wù)提出者、開(kāi)發(fā)者、用戶和運(yùn)行該程序系統(tǒng)的計(jì)算中心。13 定義 列出本文件中用到專門術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。1. 4 參考資料 列出有關(guān)的參考資料，如：a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文；b屬于本項(xiàng)目的其他已發(fā)表的文件；列出這些文件的c. 本文件中各處引用到的文件資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠取得這些文件的來(lái)源。的名稱、 標(biāo)識(shí)符2 程序系統(tǒng)的結(jié)構(gòu) 用一系列圖表列出本程序系統(tǒng)內(nèi)的每個(gè)程序 （包括每個(gè)模塊和子程序）

30、和它們之間 的層次結(jié)構(gòu)關(guān)系。3 程序 1（標(biāo)識(shí)符）設(shè)計(jì)說(shuō)明從本章開(kāi)始， 逐個(gè)地給出各個(gè)層次中的每個(gè)程序的設(shè)計(jì)考慮。 以下給出的提綱是針對(duì)一 般情況的。 對(duì)于一個(gè)具體的模塊，尤其是層次比較低的模塊或子程序，其很多條目的內(nèi)容 往往與它所隸屬的上一層 模塊的對(duì)應(yīng)條目的內(nèi)容相同，在這種情況下，只要簡(jiǎn)單地說(shuō)明這 一點(diǎn)即可。31程序描述給出對(duì)該程序的簡(jiǎn)要描述， 主要說(shuō)明安排設(shè)計(jì)本程序的目的意義， 并且， 還要說(shuō)明本程 序的特點(diǎn)（如 是常駐內(nèi)存還是非常駐？是否子程序？是可重人的還是不可重人的？有無(wú)覆 蓋要求？是順序處理還是并發(fā)處理卜.等）。32功能 說(shuō)明該程序應(yīng)具有的功能，可采用 IPO 圖（即輸入一處理一

31、輸出圖）的形式。33性能 說(shuō)明對(duì)該程序的全部性能要求，包括對(duì)精度、靈活性和時(shí)間特性的要求。34輸人項(xiàng) 給出對(duì)每一個(gè)輸入項(xiàng)的特性， 包括名稱、 標(biāo)識(shí)、 數(shù)據(jù)的類型和格式、 數(shù)據(jù)值的有效范圍、 輸入的方式。 數(shù)量和頻度、輸入媒體、輸入數(shù)據(jù)的來(lái)源和安全保密條件等等。3 5輸出項(xiàng)給出對(duì)每一個(gè)輸出項(xiàng)的特性， 包括名稱、 標(biāo)識(shí)、 數(shù)據(jù)的類型和格式， 數(shù)據(jù)值的有效范圍， 輸出的形式、 數(shù)量和頻度，輸出媒體、對(duì)輸出圖形及符號(hào)的說(shuō)明、安全保密條件等等。3. 6 算法 詳細(xì)說(shuō)明本程序所選用的算法，具體的計(jì)算公式和計(jì)算步驟。3. 7 流程邏輯 用圖表（例如流程圖、判定表等）輔以必要的說(shuō)明來(lái)表示本程序的邏輯流程。3.

32、 8 接口 用圖的形式說(shuō)明本程序所隸屬的上一層模塊及隸屬于本程序的下一層模塊、子程序， 說(shuō)明參數(shù)賦值和調(diào)用方式，說(shuō)明與本程序相直接關(guān)聯(lián)的數(shù)據(jù)結(jié)構(gòu)（數(shù)據(jù)庫(kù)、數(shù)據(jù)文卷）3. 9 存儲(chǔ)分配 根據(jù)需要，說(shuō)明本程序的存儲(chǔ)分配。3. 10 注釋設(shè)計(jì) 說(shuō)明準(zhǔn)備在本程序中安排的注釋，如：a. 加在模塊首部的注釋；b加在各分枝點(diǎn)處的注釋；對(duì)各變量的功能、范圍、缺省條件等所加的注釋；d對(duì)使用的邏輯所加的注釋等等。3. 11 限制條件 說(shuō)明本程序運(yùn)行中所受到的限制條件。3. 12 測(cè)試計(jì)劃 說(shuō)明對(duì)本程序進(jìn)行單體測(cè)試的計(jì)劃，包括對(duì)測(cè)試的技術(shù)要求、輸入數(shù)據(jù)、預(yù)期結(jié)果、進(jìn) 度安排、人員職責(zé)、設(shè)備條件驅(qū)動(dòng)程序及樁模塊等的規(guī)

33、定。3. 13 尚未解決的問(wèn)題 說(shuō)明在本程序的設(shè)計(jì)中尚未解決而設(shè)計(jì)者認(rèn)為在軟件完成之前應(yīng)解決的問(wèn)題。4 程序 2（標(biāo)識(shí)符）設(shè)計(jì)說(shuō)明用類似 3的方式，說(shuō)明第 2個(gè)程序乃至第 N 個(gè)程序的設(shè)計(jì)考慮。附錄 4-4 用戶手冊(cè)1 引言11 編寫目的 說(shuō)明編寫這份用戶手冊(cè)的目的，指出預(yù)期的讀者。12 背景說(shuō)明：a.這份用戶手冊(cè)所描述的軟件系統(tǒng)的名稱；b該軟件項(xiàng)目的任務(wù)提出者、開(kāi)發(fā)者、用戶（或首批用戶）及安裝此軟件的計(jì)算中心。13 定義 列出本文件中用到的專門術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。1. 4 參考資料 列出有用的參考資料，如：a.項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文；b屬于本項(xiàng)目的其他

34、已發(fā)表文件；C.本文件中各處引用的文件、資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠取得這些文件資料的來(lái)源。2 用途21 功能結(jié)合本軟件的開(kāi)發(fā)目的逐項(xiàng)地說(shuō)明本軟件所具有各項(xiàng)功能以及它們的極限范圍。22 性能包括傳輸中的精度221 精度 逐項(xiàng)說(shuō)明對(duì)各項(xiàng)輸入數(shù)據(jù)的精度要求和本軟件輸出數(shù)據(jù)達(dá)到的精度，要求。222 時(shí)間特性 定量地說(shuō)明本軟件的時(shí)間特性，如響應(yīng)時(shí)間，更新處理時(shí)間，數(shù)據(jù)傳輸、轉(zhuǎn)換時(shí)間，計(jì) 算時(shí)間等。2 23 靈活性 說(shuō)明本軟件所具有的靈活性，即當(dāng)用戶需求（如對(duì)操作方式、運(yùn)行環(huán)境、結(jié)果精度、時(shí) 間特性等的要求）有某些變化時(shí)，本軟件的適應(yīng)能

35、力。2 3 安 全保密 說(shuō)明本軟件在安全、保密方面的設(shè)計(jì)考慮和實(shí)際達(dá)到的能力。3 運(yùn)行環(huán)境 3 1 硬設(shè)備 列出為運(yùn)行本軟件所要求的硬設(shè)備的最小配置，如：a.處理機(jī)的型號(hào)、內(nèi)存容量 ；b所要求的外存儲(chǔ)器、媒體、記錄格式、設(shè)備的型號(hào)和臺(tái)數(shù)、聯(lián)機(jī)/脫機(jī)； c IO 設(shè)備（聯(lián)機(jī)脫機(jī)？） ； d數(shù)據(jù)傳輸設(shè)備和轉(zhuǎn)換設(shè)備的型號(hào)、臺(tái)數(shù)。3. 2 支持軟件 說(shuō)明為運(yùn)行本軟件所需要的支持軟件，如：a.操作系統(tǒng)的名稱、版本號(hào)；b程序語(yǔ)言的編譯/匯編系統(tǒng)的名稱和版本號(hào)；C.數(shù)據(jù)庫(kù)管理系統(tǒng)的名稱和版本號(hào)；d其他支持軟件。3. 3 數(shù)據(jù)結(jié)構(gòu) 列出為支持本軟件的運(yùn)行所需要的數(shù)據(jù)庫(kù)或數(shù)據(jù)文卷。輸出接收機(jī)構(gòu)之間的4 使用過(guò)程

36、 在本章， 首先用圖表的形式說(shuō)明軟件的功能同系統(tǒng)的輸入源機(jī)構(gòu)、 關(guān)系。包括程序的存儲(chǔ)形式、 安表征安裝工作完成的測(cè)4. 1 安裝與初始化 一步一步地說(shuō)明為使用本軟件而需進(jìn)行的安裝與初始化過(guò)程，裝與初始化過(guò)程中的全部操作命令、 系統(tǒng)對(duì)這些命令的反應(yīng)與答復(fù)。 試實(shí)例等。如果有的話，還應(yīng)說(shuō)明安裝過(guò)程中所需用到的專用軟件。4. 2 輸入 規(guī)定輸入數(shù)據(jù)和參量的準(zhǔn)備要求。4. 2. 1 輸入數(shù)據(jù)的現(xiàn)實(shí)背景 說(shuō)明輸入數(shù)據(jù)的現(xiàn)實(shí)背景，主要是 a.情況-例如人員變動(dòng)、庫(kù)存缺貨； b情況出現(xiàn)的頻度-例如是周期性的、隨機(jī)的、一項(xiàng)操作狀態(tài)的函數(shù).C.情況來(lái)源-一例如人事部門、倉(cāng)庫(kù)管理部門；d. 輸入媒體-例如鍵盤、穿

37、孔卡片、磁帶；e. 限制-出于安全、保密考慮而對(duì)訪問(wèn)這些輸入數(shù)據(jù)所加的限制；f. 質(zhì)量管理-例如對(duì)輸入數(shù)據(jù)合理性的檢驗(yàn)以及當(dāng)輸入數(shù)據(jù)有錯(cuò)誤時(shí)應(yīng)采取的措施， 建立出錯(cuò)情況的記錄等；g. 支配-例如如何確定輸入數(shù)據(jù)是保留還是廢棄，是否要分配給其他的接受者等。 422輸入格式說(shuō)明對(duì)初始輸入數(shù)據(jù)和參量的格式要求，包括語(yǔ)法規(guī)則和有關(guān)約定，如：a.長(zhǎng)度-一例如字符數(shù)/行，字符數(shù)/項(xiàng)；b格式基準(zhǔn)-例如以左面的邊沿為基準(zhǔn)；C.標(biāo)號(hào)-例如標(biāo)記或標(biāo)識(shí)符；d. 順序-例如各個(gè)數(shù)據(jù)項(xiàng)的次序及位置；e. 標(biāo)點(diǎn)-例如用來(lái)表示行、數(shù)據(jù)組等的開(kāi)始或結(jié)束而使用的空格、斜線、星號(hào)、字符 組等。f詞匯表-給出允許使用的字符組合的列

38、表，禁止使用*的字符組合的列表等；g.省略和重復(fù)-給出用來(lái)表示輸人元素可省略或重復(fù)的表示方式；h控制-給出用來(lái)表示輸入開(kāi)始或結(jié)束的控制信息。H 4 2 3 輸入舉例 為每個(gè)完整的輸入形式提供樣本，包括：a.控制或首部-例如用來(lái)表示輸入的種類和類型的信息，標(biāo)識(shí)符輸入日期，正文起點(diǎn) 和對(duì)所用編碼的規(guī)定；b主體-輸入數(shù)據(jù)的主體，包括數(shù)據(jù)文卷的輸入表述部分；C.尾部-用來(lái)表示輸入結(jié)束的控制信息，累計(jì)字符總數(shù)等；d. 省略-指出哪些輸入數(shù)據(jù)是可省略的；e. 重復(fù)-指出哪些輸入數(shù)據(jù)是重復(fù)的。43輸出 對(duì)每項(xiàng)輸出作出說(shuō)明 431輸出數(shù)據(jù)的現(xiàn)實(shí)背景，說(shuō)明輸出數(shù)據(jù)的現(xiàn)實(shí)背景，主要是：a.使用-這些輸出數(shù)據(jù)是給誰(shuí)

39、的，用來(lái)干什么；b使用頻度-例如每周的、定期的或備查閱的；C.媒體-打印、CRI顯示、磁帶、卡片、磁盤，d.質(zhì)量管理-一例如關(guān)于合理性檢驗(yàn)、出錯(cuò)糾正的規(guī)定；e.支配-例如如何確定輸出數(shù)據(jù)是保留還是廢棄，是否要分配給其他接受者等。 432輸出格式給出對(duì)每一類輸出信息的解釋，主要是：a. 首部-如輸出數(shù)據(jù)的標(biāo)識(shí)符，輸出日期和輸出編號(hào)；b. 主體-輸出信息的主體，包括分欄標(biāo)題；C.尾部-包括累計(jì)總數(shù)，結(jié)束標(biāo)記。 433輸出舉例為每種輸出類型提供例子。對(duì)例子中的每一項(xiàng)，說(shuō)明：a. 定義-每項(xiàng)輸出信息的意義和用途；b. 來(lái)源-是從特定的輸入中抽出、從數(shù)據(jù)庫(kù)文卷中取出、或從軟件的計(jì)算過(guò)程中得到C.特性-輸

40、出的值域、計(jì)量單位、在什么情況下可缺省等。 44文卷查詢這一條的編寫針對(duì)具有查詢能力的軟件， 內(nèi)容包括： 同數(shù)據(jù)庫(kù)查詢有關(guān)的初始化、 準(zhǔn)備、指出為了確保再及處理所需 要的詳細(xì)規(guī)定，說(shuō)明查詢的能力、方式，所使用的命令和所要求的控制規(guī)定。 45 出錯(cuò)處理和恢復(fù) 列出由軟件產(chǎn)生的出錯(cuò)編碼或條件以及應(yīng)由用戶承擔(dān)的修改糾正工作。啟動(dòng)和恢 復(fù)的能力，用戶必須遵循的處理過(guò)程。46 終端操作 當(dāng)軟件是在多終端系統(tǒng)上工作時(shí)，應(yīng)編寫本條，以說(shuō)明終端的配置安排、連接步釋、數(shù) 據(jù)和參數(shù)輸入 步驟以及控制規(guī)定說(shuō)明通過(guò)終端操作進(jìn)行查詢、檢索、修改數(shù)據(jù)文卷的能 力、語(yǔ)言、過(guò)程以及輔助性程 序等。附錄 4-5 數(shù)據(jù)要求說(shuō)明書

41、1 引言11 編寫目的 說(shuō)明編寫這份數(shù)據(jù)要求說(shuō)明書的目的，指出預(yù)期的讀者。12 背景 說(shuō)明：a.待開(kāi)發(fā)軟件系統(tǒng)的名稱；b列出本項(xiàng)目的任務(wù)提出者、開(kāi)發(fā)者、用戶以及將運(yùn)行該項(xiàng)軟件的計(jì)算站（中心）或 計(jì)算機(jī)網(wǎng)絡(luò)系統(tǒng)。1. 3 定義 列出本文件中用到的專門術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。1. 4 參考資料 列出有關(guān)的參考資料，如：a.本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同，上級(jí)機(jī)關(guān)的批文；b屬于本項(xiàng)目的其他已發(fā)表文件；C.本文件中各處引用的文件、資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。列出這些文件的 標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位。說(shuō)明能夠得到這些文件資料的來(lái)源。2 數(shù)據(jù)的邏輯描述 對(duì)數(shù)據(jù)進(jìn)行邏輯描述時(shí)可

42、把數(shù)據(jù)分為動(dòng)態(tài)數(shù)據(jù)和靜態(tài)數(shù)據(jù)。所謂靜態(tài)數(shù)據(jù)， 指在運(yùn)行過(guò)程中主要作 為參考的數(shù)據(jù)，它們?cè)诤荛L(zhǎng)的一段時(shí)間內(nèi)不會(huì)變化，一般不隨運(yùn)行而改變。所 謂動(dòng)態(tài)數(shù)據(jù).包括所有在運(yùn) 行中要發(fā)生變化的數(shù)據(jù)以及在運(yùn)行中要輸入、輸出的數(shù)據(jù)。進(jìn) 行描述時(shí)應(yīng)把各數(shù)據(jù)元素邏輯地分成若干 組，列如函數(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 動(dòng)態(tài)輸人數(shù)據(jù) 列出動(dòng)態(tài)輸入數(shù)據(jù)元素（包括在常規(guī)運(yùn)行中或聯(lián)機(jī)操作中要改變的數(shù)據(jù)）2. 3 動(dòng)態(tài)輸出數(shù)據(jù) 列出動(dòng)態(tài)輸出數(shù)

43、據(jù)元素（包括在常規(guī)運(yùn)行中或聯(lián)機(jī)操作中要改變的數(shù)據(jù)）2. 4 內(nèi)部生成數(shù)據(jù) 列出向用戶或開(kāi)發(fā)單位中的維護(hù)調(diào)試人員提供的內(nèi)部生成數(shù)據(jù)。2. 5 數(shù)據(jù)約定說(shuō)明對(duì)數(shù)據(jù)要求的制約。 逐條列出對(duì)進(jìn)一步擴(kuò)充或使用方面的考慮而提出的對(duì)數(shù)據(jù)要求 的限制（容 量、文卷、記錄和數(shù)據(jù)元的個(gè)數(shù)的最大值） 的限制更要明確指出。3 數(shù)據(jù)的采集 31 要求和范圍 按數(shù)據(jù)元的邏輯分組來(lái)說(shuō)明數(shù)據(jù)采集的要求和范圍， 集工作的承擔(dān)者是用戶還是開(kāi)發(fā)者。具體的內(nèi)容包括：a.輸入數(shù)據(jù)的來(lái)源，例如是單個(gè)操作員、數(shù)據(jù)輸入站， 一個(gè)分組；。對(duì)于在設(shè)計(jì)和開(kāi)發(fā)中確定是臨界性指明數(shù)據(jù)的采集方法， 說(shuō)明數(shù)據(jù)采專業(yè)的數(shù)據(jù)輸入公司或它們的b數(shù)據(jù)輸入（指把數(shù)

44、據(jù)輸入處理系統(tǒng)內(nèi)部）所用的媒體和硬設(shè)備。如果只有指定的輸 入點(diǎn)的輸入才是合法的，則必須對(duì)此加以說(shuō)明；C.接受者說(shuō)明輸出數(shù)據(jù)的接受者；d輸出數(shù)據(jù)的形式和設(shè)備列出輸出數(shù)據(jù)的形式和硬設(shè)備。無(wú)論接受者將接收到的數(shù)據(jù) 是打印輸出，還是 CRT 上的一組字符、一幀圖形，或一聲警鈴，或向開(kāi)關(guān)線圈提供的一個(gè) 電脈沖，或常用介質(zhì)如磁盤、磁帶、穿孔卡片等，均應(yīng)具體說(shuō)明；e.數(shù)據(jù)值的范圍給出每一個(gè)數(shù)據(jù)元的合法值的范圍；f 量綱給出數(shù)字的度量單位、增量的步長(zhǎng)、零點(diǎn)的定標(biāo)等。在數(shù)據(jù)是非數(shù)字量的情況 下，要給出每一種合法值的形式和含意；g.更新和處理的頻度給出預(yù)定的對(duì)輸入數(shù)據(jù)的更新和處理的頻度。如果數(shù)據(jù)的輸入是 隨機(jī)的，

45、應(yīng)給出更新處理的頻度的平均值，或變化情況的某種其他度量。還應(yīng)說(shuō)明該3. 2 輸人的承擔(dān)者 說(shuō)明預(yù)定的對(duì)數(shù)據(jù)輸入工作的承擔(dān)者。 如果輸入數(shù)據(jù)同某一接口軟件有關(guān)， 接口軟件的來(lái)源。預(yù)定的數(shù)據(jù)通要給出轉(zhuǎn)換方3. 3 預(yù)處理 對(duì)數(shù)據(jù)的采集和預(yù)處理過(guò)程提出專門的規(guī)定， 包括適合應(yīng)用的數(shù)據(jù)格式、 信媒體和對(duì)輸入的時(shí)間要求等。 對(duì)于需經(jīng)模擬轉(zhuǎn)換或數(shù)字轉(zhuǎn)換處理的數(shù)據(jù)量， 法和轉(zhuǎn)換因子等有關(guān)信息，以便軟件系統(tǒng)使用這些數(shù)據(jù)。3. 4 影響 說(shuō)明這些數(shù)據(jù)要求對(duì)于設(shè)備、軟件、用戶、開(kāi)發(fā)單位所可能產(chǎn)生的影響，例如要求用戶 單位增設(shè)某個(gè)機(jī)構(gòu)等。附錄 4-6 項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告I 引言1. 1 編寫目的 說(shuō)明編寫這份項(xiàng)目開(kāi)發(fā)

46、總結(jié)報(bào)告的目的，指出預(yù)期的閱讀范圍。1. 2 背景說(shuō)明：a.本項(xiàng)目的名稱和所開(kāi)發(fā)出來(lái)的軟件系統(tǒng)的名稱； b此軟件的任務(wù)提出者、開(kāi)發(fā)者、用戶及安裝此軟件的計(jì)算中心。I. 3 定義 列出本文件中用到的專門術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。1. 4 參考資料列出要用到的參考資料，如：a.本項(xiàng)目的已核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文；b屬于本項(xiàng)目的其他已發(fā)表的文件；列出這些文件C.本文件中各處所引用的文件、資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。 的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠得到這些文件資料的來(lái)源。2 實(shí)際開(kāi)發(fā)結(jié)果2. 1 產(chǎn)品 說(shuō)明最終制成的產(chǎn)品，包括：a.程序系統(tǒng)中各個(gè)程序的名字

47、，它們之間的層次關(guān)系，以千字節(jié)為單位的各個(gè)程序的 程序量、存儲(chǔ)媒體的形式和數(shù)量；b程序系統(tǒng)共有哪幾個(gè)版本，各自的版本號(hào)及它們之間的區(qū)別；C.每個(gè)文件的名稱；d所建立的每個(gè)數(shù)據(jù)庫(kù)。如果開(kāi)發(fā)中制訂過(guò)配置管理計(jì)劃，要同這個(gè)計(jì)劃相比較。2. 2 主要功能和性能 逐項(xiàng)列出本軟件產(chǎn)品所實(shí)際具有的主要功能和性能， 對(duì)照可行性研究報(bào)告、 項(xiàng)目開(kāi)發(fā)計(jì) 劃、功能需 .求說(shuō)明書的有關(guān)內(nèi)容，說(shuō)明原定的開(kāi)發(fā)目標(biāo)是達(dá)到了、未完全達(dá)到、或超過(guò) 了。23 基本流程 用圖給出本程序系統(tǒng)的實(shí)際的基本的處理流程。24 進(jìn)度 列出原定計(jì)劃進(jìn)度與實(shí)際進(jìn)度的對(duì)比，明確說(shuō)明，實(shí)際進(jìn)度是提前了、還是延遲了，分 析主要原因。25 費(fèi)用 列出原

48、定計(jì)劃費(fèi)用與實(shí)際支出費(fèi)用的對(duì)比，包括：a.工時(shí)，以人月為單位，并按不同級(jí)別統(tǒng)計(jì)；b計(jì)算機(jī)的使用時(shí)間，區(qū)別 CPU時(shí)間及其他設(shè)備時(shí)間；C.物料消耗、出差費(fèi)等其他支出。明確說(shuō)明，經(jīng)費(fèi)是超出了、還是節(jié)余了，分析其主要原因。3 開(kāi)發(fā)工作評(píng)價(jià)3. 1 對(duì)生產(chǎn)效率的評(píng)價(jià) 給出實(shí)際生產(chǎn)效率，包括：a.程序的平均生產(chǎn)效率，即每人月生產(chǎn)的行數(shù)；b文件的平均生產(chǎn)效率，即每人月生產(chǎn)的千字?jǐn)?shù)； 并列出原訂計(jì)劃數(shù)作為對(duì)比。3. 2 對(duì)產(chǎn)品質(zhì)量的評(píng)價(jià) 說(shuō)明在測(cè)試中檢查出來(lái)的程序編制中的錯(cuò)誤發(fā)生率， 即每干條指令 （或語(yǔ)句） 中的錯(cuò)誤 指令數(shù)（或語(yǔ)句數(shù)） 。如果開(kāi)發(fā)中制訂過(guò)質(zhì)量保證計(jì)劃或配置管理計(jì)劃，要同這些計(jì)劃相比 較。

49、33 對(duì)技術(shù)方法的評(píng)價(jià) 給出對(duì)在開(kāi)發(fā)中所使用的技術(shù)、方法、工具、手段的評(píng)價(jià)。34 出錯(cuò)原因的分析 給出對(duì)于開(kāi)發(fā)中出現(xiàn)的錯(cuò)誤的原因分析。4 經(jīng)驗(yàn)與教訓(xùn)列出從這項(xiàng)開(kāi)發(fā)工作中所得到的最主要的經(jīng)驗(yàn)與教訓(xùn)及對(duì)今后的項(xiàng)目開(kāi)發(fā)工作的建議。附錄 5-1 JAVA 編碼規(guī)范1、命名規(guī)范定義這個(gè)規(guī)范的目的是讓項(xiàng)目中所有的文檔都看起來(lái)像一個(gè)人寫的， 增加可讀性，減少項(xiàng)目組中因?yàn)閾Q人而帶來(lái)的損失。命名一般以簡(jiǎn)介單詞構(gòu)成。1、 package 的命名package 的名字應(yīng)該都是由一個(gè)小寫單詞組成。package com.neu.util2、 class 的命名class 的名字必須由大寫字母開(kāi)頭而其他字母都小寫的單詞

50、組成 , 對(duì)于所有 標(biāo)識(shí)符，其中包含的所有單詞都應(yīng)緊靠在一起， 而且大寫中間單詞的首字母。public class ThisAClassName3、class 變量的命名變量的名字必須用一個(gè)小寫字母開(kāi)頭。后面的單詞用大寫字母開(kāi)頭userName , thisAClassMethod4、 static final變量的命名static final變量的名字應(yīng)該都大寫，并且指出完整含義。public static final StringDB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig;5、參數(shù)的命名參數(shù)的名字必須和變量的命名規(guī)范一致。6、數(shù)組的命名數(shù)組應(yīng)該

51、總是用下面的方式來(lái)命名：byte buffer;而不是： byte buffer;7、方法的參數(shù)使用有意義的參數(shù)命名， 如果可能的話， 使用和要賦值的字段一樣的名 字：setCounter(int size)this.size = size;2、注視規(guī)范Java 的注釋有三種/ 注釋一行/* */注釋若干行/* */注釋若干行，并寫入 javadoc 文檔 ，也叫 java 文檔注釋注釋要簡(jiǎn)單明了。String userName = null; /用戶名邊寫代碼邊注釋，修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致 性。在必要的地方注釋，注釋量要適中。注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確， 防

52、止注釋二義性。保持注釋與其描述的代碼相鄰，即注釋的就近原則。對(duì)代碼的注釋應(yīng)放在其上方相鄰位置，不可放在下面。對(duì)數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng) 放在其上方相鄰位置，不可放在下面；對(duì)結(jié)構(gòu)中的每個(gè)域的注釋應(yīng)放在此域 的右方；同一結(jié)構(gòu)中不同域的注釋要對(duì)齊。變量、常量的注釋應(yīng)放在其上方相鄰位置或右方。全局變量要有較詳細(xì)的注釋，包括對(duì)其功能、取值范圍、哪些函數(shù)或過(guò)程存 取它以及存取時(shí)注意事項(xiàng)等的說(shuō)明。在每個(gè)源文件的頭部要有必要的注釋信息，包括：文件名；版本號(hào)；作者；生成日期；模塊功能描述（如功能、主要算法、內(nèi)部各部分之間的關(guān)系、該文件與其它文件關(guān)系等）；主要函數(shù)或過(guò)程清單及本文件歷史修改記錄等。/* Copy Righ

53、t Information : stsoft* Project: jscbmis* JDK version used : jdk1.5.09* Comments: config path: 1.01* Version* Sr* Modification history :2007.5.1Date Modified By Why & What is modified* 1.2003.5.2 David Li new*/在每個(gè)函數(shù)或過(guò)程的前面要有必要的注釋信息，包括：函數(shù)或過(guò)程名稱；功能描述；輸入、輸出及返回值說(shuō)明；調(diào)用關(guān)系及被調(diào)用關(guān)系說(shuō)明等/* Description :checkout提款* param Hashtable cart info* param OrderBean order info* return String*/public String checkout(Hashtable htCart,OrderBean orderBean) throws Exceptionjavadoc 注釋標(biāo)簽語(yǔ)法author 對(duì)類的說(shuō)明 標(biāo)明開(kāi)發(fā)該類模塊的作者version對(duì)類的說(shuō)明 標(biāo)明該類模塊的版本see對(duì)類、屬性、方法的說(shuō)明 參考轉(zhuǎn)向，也就是相關(guān)主題param對(duì)方法的說(shuō)明對(duì)方法中某參數(shù)的說(shuō)明retur