软件设计说明书模板

1、XX 软件设计说明书页数共 页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 分发记录Copy No.Holders Name & Role 持有者和角色Issue Date 分发日期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 软件系统上下文定义：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模块/子系统分解Concurrent Process Decomposition并发进程处理分解Data

4、 Decomposition数据分解92.2.2Dependency Description依赖性描述Module/subsystem Dependencies模块/子系统间的依赖关系 Process Dependencies 进程间依赖关系Data Dependencies数据依赖关系102.2.3Interface Description接口描述Module/Subsystem Interfaces模块/子系统接口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）数据库（可选）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 数据描述Simple Data Description 简单数据描述；Structure 1 or Class 1 结构1或类1Structure 2 or Class 2 结构2或类2143.1.2Function Description 函数描述Function 1 函数1Function 2 函数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).解释软件产品将完成或不完成的功能（可以直接描述也可以参考相关文档）.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 软件系统上下文定义：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.本节描述待开发软件系统与外部实体的关系.，可以使用系统结构图、数据流图、事务图等来描述系统结构和交互关系。外部实体属性描述只限于软件设计和描述相关的属性。考虑到描述的完整性，可参考相关软件实体文档，如OS程序员手册。.2 Design Considerations (Optional)设计思路(可选).1 Design Methodology 设

11、计方法Describe design methodoloy that shall be used in the software system design.描述本软件系统所采取的设计方法.2 Design Alternatives 设计可选方案 Aanalysis several alternatives of system design scheme,and specify the scheme that shall be used . 对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案.3 Design Constraints 设计约束 1.Standards complian

12、ce 遵循标准Describe standards that software system shall comply with.描述本软件所遵循的标准、规范 2.Hardware Limitations 硬件限制Describe hardware limitations of the software system.描述本软件系统实现的硬件限制 3.Technology Limitations 技术限制Describe technology limitations of the software system.描述本软件的技术限制.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. 这里要描述软件系统的总体结构。Architecture diagram, Hierarchical decomposition diagram, natural language can be used to represent the architectur

14、e.总体结构描述可以使用结构图，层次分解图，自然语言。.1 Decomposition Description分解描述.1 Module/Subsystem Decomposition模块/子系统分解This section describes subsystems ,module in the system.本节描述系统中的子系统和模块。 1.Module/Subsystem 1 Description模块/子系统1描述Describe as follows 按照以下格式描述：Identification 标识：Type 类型：Purpose目的：Functions 功能列表：.2 Conc

15、urrent Process Decomposition并发进程处理分解This section descibes concurrent processes in the system.本节描述系统中的并发进程。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数据分解This section descibes data stores in the system.本节描述系统中的数据结构。External data entities shall not be described.外部数据实体不必描述。 1. Data Entity 1 Description数据实体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.本节描述系统中的子系统，数据结构，模块，进程等设计实体间的关系。Structure charts, data flow diagrams, transaction diagrams，ER diagram can be used to represent dependences.依赖关系描述可以使用结构图，数据流图，（交互）事务图,ER图。.1 Module/subsystem Depend

18、encies模块/子系统间的依赖关系 This section describes relationships among subsystems， modules。本节描述子系统，模块间的关系。Dependencies description can be organized by Functions or by Modules.依赖关系的描述可以按功能进行组织，也可以按模块进行组织。Structure charts, data flow diagrams, transaction diagrams can be used to represent dependences.依赖关系描述可以使用

19、结构图，数据流图，（交互）事务图.2 Process Dependencies 进程间依赖关系This section descibes relationships among processes本节描述进程间的关系。data flow diagrams, transaction diagrams can be used to represent dependences.依赖关系描述可以使用结构图，数据流图，（交互）事务图。.3 Data Dependencies数据依赖关系This section descibes relationships among data stores。本节描述数据

20、结构间的关系。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。本节描述软件系统中设计实体(如子系统，模块，进程）的接口.Interface files, parameter tables can be used to describe

21、Interface .接口描述可以使用接口文件，参数表。In case of external entities, only the interfaces relevant to the software being described need be described.对于外部实体只有同被描述软件相关的接口才需描述。.1 Module/Subsystem Interfaces模块/子系统接口This section describes interfaces of Module/Subsystem Interfaces。本节描述模块/子系统的接口。 1. Module/Subsystem 1

22、 Description模块/子系统1描述Describe as follows 按照以下格式描述：Identification 标识：Type 类型：Purpose目的：Functions 功能列表：.2 Process Interfaces进程接口This section describes interfaces of process。本节描述进程的接口。 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中定义的每个实体的进一步设计在下面的章节进行描述。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 描述模板内部的依赖关系，如两个子模块的依赖关系等。.3 Interface Description 接口描述 Describe the interface within the module. I.e. interface within two sub modules描述模块内部的接口关系，如两个子模块间的接口等。.1 Database （Optional）数据库（可选）.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.本节列出所有的数据存储类的实体，详细描述实体的内容和并列出全部属性。对每个属性，详细描述其数据库、数据大小、特定约束。实体的所有约束及实体间的关系也要注明。.2 E-R diagram 实体关系 图This section should display the E-R diagram for all the entities listed above. 本节描述关于上节提到的所有实体的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.本节应该集中描述软件实体的详细描述，而这些实体作为软件部件在软件设计文档中得到描述。.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 .描述模块中定义和使用的数据，包括：简单数据，如模块级的全局变量、常量；复合数据，如模块内部的类、结构，.；.1 Data Description 数据描述describe simple variables and constant of the module in section ;describe complex data fr

30、om section , such as class、structure;在中描述本模块中的简单变量、常量；从起描述本模块中的复合数据，如类、结构等；.1 Simple Data Description 简单数据描述；describe simple variables、constant used or defined in this module;描述在本模块中定义和使用的简单变量、常量；.2 Structure 1 or Class 1 结构1或类1define and describe the Data structure;定义和说明该数据结构；.

31、3 Structure 2 or Class 2 结构2或类2.2 Function Description 函数描述Describe the relationships of the functions within Module描述模块内函数的调用关系.1 Function 1 函数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