軟件開發(fā)規(guī)范

軟件開發(fā)規(guī)范軟件文檔編寫向?qū)ы椖堪ㄈ缦聨最愇臋n：項目管理文檔。包括：《軟件項目計劃》、《項目進度報告》、《項目開發(fā)總軟件開發(fā)文檔。包括：《需求規(guī)格說明》、《概要設(shè)計說明》、《詳細(xì)設(shè)計說軟件項目計劃(SoftwareProjectPlan)1．編寫目的(闡明編寫軟件計劃的目的，指出讀者對象。)2．項目背景(可包括：(1)項目委托單位、開發(fā)單位和主管部門；(2)該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。)3．定義(列出本文檔中用到的專門術(shù)語的定義和縮略詞的原文。)4．參考資料(可包括：文檔所引用的資料、規(guī)范等；列出資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源。)1.工作內(nèi)容(簡要說明項目的各項主要工作,介紹所開發(fā)軟件的功能性能等.若．實際進展與計劃比較2.條件與限制(闡明為完成項目應(yīng)具備的條件開發(fā)單位已具備的條件以及尚需 (1)程序(列出應(yīng)交付的程序名稱使用的語言及存儲形式。) (2)文檔(列出應(yīng)交付的文檔。) (3)運行環(huán)境(應(yīng)包括硬件環(huán)境軟件環(huán)境。)4．服務(wù)(闡明開發(fā)單位可向用戶提供的服務(wù).如人員培訓(xùn)安裝保修維護和其他1．任務(wù)分解(任務(wù)的劃分及各項任務(wù)的負(fù)責(zé)人。)2．進度(按階段完成的項目,用圖表說明開始時間完成時間。)4．關(guān)鍵問題(說明可能影響項目的關(guān)鍵問題,如設(shè)備條件技術(shù)難點或其他風(fēng)險六．專題計劃要點(如測試計劃等。)項目開發(fā)進度報告一．報告時間及所處的開發(fā)階段度三．所用工時(按不同層次人員分別計時。)項目開發(fā)總結(jié)報告1．編寫目的(闡明編寫總結(jié)報告的目的,指明讀者對象。)2．項目背景(說明項目的來源、委托單位、開發(fā)單位及主管部門。)3．定義(列出報告中用到的專門術(shù)語定義和縮寫詞的原意。)4．參考資料(列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：(1)項目開發(fā)計劃；(2)需求規(guī)格說明書；(3)概要設(shè)計說明書；(4)詳細(xì)設(shè)計說明書；(5)用戶操作手冊；(6)測試計劃；(7)測試分析報告(8)本報告引用的其他資料、采用的開發(fā)標(biāo)準(zhǔn)或開發(fā)規(guī)范。)1．產(chǎn)品(可包括：(1)列出各部分的程序名稱、源程序行數(shù)(包括注釋行)或目標(biāo)程序字節(jié)數(shù)及程序總計數(shù)量、存儲形式；產(chǎn)品文檔名稱等。)3．所用工時(按人員的不同層次分別計時。)5．進度(給出計劃進度與實際進度的對比。)1．生產(chǎn)率評價(如平均每人每周源程序行數(shù)、文檔的字?jǐn)?shù)等。)需求規(guī)格說明書(RequirementsSpecification)1．編寫目的(闡明編寫需求說明書的目的,指明讀者對象。)2．項目背景(可包括：(1)項目的委托單位,開發(fā)單位和主管部門；(2)該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。)3．定義(列出文檔中用到的專門術(shù)語定義和縮寫詞的原文。)4．參考資料(可包括：(1)項目開發(fā)計劃；(2)文檔所引用的資料，標(biāo)準(zhǔn)和規(guī)范。列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源。)2．動態(tài)數(shù)據(jù)(包括輸入數(shù)據(jù)和輸出數(shù)據(jù)。)3．?dāng)?shù)據(jù)庫描述(給出使用數(shù)據(jù)庫的名稱和類型。)2．時間特性(如響應(yīng)時間、更新處理時間、數(shù)據(jù)轉(zhuǎn)化與傳輸時間、運行時間性(在操作方式運行環(huán)境與其他軟件的接口以及開發(fā)計劃等發(fā)生變化時，適應(yīng)能力。)1．用戶界面(如屏幕格式、報表格式、菜單格式、輸入輸出時間等。)七．其他需求(如可使用性、安全保密、可維護性、可移植性等。)概要設(shè)計說明書(ArchitecturalDesignSpecification)1．編寫目的(闡明編寫概要設(shè)計說明書的目的，指明讀者對象。)2．項目背景(可包括：(1)項目的委托單位,開發(fā)單位和主管部門；(2)該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。)3．定義(列出文檔中用到的專門術(shù)語定義和縮寫詞的原意。)源，可包括：(1)項目開發(fā)計劃；(2)需求規(guī)格說明書；(3)測試計劃 (初稿)；(4)用戶操作手冊(初稿)；(5)文檔所引用的資料、采用的標(biāo)3．功能分配(表明各項功能與程序結(jié)構(gòu)的關(guān)系。)1．外部接口(包括用戶界面軟件接口與硬件接口。)2．內(nèi)部接口(模塊之間的接口。)2．出錯處理對策(如設(shè)置后備、性能降級、恢復(fù)及再啟動等。)九．維護設(shè)計(說明為方便維護工作的設(shè)施,如維護模塊等。)詳細(xì)設(shè)計說明書(ProceduralDesignSpecification)1．編寫目的(闡明編寫詳細(xì)設(shè)計說明書的目的,指明讀者對象。)2．項目背景(應(yīng)包括項目的來源和主管部門等。)3．定義(列出文檔中用到的專門術(shù)語定義和縮寫詞的原意。)4．參考資料(列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：(1)項目開發(fā)計劃；(2)需求規(guī)格說明書；(3)概要設(shè)計說明書；(4)測試計劃(初稿)；(5)用戶操作手冊(初稿)；(5)文檔所引用其他資料、軟件開發(fā)標(biāo)準(zhǔn)或規(guī)范。)2．軟件結(jié)構(gòu)(如給出軟件系統(tǒng)的結(jié)果圖。)三．程序描述(逐個模塊給出以下的說明:：)6．程序邏輯(詳細(xì)描述模塊實現(xiàn)的算法，可采用:：(1)標(biāo)準(zhǔn)流程圖；(2)N-S圖；(3)PAD；(4)判定表等描述算法的圖表。)10．測試要點(給出測試模塊的主要測試要求。)測試計劃(TestPlan)1．編寫目的(闡明編寫測試計劃的目的,指明讀者對象。)2．項目背景(說明項目的來源委托單位及主管部門。)3．定義(列出測試計劃中用到的專門術(shù)語定義和縮寫詞的原意。)4．參考資料(列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：(1)項目開發(fā)計劃；(2)需求規(guī)格說明書；(3)概要設(shè)計說明書；(4)詳細(xì)設(shè)計說明書；(5)用戶操作手冊;(6)本測試計劃中引用的開發(fā)標(biāo)準(zhǔn)或規(guī)范。)2．測試項目(列出組裝測試和確認(rèn)測試中每一項測試的內(nèi)容、名稱、目的和4．測試機構(gòu)及人員(測試機構(gòu)名稱負(fù)責(zé)人和職責(zé)。)四．測試項目說明(按順序逐個對測試項目做出說明：) (1)輸入(輸入的數(shù)據(jù)和輸入的命令。) (2)輸出(預(yù)期的輸出數(shù)據(jù)。) (3)步驟及操作 (4)允許偏差(給出實測結(jié)果與預(yù)測結(jié)果之間允許偏差的范圍。)4．條件(給出項測試對資源的特殊要求，如設(shè)備、軟件、人員等。)5．測試資料(說明項測試所需的資料。)1．范圍(說明所完成的各項測試說明問題的范圍及其局限性。)2．準(zhǔn)則(說明評價測試結(jié)果的準(zhǔn)則。)測試分析報告(TestSpecification)1．編寫目的(闡明編寫測試分析報告的目的，指明讀者對象。)2．項目背景(說明項目的來源、委托單位及主管部門。)3．定義(列出測試分析報告中用到的專門術(shù)語定義和縮寫詞的原意。)4．參考資料(列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：(1)項目開發(fā)計劃；(2)需求規(guī)格說明書；(3)概要設(shè)計說明書；(4)詳細(xì)設(shè)計說明書；(5)用戶操作手冊；(6)測試計劃；(7)測他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范。)1．測試項目(列出每一測試項目的名稱、內(nèi)容和目的。)2．測試機構(gòu)和人員(給出測試機構(gòu)名稱、負(fù)責(zé)人和參與測試人員名單。)3．測試結(jié)果(按順序給出每一測試項目的：(1)實測結(jié)果數(shù)據(jù)(2)與預(yù)期結(jié)果數(shù)據(jù)的偏差(3)該項測試說明的事實(4)該項測試發(fā)現(xiàn)的問題。)按順序給出每一項需求測試的結(jié)論。包括：(1)證實的軟件能力(2)局限性 (即項需求未得到充分測試的情況及原因)。1．軟件能力(經(jīng)過測試所表明的軟件能力。)2．缺陷和限制(說明測試所揭露的軟件缺陷和不足,以及可能給軟件運行帶來的3．建議(提出為彌補上述缺陷的建議。)4．測試結(jié)論(說明能否通過。)用戶操作手冊(UserGuide)3．定義(列出手冊中用到的專門術(shù)語定義和縮寫詞的原意。)4．參考資料(列出這些資料的作者、標(biāo)題、編號、發(fā)表日期、出版單位或資料來源，可包括：(1)項目開發(fā)計劃；(2)需求規(guī)格說明書；(3)概要設(shè)計說明書；(4)詳細(xì)設(shè)計說明書；(5)測試計劃；(6)手冊中引用的其他資工程標(biāo)準(zhǔn)或軟件工程規(guī)范。) (1)數(shù)據(jù)精確度(包括輸入、輸出及處理數(shù)據(jù)的精度。) (2)時間特性(如響應(yīng)時間、處理時間、數(shù)據(jù)傳輸時間等。) (3)靈活性(在操作方式、運行環(huán)境需做某些變更時軟件的適應(yīng)能力。)1．硬件(列出軟件系統(tǒng)運行時所需的硬件最小配置，如：(1)計算機型號、主存容量；(2)外存儲器、媒體、記錄格式、設(shè)備型號及數(shù)量；(3)輸入、輸出設(shè)備；(4)數(shù)據(jù)傳輸設(shè)備及數(shù)據(jù)轉(zhuǎn)換設(shè)備的型號及數(shù)量。)2．支持軟件(如：(1)操作系統(tǒng)名稱及版本號；(2)語言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號；(3)數(shù)據(jù)庫管理系統(tǒng)的名稱及版本號；(4)其他必要的支具等。)2．輸入(給出輸入數(shù)據(jù)或參數(shù)的要求。) (1)數(shù)據(jù)背景(說明數(shù)據(jù)來源、存儲媒體、出現(xiàn)頻度、限制和質(zhì)量管理等。) (2)數(shù)據(jù)格式(如：(1)長度(2)格式基準(zhǔn)(3)標(biāo)號(4)順序(5)分隔符 (6)詞匯表(7)省略和重復(fù)(8)控制。) (3)輸入舉例3．輸出(給出每項輸出數(shù)據(jù)的說明。) (1)數(shù)據(jù)背景(說明輸出數(shù)據(jù)的去向、使用頻度、存放媒體及質(zhì)量管理等。) (2)數(shù)據(jù)格式(詳細(xì)闡明每一輸出數(shù)據(jù)的格式,如:首部主體和尾部的具體形式。) (3)舉例3．出錯和恢復(fù)(給出：(1)出錯信息及其含義(2)用戶應(yīng)采取的措施，如修4．求助查詢(說明如何操作。) (1)運行控制 (2)操作信息((1)運行目的(2)操作要求(3)啟動方法(4)預(yù)計運行時間(5)操作命令格式及說明(6)其他事項。) (