軟件文檔模板-軟件概要設(shè)計

1、（產(chǎn)品名稱） 軟件概要設(shè)計 玉海科技200年 月目次 TOC o 1-5 h z 1范圍1標(biāo)識1系統(tǒng)概述1文檔概述2引用文檔2文檔約定2概要設(shè)計2CSCI 概述2CSCI 結(jié)構(gòu)3系統(tǒng)狀態(tài)和模式3容量和時間要求3CSCI設(shè)計說明34. 1. 1 CSCI 結(jié)構(gòu)V說明：描述CSCI的內(nèi)部結(jié)構(gòu)。應(yīng)指明CSC和其下一級的CSC及其用途，并描述各CSC 之間的相互關(guān)系.該關(guān)系要指出各CSC到CSC接口的用途，并概述通過接口傳送的 數(shù)據(jù).本節(jié)還應(yīng)指出所有被合并到CSCI的非開發(fā)軟件.本節(jié)需要詳細(xì)表達(dá)CSCI內(nèi)部的功能模塊劃分.并推薦用圖來說明.對于接口協(xié)議特別簡單的，可以在此說明.對于接口協(xié)議復(fù)雜的，可以

2、用單獨(dú)文檔說 明.一般接口協(xié)議，可以在后面以通信接口 CSC形式加以詳細(xì)說明，通?？蓮挠脩艚涌?， 硬件接口和軟件接口三方面考慮系統(tǒng)狀態(tài)和模式說明：指出每個CSCI操作的系統(tǒng)狀態(tài)和模式以及在此狀態(tài)和模式下執(zhí)行的CSCo 通過流程圖等形式說明CSCI內(nèi)部各CSC之間的控制流程和數(shù)據(jù)流程或消息流.對于一般的單片機(jī)程序，對于內(nèi)部狀態(tài)和中斷等可以在此說明.在VxWorks上工作的軟件，建議在此節(jié)說明內(nèi)部的任務(wù)劃分和相互間的通信方式. 基于Windows工作的軟件,建議在此節(jié)說明內(nèi)部的進(jìn)程/線程劃分和相互間的交互4. 1.3容量和時間要求說明：提供分配給CSC的內(nèi)存和進(jìn)程時間以及其它關(guān)鍵資源。即使和需求說

3、明類似， 在此也必須做出說明。對于內(nèi)存分配有限制，尤其是實(shí)時性有特殊要求的，以及一些特殊資源，例如某些特定的 寄存器，端口等資源的使用，需要在此節(jié)作出說明.另外如果對性能方面例如系統(tǒng)容量，響應(yīng)時間等有需要，也可以在此說明。4.2 CSCI設(shè)計說明4. 2. 1 CSC名稱和工程唯一標(biāo)識號玉?？萍?說明：應(yīng)該分成以下局部描述CSC:1,主要功能；CSC設(shè)計描述.可使用流程框圖等方式對內(nèi)部流程處理進(jìn)行描述.如果有下一級CSC,在此描述下一級CSC的劃分，以及相互之間的接口關(guān)系。通常應(yīng)考慮 以下內(nèi)容：a,內(nèi)部處理模塊；b,接口處理。CSC設(shè)計需求和設(shè)計約束.（對有節(jié)容量和時間要求的資源限制和相關(guān) 性

4、能要求局部作出說明.）. 2.1.1 如果有必要劃分下一級CSC ,從本小節(jié)開始做類似4. 2. 1節(jié)描述CSCI數(shù)據(jù)數(shù)據(jù)結(jié)構(gòu)說明說明：主要的數(shù)據(jù)結(jié)構(gòu)，類定義描述，用于指導(dǎo)后續(xù)編碼測試維護(hù)等工作全局變量說明說明：主要的全局變量描述，用于指導(dǎo)后續(xù)編碼測試維護(hù)等工作.CSCI數(shù)據(jù)文件說明：分節(jié)對所使用的數(shù)據(jù)庫及使用數(shù)據(jù)庫的方式作詳細(xì)說明。對使用的配置文件等相關(guān)數(shù)據(jù)文件進(jìn)行說明.如果物理存儲有特殊要求，需要在 此說明。分小節(jié)對具體數(shù)據(jù)文件的用途，大小，訪問方法,內(nèi)部記錄的結(jié)構(gòu)和大小作出說明.建議以 圖表的方式對涉及的數(shù)據(jù)項的數(shù)據(jù)類型，數(shù)據(jù)表示，大小，單位，值域，精確度等屬性進(jìn) 行說明.或以專門文件說明.玉?？萍夹枨罂勺粉櫺哉f明:如果在軟件需求和接口需求規(guī)格說明里面對CSC/CSU需求有詳細(xì)描述，在此可以 用圖表等方式提供一個全景瀏覽,將相關(guān)工程和CSU/CSC 一一對應(yīng),便于以后的需 求控制.如果需求規(guī)格說明里面沒有作詳細(xì)描述，可以省略.盡量直接引