計(jì)算機(jī)軟件文檔編制規(guī)范(編輯修改稿)
2024-09-01 16:23 本頁面
【文章內(nèi)容簡介】 據(jù)結(jié)構(gòu)與程序的關(guān)系六． 運(yùn)行設(shè)計(jì)1． 運(yùn)行模塊的組合2． 運(yùn)行控制3． 運(yùn)行時(shí)間七． 出錯(cuò)處理設(shè)計(jì)1． 出錯(cuò)輸出信息2． 出錯(cuò)處理對(duì)策（如設(shè)置后備、性能降級(jí)、恢復(fù)及再啟動(dòng)等。）八． 安全保密設(shè)計(jì)九． 維護(hù)設(shè)計(jì)（說明為方便維護(hù)工作的設(shè)施,如維護(hù)模塊等。）詳細(xì)設(shè)計(jì)說明書一． 引言1． 編寫目的（闡明編寫詳細(xì)設(shè)計(jì)說明書的目的,指明讀者對(duì)象。）2． 項(xiàng)目背景（應(yīng)包括項(xiàng)目的來源和主管部門等。）3． 定義（列出文檔中用到的專門術(shù)語定義和縮寫詞的原意。）4． 參考資料（列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來源，可包括：（1）項(xiàng)目的計(jì)劃任務(wù)書,合同或批文；（2）項(xiàng)目開發(fā)計(jì)劃；（3）需求規(guī)格說明書；（3）概要設(shè)計(jì)說明書；（4）測試計(jì)劃(初稿)；（5）用戶操作手冊(cè)(初稿)；（5）文檔所引用的其他資料、軟件開發(fā)標(biāo)準(zhǔn)或規(guī)范。）二． 總體設(shè)計(jì)1． 需求概述2． 軟件結(jié)構(gòu)（如給出軟件系統(tǒng)的結(jié)果圖。）三． 程序描述（逐個(gè)模塊給出以下的說明:：）1． 功能2． 性能3． 輸入項(xiàng)目4． 輸出項(xiàng)目5． 算法（模塊所選用的算法。）6． 程序邏輯（詳細(xì)描述模塊實(shí)現(xiàn)的算法，可采用:：（1）標(biāo)準(zhǔn)流程圖；（2）PDL語言；（3）NS圖；（4）PAD；（5）判定表等描述算法的圖表。）7． 接口8． 存儲(chǔ)分配9． 限制條件10． 測試要點(diǎn)（給出測試模塊的主要測試要求。）用戶操作手冊(cè)一． 引言1． 編寫目的（闡明編寫手冊(cè)的目的，指明讀者對(duì)象。）2． 項(xiàng)目背景（說明項(xiàng)目的來源、委托單位、開發(fā)單位及主管部門。）3． 定義（列出手冊(cè)中用到的專門術(shù)語定義和縮寫詞的原意。）4． 參考資料（列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來源，可包括：（1）項(xiàng)目的計(jì)劃任務(wù)書,合同或批文；（2）項(xiàng)目開發(fā)計(jì)劃；（3）需求規(guī)格說明書；（4）概要設(shè)計(jì)說明書；（5）詳細(xì)設(shè)計(jì)說明書；（6）測試計(jì)劃；（7）手冊(cè)中引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范。）二． 軟件概述1． 目標(biāo)2． 功能3． 性能（1） 數(shù)據(jù)精確度（包括輸入、輸出及處理數(shù)據(jù)的精度。）（2） 時(shí)間特性（如響應(yīng)時(shí)間、處理時(shí)間、數(shù)據(jù)傳輸時(shí)間等。）（3） 靈活性（在操作方式、運(yùn)行環(huán)境需做某些變更時(shí)軟件的適應(yīng)能力。）三． 運(yùn)行環(huán)境1． 硬件（列出軟件系統(tǒng)運(yùn)行時(shí)所需的硬件最小配置，如：（1）計(jì)算機(jī)型號(hào)、主存容量；（2）外存儲(chǔ)器、媒體、記錄格式、設(shè)備型號(hào)及數(shù)量；（3）輸入、輸出設(shè)備；（4）數(shù)據(jù)傳輸設(shè)備及數(shù)據(jù)轉(zhuǎn)換設(shè)備的型號(hào)及數(shù)量。）2． 支持軟件（如：（1）操作系統(tǒng)名稱及版本號(hào)；（2）語言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號(hào)；（3）數(shù)據(jù)庫管理系統(tǒng)的名稱及版本號(hào)；（4）其他必要的支持軟件。）四． 使用說明1． 安裝和初始化（給出程序的存儲(chǔ)形式、操作命令、反饋信息及其含義、表明安裝完成的測試實(shí)例以及安裝所需的
環(huán)評(píng)公示相關(guān)推薦
鄂ICP備17016276號(hào)-1