軟件設計說明書模板

1、XX 軟件設計說明書頁數(shù)共 頁XX Software Design SpecificationXX 軟件設計說明書擬制姓名+工號日期yyyy-mm-dd審核日期yyyy-mm-dd批準日期yyyy-mm-ddRevision record修訂記錄Date日期Revision version修訂版本Description修訂描述Author作者yyyy-mm-ddVX.XXXX姓名+工號Distribution List 分發(fā)記錄Copy No.Holders Name & Role 持有者和角色Issue Date 分發(fā)日期1yyyy-mm-dd2yyyy-mm-dd3yyyy-mm-dd4y

2、yyy-mm-dd5yyyy-mm-ddCatalog 目 錄1Introduction 簡介71.1Purpose 目的71.2Scope 范圍71.2.1Name 軟件名稱71.2.2Functions 軟件功能71.2.3Applications軟件應用72High Level Design概要設計 82.1Level 0 Design Description第0層設計描述82.1.1Software System Context Definition 軟件系統(tǒng)上下文定義：82.1.2Design Considerations (Optional)設計思路(可選)Desi

3、gn Methodology 設計方法Design Alternatives 設計可選方案Design Constraints 設計約束Other Design Considerations 其他82.2Level 1 Design Description第一層設計描述92.2.1Decomposition Description分解描述Module/Subsystem Decomposition模塊/子系統(tǒng)分解Concurrent Process Decomposition并發(fā)進程處理分解Data

4、 Decomposition數(shù)據(jù)分解92.2.2Dependency Description依賴性描述Module/subsystem Dependencies模塊/子系統(tǒng)間的依賴關系 Process Dependencies 進程間依賴關系Data Dependencies數(shù)據(jù)依賴關系102.2.3Interface Description接口描述Module/Subsystem Interfaces模塊/子系統(tǒng)接口Process Interfaces進程接口112.3Level 2 Design De

5、scription第二層設計描述（Optional）122.3.1Module name (1) 模塊1名稱Decomposition Description 分解描述Dependency Description 依賴性描述Interface Description 接口描述122.4Database （Optional）數(shù)據(jù)庫（可選）132.4.1Entity, Attributes and their relationships 實體、屬性及它們之間的關系132.4.2E-R diagram 實體關系 圖133Detailed Desi

6、gn詳細設計143.1 Module 1 Detail Design模塊一詳細設計143.1.1Data Description 數(shù)據(jù)描述Simple Data Description 簡單數(shù)據(jù)描述；Structure 1 or Class 1 結(jié)構(gòu)1或類1Structure 2 or Class 2 結(jié)構(gòu)2或類2143.1.2Function Description 函數(shù)描述Function 1 函數(shù)1Function 2 函數(shù)216Table of contents for the table表目錄T

7、able 1 XX 表1 XX6Table of contents for the figure圖目錄 Figure 1 XX 圖 1 XX7XX Software Design Specification XX 軟件設計說明書Keywords 關鍵詞：Abstract 摘 要：List of abbreviations 縮略語清單：.1 Introduction 簡介.1 Purpose 目的This section should state the purpose of the document. It could also specify the intended audience. 這

8、部分要描述文檔的目的，并指明適用的讀者。.2 Scope 范圍.1 Name 軟件名稱Identify the software by name對軟件命名.2 Functions 軟件功能Explain what the software product(s) will and will not do (either directly or by reference to another software document).解釋軟件產(chǎn)品將完成或不完成的功能（可以直接描述也可以參考相關文檔）.3 Applications軟件應用Describe the application of the p

9、roduct (either directly or by reference to another software document)描述軟件的應用（可直接描述也可以參考其他軟件文檔）2 High Level Design概要設計 .1 Level 0 Design Description第0層設計描述.1 Software System Context Definition 軟件系統(tǒng)上下文定義：This section describes relationships between the software system to be developed and external enti

10、ties.Architecture Diagram,DFD (Data-Flow-Diagram)or transaction diagrams can be used to describe architecture and interaction.本節(jié)描述待開發(fā)軟件系統(tǒng)與外部實體的關系.，可以使用系統(tǒng)結(jié)構(gòu)圖、數(shù)據(jù)流圖、事務圖等來描述系統(tǒng)結(jié)構(gòu)和交互關系。外部實體屬性描述只限于軟件設計和描述相關的屬性。考慮到描述的完整性，可參考相關軟件實體文檔，如OS程序員手冊。.2 Design Considerations (Optional)設計思路(可選).1 Design Methodology 設

11、計方法Describe design methodoloy that shall be used in the software system design.描述本軟件系統(tǒng)所采取的設計方法.2 Design Alternatives 設計可選方案 Aanalysis several alternatives of system design scheme,and specify the scheme that shall be used . 對本軟件系統(tǒng)的幾種設計方案進行分析、比較，并確定所采用的方案.3 Design Constraints 設計約束 1.Standards complian

12、ce 遵循標準Describe standards that software system shall comply with.描述本軟件所遵循的標準、規(guī)范 2.Hardware Limitations 硬件限制Describe hardware limitations of the software system.描述本軟件系統(tǒng)實現(xiàn)的硬件限制 3.Technology Limitations 技術(shù)限制Describe technology limitations of the software system.描述本軟件的技術(shù)限制.4 Other Design Considerations

13、其他Describe other design considerations of the software system.描述其他有關的設計考慮.1 Level 1 Design Description第一層設計描述Architecture of the software system shall be described here. 這里要描述軟件系統(tǒng)的總體結(jié)構(gòu)。Architecture diagram, Hierarchical decomposition diagram, natural language can be used to represent the architectur

14、e.總體結(jié)構(gòu)描述可以使用結(jié)構(gòu)圖，層次分解圖，自然語言。.1 Decomposition Description分解描述.1 Module/Subsystem Decomposition模塊/子系統(tǒng)分解This section describes subsystems ,module in the system.本節(jié)描述系統(tǒng)中的子系統(tǒng)和模塊。 1.Module/Subsystem 1 Description模塊/子系統(tǒng)1描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functions 功能列表：.2 Conc

15、urrent Process Decomposition并發(fā)進程處理分解This section descibes concurrent processes in the system.本節(jié)描述系統(tǒng)中的并發(fā)進程。In case of external entities, Subordinates attribute need not be described. 對于外部實體，從屬屬性不必描述。 1. Process 1 Description進程1描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functio

16、ns 功能列表：.3 Data Decomposition數(shù)據(jù)分解This section descibes data stores in the system.本節(jié)描述系統(tǒng)中的數(shù)據(jù)結(jié)構(gòu)。External data entities shall not be described.外部數(shù)據(jù)實體不必描述。 1. Data Entity 1 Description數(shù)據(jù)實體1描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：.2 Dependency Description依賴性描述This section desci

17、bes relationships among the design entities such as subsystems, data stores, modules, and processes etc.本節(jié)描述系統(tǒng)中的子系統(tǒng)，數(shù)據(jù)結(jié)構(gòu)，模塊，進程等設計實體間的關系。Structure charts, data flow diagrams, transaction diagrams，ER diagram can be used to represent dependences.依賴關系描述可以使用結(jié)構(gòu)圖，數(shù)據(jù)流圖，（交互）事務圖,ER圖。.1 Module/subsystem Depend

18、encies模塊/子系統(tǒng)間的依賴關系 This section describes relationships among subsystems， modules。本節(jié)描述子系統(tǒng)，模塊間的關系。Dependencies description can be organized by Functions or by Modules.依賴關系的描述可以按功能進行組織，也可以按模塊進行組織。Structure charts, data flow diagrams, transaction diagrams can be used to represent dependences.依賴關系描述可以使用

19、結(jié)構(gòu)圖，數(shù)據(jù)流圖，（交互）事務圖.2 Process Dependencies 進程間依賴關系This section descibes relationships among processes本節(jié)描述進程間的關系。data flow diagrams, transaction diagrams can be used to represent dependences.依賴關系描述可以使用結(jié)構(gòu)圖，數(shù)據(jù)流圖，（交互）事務圖。.3 Data Dependencies數(shù)據(jù)依賴關系This section descibes relationships among data stores。本節(jié)描述數(shù)據(jù)

20、結(jié)構(gòu)間的關系。ER diagram can be used to represent dependences.依賴關系描述可以使用ER圖。.3 Interface Description接口描述This section describes interfaces of the design entities (such as subsystem,module, process)that make up the system。本節(jié)描述軟件系統(tǒng)中設計實體(如子系統(tǒng)，模塊，進程）的接口.Interface files, parameter tables can be used to describe

21、Interface .接口描述可以使用接口文件，參數(shù)表。In case of external entities, only the interfaces relevant to the software being described need be described.對于外部實體只有同被描述軟件相關的接口才需描述。.1 Module/Subsystem Interfaces模塊/子系統(tǒng)接口This section describes interfaces of Module/Subsystem Interfaces。本節(jié)描述模塊/子系統(tǒng)的接口。 1. Module/Subsystem 1

22、 Description模塊/子系統(tǒng)1描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functions 功能列表：.2 Process Interfaces進程接口This section describes interfaces of process。本節(jié)描述進程的接口。 1.Process 1 Description進程1描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functions 功能列表：.1 Level 2

23、 Design Description第二層設計描述（Optional）Each entity that is defined in L1 and identified for further description shall be described by separate sub-sections as mentioned below.L1中定義的每個實體的進一步設計在下面的章節(jié)進行描述。This will be repeated for each module as follows.對每個模塊重復使用下述的格式。.1 Module name (1) 模塊1名稱Dont actually

24、 write Module name (1). Specify the name of the module in few words. 不要寫直接“模塊1名稱”，用簡短的詞語命名模塊，.1 Decomposition Description 分解描述Provide and describe the decomposition of the module. E.g. the functionality of each sub modules 描述模塊的分解，并描述每個子模塊的功能等屬性。.2 Dependency Description 依賴性描述 Describe the dependenc

25、y within the module. I.e. dependency within two sub modules 描述模板內(nèi)部的依賴關系，如兩個子模塊的依賴關系等。.3 Interface Description 接口描述 Describe the interface within the module. I.e. interface within two sub modules描述模塊內(nèi)部的接口關系，如兩個子模塊間的接口等。.1 Database （Optional）數(shù)據(jù)庫（可選）.1 Entity, Attributes and their relationships 實體、屬性及它

26、們之間的關系This section could list all the entities such as data stores, a verbose description of what that entity pertains to and list of all its attributes. For each of the attributes, its database, the data size, specific constraints and a verbose description of that attribute should be specified. All

27、 specific constraints for that entity and its relationship with other entities should also be noted.本節(jié)列出所有的數(shù)據(jù)存儲類的實體，詳細描述實體的內(nèi)容和并列出全部屬性。對每個屬性，詳細描述其數(shù)據(jù)庫、數(shù)據(jù)大小、特定約束。實體的所有約束及實體間的關系也要注明。.2 E-R diagram 實體關系 圖This section should display the E-R diagram for all the entities listed above. 本節(jié)描述關于上節(jié)提到的所有實體的E-R圖1

28、Detailed Design詳細設計This section should focus on the description of the detailed design of the software entities that are a part of the software being described by the Software Design Document.本節(jié)應該集中描述軟件實體的詳細描述，而這些實體作為軟件部件在軟件設計文檔中得到描述。.1 Module 1 Detail Design模塊一詳細設計Describe data that defined or used

29、 in the module, including:simple data i.e. global variable or constant within the module;complex data i.e. class or structure .描述模塊中定義和使用的數(shù)據(jù)，包括：簡單數(shù)據(jù)，如模塊級的全局變量、常量；復合數(shù)據(jù)，如模塊內(nèi)部的類、結(jié)構(gòu)，.；.1 Data Description 數(shù)據(jù)描述describe simple variables and constant of the module in section ;describe complex data fr

30、om section , such as class、structure;在中描述本模塊中的簡單變量、常量；從起描述本模塊中的復合數(shù)據(jù)，如類、結(jié)構(gòu)等；.1 Simple Data Description 簡單數(shù)據(jù)描述；describe simple variables、constant used or defined in this module;描述在本模塊中定義和使用的簡單變量、常量；.2 Structure 1 or Class 1 結(jié)構(gòu)1或類1define and describe the Data structure;定義和說明該數(shù)據(jù)結(jié)構(gòu)；.

31、3 Structure 2 or Class 2 結(jié)構(gòu)2或類2.2 Function Description 函數(shù)描述Describe the relationships of the functions within Module描述模塊內(nèi)函數(shù)的調(diào)用關系.1 Function 1 函數(shù)1 Descript the function as follows; Function: / name of function Description: / functionality of the function Calls: / function lists which called by this function Called By: / function lists which call this funciton Table Accessed: / tables to be visited / (only for programm which involved with operation about database) Table Updated: / tables to be modified / (only for programm which involved with operation