軟件概要設(shè)計(jì)說明書編寫規(guī)范

1、文件名稱概要設(shè)計(jì)說明書編寫規(guī)范文件編號(hào)XXX版次制定部門技術(shù)部制定日期蟲他軟件產(chǎn)品概要設(shè)計(jì)說明書編寫規(guī)范此編寫規(guī)范是本公司軟件項(xiàng)目的概要設(shè)計(jì)過程的主要可交付成果一概要設(shè)計(jì)說明書的編寫規(guī)范。本規(guī)范定義了概要設(shè)計(jì)說明書的最大集標(biāo)準(zhǔn)范本。特定項(xiàng)目組可以根據(jù)本規(guī)范進(jìn)行合理的內(nèi)容剪裁，對(duì)于沒有包含的元素，請(qǐng)?zhí)顚憽盁o?！?，以便保持所有概要設(shè)計(jì)說明書在內(nèi)容編排上的一致性性。本規(guī)范強(qiáng)制要求對(duì)軟件需求有良好的可追蹤性。編寫人員應(yīng)該使用適當(dāng)?shù)奈臋n間的超級(jí)鏈接技術(shù)來加強(qiáng)這種可追蹤性。建議使用本規(guī)范的組織在實(shí)際應(yīng)用中根據(jù)本規(guī)范給設(shè)計(jì)人員提供模板。本規(guī)范提到的主要設(shè)計(jì)模型請(qǐng)參考軟件設(shè)計(jì)過程指南。1引言1.1 編寫目的（

2、描述本文檔的編寫目的。）1.2 項(xiàng)目背景（描述本文檔所在的軟件項(xiàng)目的背景資料。）1.3 定義1.3.1 引用名詞1名詞1的解釋（定義本概要設(shè)計(jì)說明書所引用的名詞的含義。）1.4 參考資料1.4.1 文檔名稱1»版本號(hào)，作者，編寫時(shí)間（羅列本概要設(shè)計(jì)說明書在編寫過程中參考的文獻(xiàn)資料。）任務(wù)概述目標(biāo)（描述本文檔所在的軟件項(xiàng)目的主要目標(biāo)。）運(yùn)行環(huán)境（描述本文檔設(shè)計(jì)的軟件運(yùn)行時(shí)依賴的軟硬組件和在功能完整的前提下必備的網(wǎng)絡(luò)環(huán)境或設(shè)備。）需求概述（描述本文檔設(shè)計(jì)的軟件的基本數(shù)據(jù)、功能和行為需求。建議采用規(guī)范說明中建議的超級(jí)鏈接技術(shù)和需求規(guī)格說明書中的內(nèi)容進(jìn)行相關(guān)聯(lián)。）軟件設(shè)計(jì)規(guī)范設(shè)計(jì)方法規(guī)范設(shè)計(jì)

3、模型規(guī)范程序設(shè)計(jì)語(yǔ)言（PDL）規(guī)范（PDL語(yǔ)言規(guī)范見程序設(shè)計(jì)語(yǔ)言（PDL）規(guī)范。如果該規(guī)范不能滿足設(shè)計(jì)要求，可以補(bǔ)充或重新定義。）編程語(yǔ)言規(guī)范（軟件項(xiàng)目小組制定在設(shè)計(jì)時(shí)應(yīng)該共同遵守的標(biāo)準(zhǔn)：采用的設(shè)計(jì)方法、設(shè)計(jì)模型、描述軟件處理過程的偽文件名稱概要設(shè)計(jì)說明書編寫規(guī)范文件編號(hào)XXX版次制定部門技術(shù)部制定日期蟲他碼規(guī)范以及系統(tǒng)物理實(shí)現(xiàn)做采用的編程語(yǔ)言的規(guī)范。這些規(guī)范同樣適合在詳細(xì)設(shè)計(jì)說明書中。）結(jié)構(gòu)設(shè)計(jì)軟件結(jié)構(gòu)（根據(jù)前面定義的設(shè)計(jì)方法規(guī)范采用合適的結(jié)構(gòu)模型來描述軟件模塊化成不同組件之間的依賴關(guān)系。對(duì)于復(fù)雜的軟件系統(tǒng)，設(shè)計(jì)人員應(yīng)該將結(jié)構(gòu)模型層次化。先展示系統(tǒng)與外部環(huán)境或外部組件之間的依賴關(guān)系，然后將系

4、統(tǒng)分成子系統(tǒng)后之間的依賴關(guān)系，再具體到子模塊。圖示符號(hào)：系統(tǒng)結(jié)構(gòu)圖、UML勺類圖和對(duì)象圖等。）軟件結(jié)構(gòu)描述（準(zhǔn)確地描述軟件結(jié)構(gòu)中各種組件的處理功能或行為、異常處理對(duì)策和約束條件。）組件交互（根據(jù)軟件結(jié)構(gòu)中的系統(tǒng)架構(gòu)展現(xiàn)有依賴關(guān)系組件之間的交互過程。圖示符號(hào)：系統(tǒng)流程圖、UML的順序圖和協(xié)作圖等。）組件交互描述（準(zhǔn)確地描述軟件結(jié)構(gòu)中不同組件之間或與外部環(huán)境或外部組件之間交互的信息（數(shù)據(jù)、控制或消息）。）接口設(shè)計(jì)（對(duì)在節(jié)4中設(shè)計(jì)的組件之間的交互進(jìn)行接口規(guī)范定義。接口規(guī)范要包含接口數(shù)據(jù)的類型、接口子程序的原型等。）外部接口設(shè)計(jì)（明確定義本文檔設(shè)計(jì)的所有軟件組件與外部環(huán)境（非人）或外部組件之間接口的規(guī)

5、范。）內(nèi)部接口設(shè)計(jì)（明確定義本文檔設(shè)計(jì)的所有軟件組件之間接口的規(guī)范。）人機(jī)界面設(shè)計(jì)（明確定義本文檔設(shè)計(jì)的軟件與操作這之間的接口界面規(guī)范。）數(shù)據(jù)設(shè)計(jì)數(shù)據(jù)對(duì)象和形成的數(shù)據(jù)結(jié)構(gòu)（明確定義本文檔設(shè)計(jì)的軟件處理的全局或核心數(shù)據(jù)對(duì)象（名稱及屬性等）和物理的數(shù)據(jù)結(jié)構(gòu)。）全局?jǐn)?shù)據(jù)（明確定義本文檔設(shè)計(jì)的軟件的全局或核心的數(shù)據(jù)。）安全保密設(shè)計(jì)（定義本文檔設(shè)計(jì)的軟件在安全保密方面的處理對(duì)策。）維護(hù)設(shè)計(jì)故障處理設(shè)計(jì)（定義當(dāng)本文檔設(shè)計(jì)的軟件在出現(xiàn)故障時(shí)的規(guī)范性的錯(cuò)誤提示風(fēng)格和處理方法，明確故障的歷史記錄形式。）兼容性設(shè)計(jì)（明確陳述本文檔設(shè)計(jì)的軟件在運(yùn)行時(shí)如何適應(yīng)外部依賴環(huán)境的變化。）組件部署設(shè)計(jì)（明確規(guī)定本文檔設(shè)計(jì)的軟件中的各種組件的組件名稱和代碼（源代碼或目標(biāo)代碼）之間的關(guān)系。）文件名稱概要設(shè)計(jì)說明書編寫規(guī)范文件編號(hào)XXX版次制定部門技術(shù)部制定日期蟲他10集成設(shè)計(jì)（明確描述本文檔設(shè)計(jì)的軟件的各種組件在依賴平臺(tái)上集成組裝的策略、順序和測(cè)試要點(diǎn)。）11復(fù)用設(shè)計(jì)（明確描述本文檔設(shè)計(jì)的軟件的各種組件中哪些是以前開發(fā)的或外部的