軟件項(xiàng)目詳細(xì)設(shè)計(jì)說明書樣本

中華人民共和國廣東核電集團(tuán)CHINAGUANGDONGNUCLEARPOWERGROUP記錄文件項(xiàng)目編號(hào)項(xiàng)目名稱CGN-IT-C3-A01-01軟件項(xiàng)目章程版本編寫審核審定批準(zhǔn)生效時(shí)間A/0注：如無受控文獻(xiàn)標(biāo)記（藍(lán)色印章）則為非有效版本，以受控文獻(xiàn)規(guī)定為準(zhǔn)。此文獻(xiàn)屬中華人民共和國廣東核電集團(tuán)有限公司所有，未經(jīng)允許，不得以任何方式外傳。修改記錄頁NO修改日期修改摘要（涉及頁碼/條款/內(nèi)容）版本修改因素【模板使用必讀：模板內(nèi)容和頁眉中【】包括內(nèi)容為指引性待替代文字，請(qǐng)?jiān)谑褂弥刑娲鸀樵敿?xì)內(nèi)容，或刪除。文獻(xiàn)提交時(shí)不得再具有這些內(nèi)容。】

目錄TOC\o"1-3"\h\z1 引言 41.1 編寫目 41.2 背景 41.3 術(shù)語與縮寫解釋 41.4 參照資料 42 模塊命名規(guī)則 43 程序系統(tǒng)組織構(gòu)造 53.1 子系統(tǒng)劃分 53.2 模塊劃分 53.3 程序與功能需求、系統(tǒng)模塊間關(guān)系 54 程序1（標(biāo)記符）設(shè)計(jì)闡明 54.1 程序描述 54.2 功能 64.3 性能 64.4 輸人項(xiàng) 64.5 輸出項(xiàng) 64.6 算法 64.7 流程邏輯 64.8 接口 64.9 存儲(chǔ)分派 74.10 注釋設(shè)計(jì) 74.11 限制條件 74.12 尚未解決問題 75 程序2（標(biāo)記符）設(shè)計(jì)闡明 7引言編寫目【給出項(xiàng)目詳細(xì)設(shè)計(jì)闡明書編寫目，同步指明讀者對(duì)象。】背景【闡明：a．待開發(fā)軟件系統(tǒng)名稱；b.本項(xiàng)目任務(wù)提出者、開發(fā)者、顧客和運(yùn)營該程序系記錄算中心?！啃g(shù)語與縮寫解釋【列出本文獻(xiàn)中用到專門術(shù)語定義和外文首字母縮寫原詞組?！靠s寫、術(shù)語解釋PMO項(xiàng)目管理辦公室，ProjectManagementOfficePP項(xiàng)目策劃（規(guī)劃），ProjectPlanning…參照資料【提示：可涉及：（1）本項(xiàng)目經(jīng)核準(zhǔn)籌劃任務(wù)書、需求規(guī)格闡明書、合同、項(xiàng)目設(shè)計(jì)概要闡明書或上級(jí)機(jī)關(guān)批文；（2）本文檔所引用資料、規(guī)范等，列出這些資料作者、標(biāo)題、編號(hào)、刊登日期、出版單位或資料來源?！磕K命名規(guī)則【擬定本軟件模塊命名規(guī)則，例如類、函數(shù)、變量等，保證設(shè)計(jì)文檔風(fēng)格保持一致?？梢詮臋C(jī)構(gòu)編碼規(guī)范中摘取或引用?！砍绦蛳到y(tǒng)組織構(gòu)造【用一系列圖表列出本程序系統(tǒng)內(nèi)每個(gè)程序（涉及每個(gè)模塊和子程序）名稱、標(biāo)記符和它們之間層次構(gòu)造關(guān)系。】子系統(tǒng)劃分模塊劃分程序與功能需求、系統(tǒng)模塊間關(guān)系程序標(biāo)記需求標(biāo)記模塊標(biāo)記程序1（標(biāo)記符）程序2（標(biāo)記符）……程序n（標(biāo)記符）程序1（標(biāo)記符）設(shè)計(jì)闡明【從本章開始，逐個(gè)地給出各個(gè)層次中每個(gè)程序設(shè)計(jì)考慮。如下給出提綱是針對(duì)普通狀況。對(duì)于一種詳細(xì)模塊，特別是層次比較低模塊或子程序，其諸多條目?jī)?nèi)容往往與它所從屬上一層模塊相應(yīng)條目?jī)?nèi)容相似，在這種狀況下，只要簡(jiǎn)樸地闡明這一點(diǎn)即可。】程序描述【給出對(duì)該程序簡(jiǎn)要描述，重要闡明安排設(shè)計(jì)本程序目意義，闡明本程序特點(diǎn)。】功能【闡明該程序應(yīng)具備功能，可采用IPO圖（即輸入一解決一輸出圖）形式?！啃阅堋娟U明對(duì)該程序所有性能規(guī)定，涉及對(duì)精度、靈活性和時(shí)間特性規(guī)定?！枯斎隧?xiàng)【給出對(duì)每一種輸入項(xiàng)特性，涉及名稱、標(biāo)記、數(shù)據(jù)類型和格式、數(shù)據(jù)值有效范疇、輸入方式。數(shù)量和頻度、輸入媒體、輸入數(shù)據(jù)來源和安全保密條件等等?！枯斎虢缑妗窘o出輸入項(xiàng)界面圖】輸出項(xiàng)【給出對(duì)每一種輸出項(xiàng)特性，涉及名稱、標(biāo)記、數(shù)據(jù)類型和格式，數(shù)據(jù)值有效范疇，輸出形式、數(shù)量和頻度，輸出媒體、對(duì)輸出圖形及符號(hào)闡明、安全保密條件等等?！枯敵鼋缑妗窘o出輸出項(xiàng)界面圖】算法【詳細(xì)闡明本程序所選用算法，寫出詳細(xì)計(jì)算公式和計(jì)算環(huán)節(jié)。】流程邏輯【用圖表（例如流程圖、鑒定表等）輔以必要闡明來表達(dá)本程序邏輯流程。如果涉及到界面，把界面要畫出來。】接口【用圖形式闡明本程序所從屬上一層模塊及從屬于本程序下一層模塊、子程序，闡明參數(shù)賦值和調(diào)用方式，闡明與本程序相直接關(guān)聯(lián)數(shù)據(jù)構(gòu)造（數(shù)據(jù)庫、數(shù)據(jù)文卷）。】存儲(chǔ)分派【依照需要，闡明本程序存儲(chǔ)分派?！孔⑨屧O(shè)計(jì)【闡明準(zhǔn)備在本程序中安排注釋，如：加在模塊首部注釋；加在各分枝點(diǎn)處注釋；對(duì)各變量功能、范疇、缺省條件等所加注釋；對(duì)使用邏輯所加注釋等等?！肯拗茥l件【闡明本程序運(yùn)營中所受到限制條件?！可形唇鉀Q問題【