软件设计说明书模板

1、XX 系统_1.0.0软件设计说明书XXXX软件股份有限公司文档说明本文档所涉及到的文字、图表等，仅限于XXX软件有限公司内部使用，未经书面许可，请勿扩散。文档属性：属性内容产品名称XXX产品版本1.0.0文档标题软件设计说明书文档版本1.0作者your name完成部1门XXX完成日期2011-10-25密级机密完成状态发布文档变更历史:用户确认:客户方公司方客户代表确认确认时间公司代表确认确认时间文档送呈:姓名目的本文档仅XXXXX软件有限公司和被呈送方内部使用，未经双方许可，请勿扩散到第三方。目录 TOC o 1-5 h z HYPERLINK l bookmark57 o Curren

2、t Document 前言1 HYPERLINK l bookmark60 o Current Document 编写目的1 HYPERLINK l bookmark63 o Current Document 适用范围1 HYPERLINK l bookmark66 o Current Document 参考资料1 HYPERLINK l bookmark69 o Current Document 术语定义2 HYPERLINK l bookmark72 o Current Document 概述2 HYPERLINK l bookmark75 o Current Document 产品定位3

3、 HYPERLINK l bookmark80 o Current Document 设计约束3 HYPERLINK l bookmark83 o Current Document 总体设计4 HYPERLINK l bookmark86 o Current Document 功能架构4 HYPERLINK l bookmark89 o Current Document 数据架构4 HYPERLINK l bookmark92 o Current Document 技术架构5 HYPERLINK l bookmark95 o Current Document 产品开发规范5 HYPERLINK

4、 l bookmark98 o Current Document UI布局规范6 HYPERLINK l bookmark101 o Current Document 前端开发规范6 HYPERLINK l bookmark104 o Current Document 后端开发规范6 HYPERLINK l bookmark107 o Current Document 代码风格规范7 HYPERLINK l bookmark110 o Current Document 目录及配置文件说明7 HYPERLINK l bookmark113 o Current Document 工程目录7 HYP

5、ERLINK l bookmark116 o Current Document 类存放目录8 HYPERLINK l bookmark119 o Current Document 配置文件目录8 HYPERLINK l bookmark122 o Current Document 页面配置目录8 HYPERLINK l bookmark125 o Current Document 代码提交规范9 HYPERLINK l bookmark128 o Current Document 功能模块设计9 HYPERLINK l bookmark134 o Current Document 功能模块11

6、0 HYPERLINK l bookmark137 o Current Document 子功能模块110 HYPERLINK l bookmark153 o Current Document 子功能模块212 HYPERLINK l bookmark156 o Current Document 功能模块212 HYPERLINK l bookmark159 o Current Document 非功能性需求的设计12 HYPERLINK l bookmark162 o Current Document 性能需求的设计12 HYPERLINK l bookmark181 o Current D

7、ocument 功能迁移需求的设计14 HYPERLINK l bookmark184 o Current Document 权限控制需求的设计14 HYPERLINK l bookmark187 o Current Document 浏览器版本要求的设计14 HYPERLINK l bookmark190 o Current Document 接口设计15 HYPERLINK l bookmark193 o Current Document 内部接口15内部接口 116 HYPERLINK l bookmark196 o Current Document 外部接口16外部接口 116 HYP

8、ERLINK l bookmark199 o Current Document 数据库设计17 HYPERLINK l bookmark204 o Current Document XX模块数据定义18表结构说明18视图说明20 HYPERLINK l bookmark244 o Current Document SQL 说明21存储过程21表存储说明22 HYPERLINK l bookmark280 o Current Document 性能设计23 HYPERLINK l bookmark290 o Current Document 图表目录251前言1.1编写目的【内容】说明此文档的主

9、要目的，如用来内部评审，或指导每个研发人员熟悉功能和相关设计等目的。【裁剪原则】此部分内容不允许裁剪掉。1.2适用范【内容】本文的主要受众以及产品适用的用户。如列出本产品的任务提出者、需求分析者、开发者、用户以及将运行该项软件的单位。具体开发范围注意与立项申请中的范围对应。【裁剪原则】此部分内容不允许裁剪掉。1.3参考资料表格1.参考资料表序号文档名称文档作者发表日期1234写本文档时用到的参考资料，可以是外部的一本书或文章，也可以是公司内部文档， 也可以是一个URL连接。如果是书、文章、内部文档，请写明名称、作者、发表日期等信息。如果是URL连接，请用简要内容加原始7RL的方式作为名称，如：

10、云计算的搭建实 践: HYPERLINK http:/aa.bb.cc.dd/xx.html http:/aa.bb.cc.dd/xx.html【裁剪原则】此部分内容不允许裁剪掉。1.4术语定义项目/产品中碰到的主要术语，包括技术和业务方面的，通常是业界已有的术语，对于 本产品要定义的概念，应该对应到需求规格说明书中的概念模型。【裁剪原则】此部分内容不允许裁剪掉。2概述【内容】本小段建议简要阐述一下设计人员对需求规格说明书的理解，从而做到需求到设 计的平滑过渡。设计评审的过程中，需求分析人员会非常看重“概述”及“总体设计”两大章节。【裁剪原则】此部分内容不允许裁剪掉。2.1产品定位【内容】简述

11、此系统“是什么”对应新产品，要让之前未接触过该领域的读者能看懂本章节，如说明什么领域的 什么人群会使用本产品，主要包括的几大项功能是什么；对于升级产品，在说明1的情况下，还要能简要说明产品本次升级版本的定位， 包括针对外部用户的变化（如主要哪几项功能得到提升或新增、用户体验如何得 到提升、操作如何得到简化等）和内部用户的变化（如实施人员的实施技能要求 如何降低、实施周期如何缩短）【裁剪原则】此部分内容不允许裁剪掉。2.2设计约束【内容】要涵盖需求规格说明书的“前置条件”章节，同时还可以根据需求增加：系统应 当遵循的标准或规范、软件、硬件环境的约束、接协议的约束等等。【裁剪原则】此部分内容不允许

12、裁剪掉。3总体设计3.1功能架构【内容】将系统分解为若干模块，绘制逻辑图，说明各模块如何协调工作，如何实现这些业务 功能。此功能架构图应该基于需求规格说明书中功能架构图的基础上进行细化，保持延 续性。如果是升级项目，请用不同颜色区分修改模块、新增模块与已有模块。【裁剪原则】此部分内容不允许裁剪掉。3.2数据架构【内容】本章节应该用一个大图或多个小图来画出系统具有的重要对象模型，以及这些对象模 型的关系（请注意参考需求规格说明书的概念模型章节并辅助以文字描述。对象模 型是用来描述、细化和串联：对象（实体概念发生在对象上的行为（动作概念）以及对 象之间关联关系的（关系可以在对象上作为属性同时关系本

13、身也可以作为对象）部分系 统对象又通过各种-人Mapping的开发手段持久化到了数据库中，对于这部分持久化了的 对象对应的数据库表，则还需要到“数据库设计”章节详细说明。【裁剪原则】此部分内容不允许裁剪掉。3.3技术架构【内容】说明系统采用的技术架构与物理部署结构，如下：技术架构：描述系统层次结构以及技术框架、组件的选用，请画图说明。物理部署架构：用来说明存在分布式部署，前置采集部署，远程部署等情况的物理部 署图，请画图说明。【裁剪原则】此部分内容不允许裁剪掉。4产品开发规范【内容】此章节是产品发布文档二次开发手册的重要来源，即产品研发相关的规范同样适 用于二次开发。鉴于产品的业务不同，可以根

14、据具体要求增加相关子章节而不仅限于目前的子章节。【裁剪原则】此部分内容不允许裁剪掉。4.1 UI布局规范【内容】UI布局规范是通用的规范，针对IXX公司发布的UI统一开发规oc来进行增 减（因为部分内容本产品可能用不到或者部分内容还要细化主要作为通用的布局和基本 界面布局的要求，未涉及到产品具体数据的呈现要求。通过本章节的规范来约束让本产品 的风格统一、界面漂亮。【裁剪原则】此部分内容不允许裁剪掉。4.2前端开发规范【内容】此处重点强调界面上根据本产品的业务特点说明如何尽量做到显示和组织数据的合理 性，从而不只做到漂亮，还要做到能提升用户体验包括：图形如何呈现、图表默认样式、 表格默认排序、表

15、格数据空值处理、网络速率数据的GT处理等，还可以包括前端页面 文件命名等，此部分是开发人员在开发页面作呈现时必须遵守的细节规定。【裁剪原则】此部分内容不允许裁剪掉。4.3后端开发规范【内容】此处重点强调后端开发的相关要求，如调度、接口、设计模式、文件类和函数命名、路径等等的统一要求，此部分是强调开发人员在开发后端程序时必须遵守的规定。【裁剪原则】此部分内容不允许裁剪掉。4.4代码风格规范【内容】此处重点强调代码的风格此部分是强调开发人员在开发所有程序时必须遵守的规定。【裁剪原则】此部分内容不允许裁剪掉。5目录及配置文件说明【内容】说明开发过程涉及到的配置文件、文件目录等的说明。此章节将作为产品

16、发布文档配置参考手册的重要来源。【裁剪原则】关于此系统若没有特殊说明，此部分内容不允许裁剪掉。5.1工程目录【内容】说明开发工程中CW或svn路径说明。【裁剪原则】关于此系统若没有特殊说明，此部分内容不允许裁剪掉。5.2类存放目录【内容】说明开发工程中京c下类包的分类、创建、修改、删除等相关的要求，说明代码包的 命名、结构和约束。【裁剪原则】关于此系统若没有特殊说明，此部分内容不允许裁剪掉。5.3配置文件目录【内容】说明开发过程中用到配置文件的说明。【裁剪原则】关于此系统若没有特殊说明，此部分内容不允许裁剪掉。5.4页面配置目录【内容】说明开发工程中表示层所等）文件的说明。【裁剪原则】关于此系

17、统若没有特殊说明，此部分内容不允许裁剪掉。5.5代码提交规范【内容】工程中开发人员代码提交的注意事项，一般应用在团队整体开发，在提交个人代码到 cvs 或svn上的说明。【裁剪原则】关于此系统若没有特殊说明，此部分内容允许裁减掉。6功能模块设计【内容】对模块功能设计进行描述，对应需求规格说明书的“产品功能”章节，同时务必 结合“产品原型”和“产品业务场景”进行详细叙述。此章节的子章节组成关系可对应到需求规格说明书中的“产品功能”章节（通常 章节上应该稍微多于需求规格说明书同时每个子功能在研发团队中都应该考虑如何履行 自测互测的相关工作：在提交测试之前，每个产品的每个版本的每个新做的子功能应该都

18、是经过自测互 测的，自测就是本子功能的开发人员自己做的测试，互测应该是和该子功能可能 相关的其他研发人员，比如推荐由该子功能的上下游的开发人员来进行互测，也 就是由提供者或者消费者来体验测试该子功能；提交给测试人员的每个产品的每个版本需要同时提交一份自测互测责任表 表格中为子功能和自测互测的交叉矩阵，每个子功能的自测不少升，互测不 少于2人，表格中的人员通常应该是参与代码编写的研发人员；提交给测试人员的每个产品的每个版本需要同时提交一份冒烟测试责任书此责任书的负责人应该是不参与写代码的支持人员或者业务人员；【裁剪原则】此部分内容不允许裁剪掉。6.1功能模块1【内容】简单总结本功能模块。【裁剪原

19、则】此部分内容不允许裁剪掉。6.1.1子功能模块1【内容】简单总结本子功能模块。【裁剪原则】此部分内容不允许裁剪掉。功能描述【内容】对本子功能模块的设计进行详细描述。【裁剪原则】此部分内容不允许裁剪掉。处理流程【内容】绘制本子功能模块的数据流图，说明本子模块相关的数据库表和配置文件，并对处理 流程进行详细描述。【裁剪原则】此部分内容不允许裁剪掉。约束【内容】设计中功能模块间存在的数据引用关系和内部的相关限制说明。【裁剪原则】此部分内容不允许裁剪掉。界面原型【内容】设计中功能模块准备实现的截图，此处务必首先参考原型。【裁剪原则】关于此系统若没有特殊说明，此部分内容允许裁剪掉。612子功能模块26

20、.2功能模块27非功能性需求的设计【内容】对应需求规格说明书的“非功能性需求”中的除“前置条件”和“集成需求”之 外四个章节的设计说明。因为：“前置条件”已对应到了本文档的“设计约束”而“集成需求”对应到了本文 档的“接口设计。【裁剪原则】此部分内容不允许裁剪掉。7.1性能需求的设计【内容】对应需求规格说明书的每个条目进行逐条设计的详细说明。系统关键业务的界面响应速度：G关键业务泛指用户使用较为频繁、用户体验较为重要的事务，如系统首页的 登录，自定义报表的展示，工单查询等。b）界面响应速度泛指事务响应时间，测试业界遵循5、10原则，即2秒内为 极佳的用户体验5秒内为良好的用户体驹0秒内为可以接

21、受的用户体验。此值在测试的时候应取最大响应时间，而非平均响应时间。但用户或此业务 不需要严格定义响应时间，建议选择平均响应时间。c）例: pasm系统登录响应时间应小于5秒，*报表响应时间小于5秒，查询操 作平均响应时间应小于5秒等。系统关键业务应支持的并发用户数：a）这里需要调研系统使用的总用户数、峰值在线用户数，取在线用户数施 为事务并发用户数。b）例:使用系统的用户部门00人，峰值在线20人，取峰值在线20人的10%=2 人为并发用户数。所以性能需求建议定为在线用户数20人，并发登录操作 2人，并发查询操傕人。如不想使用在线用户数，可修改为并发用户数 人。后端对服务器主机资源的占用、前端

22、对客户主机资源的占用：a）后端对服务器主机资源的占用，泛指中间件或系统进程对主机以、mem、 diskI/O等资源的占用情况。b）前端对客户主机资源的占用泛指B/S架构系统花浏览器对客户主机内存资 源的占用情况。c）例：patrolagent占用主机cpu资源小于5%，占用主机mem资源小于30m。 IE浏览器占用客户主机mem资源小于100m。后端服务运行时间的要求：a）7*24持续运行泛指较为重要的系统，不能随意重新启动或更新系统配置。b）临时性一次运行泛指可以重启系统调整配置参数，般用户单交易性能测试。c）周期性调度运行，泛指周期性采集调度系统。d）在运行时间要求的基础上，建议加入一定压

23、力为前置条件。e）例:nms系统在线用户20人，其中10人做历史告警查询,2个人做资源添 加，2个人做告警添加，2个人做工程预约，1个人做添加，3个人做资源查 询。要求系统稳定运行7*24小时。交易成功率100%，cpu资源占用小于10% 等。【裁剪原则】此部分内容不允许裁剪掉。7.2功能迁移需求的设计【内容】对应需求规格说明书的每个条目进行逐条设计的详细说明。【裁剪原则】此部分内容不允许裁剪掉。7.3权限控制需求的设计【内容】对应需求规格说明书的每个条目进行逐条设计的详细说明。【裁剪原则】此部分内容不允许裁剪掉。7.4浏览器版本要求的设计【内容】对应需求规格说明书的每个条目进行逐条设计的详细

24、说明。【裁剪原则】此部分内容不允许裁剪掉。8接口设计【内容】对应需求规格说明书的“集成需求”章节。此章节是产品发布文档二次开发手册的重要来源，通常产品发布文档的二次开 发手册只是发布给公司内部二次开发人员的部分，部分研发内部处理机制用的接口 并不对外发布到二次开发手册中，也就是本章节比二次开发手册要多要全。【裁剪原则】此部分内容不允许裁剪掉。8.1内部接口【内容】系统如何被分解为不同的子系统，子系统之间存在各种接口，同时还包括系统和公司 公共组件饱ISM、UIP、Report等）的接口。此章节需要描述子系统、公共组件它们俩俩之间如何协调工作的，可以通过它们之间 的接口名称、输入、输出、处理来说

25、明，同时表明它们之间相互依赖的关系。每个接口可以作为一个更小的子章节。【裁剪原则】此部分内容不允许裁剪掉。8.1.1内部接口 1【内容】描述一个具体的内部接口。同时要说明本接口相关的配置文件和数据库表。【裁剪原则】此部分内容不允许裁剪掉。8.2外部接口【内容】说明本系统同外界的所有接口。如果是纯产品开发，要求通过数据流图或时序图画出 本产品和公司其他产品的具体接口关系；如果是在基地项目中，要求通过数据流图或时序 图画出本产品和用户其他系统的具体接口关系。每个接口可以作为一个更小的子章节。【裁剪原则】此部分内容不允许裁剪掉。8.2.1外部接口 1【内容】描述一个具体的外部接口。同时要说明本接口相

26、关的配置文件和数据库表。【裁剪原则】此部分内容不允许裁剪掉。9数据库设计【内容】本章节的开头应该用一个大图或多个小图来画出系统具有的重要数据模型（不一定要 细到每张表）以及这些重要数据模型的关系（请注意参考需求规格说明书的概念模型 章节），可以是标准的战图，也可以是能说明关系的其他图。同时本章节应该说明对于系统跨不同类型数据库的支持是如何设计的，如果只支持一 种数据库，则请说明具体的数据库名称和版本。而以下子章节的内容则用来分模块说明数据库表、视图、存储过程、表存储的功能结 构，作为设计，可以采用两种方式之一来表述：直接嵌入从数据库建模工具导入的结构（如m模型），并说明打开查看的方法；在文档中

27、分章节进行描述：分章节进行描述的情况下，格式参考了产品发布文档 的数据库定义手册中的对应章节。此章节是产品发布文档数据库定义手册的重要来源，通常产品发布文档的数据 库定义手册只是发布给二次开发人员或者实施人员、最终用户的部分，部分研发内 部处理机制用的表格并不对外发布到数据库定义手册中。也就是本章节比数据 库定义手册要多要全。【裁剪原则】此部分内容不允许裁剪掉。9.1 XX模块数据定义9.1.1表结构说明XX 表【内容】描述该表的主要用途。91111表结构【内容】如果不同数据库，表结构不一致，请分开描述。表格3. SQL Server中的XX表结构名称类型描述允许空表格4. Oracle中的X

28、X表结构名称类型描述允许空表格5. Sybase中的XX表结构名称类型描述允许空表格6. MySQL中的XX表结构名称类型描述允许空.2表索引【裁剪原则】可选，没有可以不写。.3表存储【裁剪原则】此部分内容不允许裁剪掉。.4表分区【裁剪原则】此部分内容不允许裁剪掉。.5入库处理机制【内容】从界面录入通过内部工具导入通过外部工具导入通过接口与外部系统同步.6生命周期数据库表的生命周期数据库表数据的生命周期9.1.2视图说明XX 视图【内容】描述该视图的主要用途。.1基本信息【内容】视图的名称视图的类型构成视图的数据表与表之间的关系9121.2视图结构【内容】如果不同数据库，视图结构也不一致，请分开描述。表格7. XX视图结构名称类型描述关联表关联字段SQL 说明【内容】提交所有关于数据库操作的代码增删改查及纨操作，可以java代码形式）并标注 预计可能存在性能问题及关键模块需要优先考虑施L。【裁剪原则】此部分内容不允许裁剪掉。9.1.4存储过程 XX存储过程【内容】描述该存储过程的主要用途。91411执行规则执行频率，小时粒度的存储过程和天粒度的存