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

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

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

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

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