xxx系统软件设计
注:以上为标题,标题中xxx为具体的项目名称。本文档斜体字部分为注解。
1. 概述
1.1. 系统简介
注:对软件要解决的问题、系统功能、系统总体软件结构做简单介绍。
1.2. 目标读者
注:谁将阅读本文档?
1.3. 书写约定
注:特殊的字体,比如粗体字、斜体字表示什么含义;缩写的含义等。
2. 总体设计
注:用UML组件图描述软件的总体架构。陈述对系统进行如此分解的依据。
注:然后对总体架构中的每一个组件分小节描述。对每一个组件,用文字描述它所承担的功能;所使用的服务;所提供的服务。如下所示:
2.1. xxx组件
2.2. xxx组件
3. 详细设计
注:对每一个接口和组件进行详细描述。对每一个接口,列出所有的函数,包括函数名、参数和返回类型,并用简短的文字描述它的功能。对每一个组件,用UML类图描述它所包含的类,类中的属性和操作需完整,对关键的操作用UML活动图、状态图或者顺序图等表示。
3.1. xxx接口详细设计
3.2. xxx接口详细设计
3.3. xxx组件详细设计
3.4. xxx组件详细设计
4. 数据设计
注:如果需要对数据永久存储,即需要存储到文件或者数据库中,则需要对文件格式或数据库格式进行描述。对数据库,可以用一张表格介绍每一个关系模式中字段的名称、含义和类型。
5. 系统部署
注:用UML部署图或者类似的框图来描述系统在硬件上的部署方案。
6. 其它事项
注:上述章节中未尽事宜可在此描述。