软件设计说明书模板

XX系统_1.0.0软件设计说明书

XXXX软件股份有限公司

文档说明

本文档所涉及到的文字、图表等，仅限于XXX软件有限公司内部使用，未经书面许可，请勿扩散。

文档属性：

文档变更历史：

用户确认：

文档送呈：

目录

1前言 (1)

1.1编写目的 (1)

1.2适用范围 (1)

1.3参考资料 (1)

1.4术语定义 (2)

2概述 (2)

2.1产品定位 (3)

2.2设计约束 (3)

3总体设计 (4)

3.1功能架构 (4)

3.2数据架构 (4)

3.3技术架构 (5)

4产品开发规范 (5)

4.1UI布局规范 (6)

4.2前端开发规范 (6)

4.3后端开发规范 (6)

4.4代码风格规范 (7)

5目录及配置文件说明 (7)

5.1工程目录 (7)

5.2类存放目录 (8)

5.3配置文件目录 (8)

5.4页面配置目录 (8)

5.5代码提交规范 (9)

6功能模块设计 (9)

6.1功能模块1 (10)

6.1.1子功能模块1 (10)

6.1.2子功能模块2 (12)

6.2功能模块2 (12)

7非功能性需求的设计 (12)

7.1性能需求的设计 (12)

7.2功能迁移需求的设计 (14)

7.3权限控制需求的设计 (14)

7.4浏览器版本要求的设计 (14)

8接口设计 (15)

8.1内部接口 (15)

8.1.1内部接口1 (16)

8.2外部接口 (16)

8.2.1外部接口1 (16)

9数据库设计 (17)

9.1XX模块数据定义 (18)

9.1.1表结构说明 (18)

9.1.2视图说明 (20)

9.1.3SQL说明 (21)

9.1.4存储过程 (21)

9.1.5表存储说明 (22)

9.2性能设计 (23)

10图表目录 (25)

1 前言

1.1 编写目的

【内容】

说明此文档的主要目的，如用来内部评审，或指导每个研发人员熟悉功能和相关设计等目的。

【裁剪原则】

此部分内容不允许裁剪掉。

1.2 适用范围

【内容】

本文的主要受众以及产品适用的用户。如列出本产品的任务提出者、需求分析者、开发者、用户以及将运行该项软件的单位。

具体开发范围注意与《立项申请》中的范围对应。

【裁剪原则】

此部分内容不允许裁剪掉。

1.3 参考资料

表格1.参考资料表

【内容】

写本文档时用到的参考资料，可以是外部的一本书或文章，也可以是公司内部文档，也可以是一个URL连接。

如果是书、文章、内部文档，请写明名称、作者、发表日期等信息。

如果是URL连接，请用简要内容加原始URL的方式作为名称，如：

云计算的搭建实践:.dd/xx.html

【裁剪原则】

此部分内容不允许裁剪掉。

1.4 术语定义

表格2.术语定义表

【内容】

项目/产品中碰到的主要术语，包括技术和业务方面的，通常是业界已有的术语，对于本产品要定义的概念，应该对应到《需求规格说明书》中的概念模型。

【裁剪原则】

此部分内容不允许裁剪掉。

2 概述

【内容】

本小段建议简要阐述一下设计人员对《需求规格说明书》的理解，从而做到需求到设计的平滑过渡。

设计评审的过程中，需求分析人员会非常看重“概述”及“总体设计”两大章节。

【裁剪原则】

此部分内容不允许裁剪掉。

2.1 产品定位

【内容】

简述此系统“是什么”：

1.对应新产品，要让之前未接触过该领域的读者能看懂本章节，如说明什么领域的

什么人群会使用本产品，主要包括的几大项功能是什么；

2.对于升级产品，在说明1的情况下，还要能简要说明产品本次升级版本的定位，

包括针对外部用户的变化（如主要哪几项功能得到提升或新增、用户体验如何得到提升、操作如何得到简化等）和内部用户的变化（如实施人员的实施技能要求如何降低、实施周期如何缩短）。

【裁剪原则】

此部分内容不允许裁剪掉。

2.2 设计约束

【内容】

要涵盖《需求规格说明书》的“前置条件”章节，同时还可以根据需求增加：系统应

当遵循的标准或规范、软件、硬件环境的约束、接口/协议的约束等等。

【裁剪原则】

此部分内容不允许裁剪掉。

3 总体设计

3.1 功能架构

【内容】

将系统分解为若干模块，绘制逻辑图，说明各模块如何协调工作，如何实现这些业务功能。

此功能架构图应该基于《需求规格说明书》中功能架构图的基础上进行细化，保持延续性。

如果是升级项目，请用不同颜色区分修改模块、新增模块与已有模块。

【裁剪原则】

此部分内容不允许裁剪掉。

3.2 数据架构

【内容】

本章节应该用一个大图或多个小图来画出系统具有的重要对象模型，以及这些对象模型的关系（请注意参考《需求规格说明书》的概念模型章节），并辅助以文字描述。对象模型是用来描述、细化和串联：对象（实体概念）、发生在对象上的行为（动作概念）以及对象之间关联关系的（关系可以在对象上作为属性，同时关系本身也可以作为对象）。部分系统对象又通过各种O-R Mapping的开发手段持久化到了数据库中，对于这部分持久化了的