概要设计说明书示例Word格式.docx

概要设计说明书示例Word格式.docx

《概要设计说明书示例Word格式.docx》由会员分享，可在线阅读，更多相关《概要设计说明书示例Word格式.docx（12页珍藏版）》请在冰豆网上搜索。

2.3.3外部接口设计6

3子系统设计6

3.1生产系统子系统6

3.1.1子系统说明6

3.1.2类图8

3.1.3界面设计11

3.2中间件子系统11

3.2.1子系统说明11

3.2.2类图11

3.2.3界面设计12

3.3应用系统子系统12

3.3.1子系统说明12

3.3.2类图12

3.3.3界面设计12

4约束和假定12

5系统数据结构设计13

5.1逻辑结构设计13

5.2物理结构设计13

5.3数据结构与程序的关系13

6系统出错处理设计13

6.1出错信息13

6.2补救措施13

6.3系统维护设计13

站群系统概要设计说明书

1引言

1.1编写目的

此概要设计说明书是为了说明整个系统的体系架构，以及需求用例的各个功能点在架构中的体现，为系统的详细设计人员进行详细设计时的输入参考文档。

1.2背景

软件系统的名称：

站群系统

开发工具：

MicrosoftVisualStudio2010

开发语言：

c#+javascript

1.3定义

1.4参考资料

2总体设计

2.1简述

系统采用流行的B/S结构模式。

系统的分析设计采用面向对象的技术，应用Visio等工具进行辅助设计。

2.2架构设计

2.2.1系统业务逻辑架构图

2.2.2系统物理架构图

站群整体系统

生产系统

2.2.3子系统关系图

数据调取（ftp,web空间,数据库空间）

发出操作命令

提供web,DB空间

1订单信息

目标发布环境

1+2抽取方式生成

2,应用系统

（全部）

2.3接口设计

2.3.1界面框架设计

2.3.2内部接口设计

2.3.2.1总体层面上的接口

客管系统与虚拟机系统间的接口：

客管系统将用户信息及订单信息提交到虚拟机系统，由虚拟机系统按照订单上的信息划分出把需文件空间及数据空间，并将已分配的数据库IP，数据库名，数据库用户名及密码，及文件空间信息等返回给客管系统

客管系统与生产系统间的接口：

客管系统将虚拟机系统返回的信息及用户订单提交到生产系统，生产系统按照用户订单，进行组装，最终将组装后的产品发布到客管系统提供的文件空间及数据库空间内，同时将所需测试数据导入。

如果订单没有明确描述用户需求，则生产系统需要在发布完成时，将已使用挂件信息统计并返回到客管系统。

生产系统与中间件系统间的接口：

生产系统在创建新项目时，需要在本地预建立文件结构，并从中间件系统中复制所有挂件及挂件的配置和所需的文件等，中间件系统则提供复制的方法

在用户需要增加新功能时，生产系统将本地版本与中间件中的版本进行对比，如果存在新版本，则升级到最新挂件版本

应用系统与中间件系统间的接口：

应用系统在完成挂件的制作以后，通过注册的方式，将制作完成的挂件发布到中间件中

2.3.2.2生产系统接口

参见详细设计说明书

2.3.2.3中间件系统接口

2.3.2.4应用系统接口

2.3.3外部接口设计

说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。

3子系统设计

3.1生产系统子系统

3.1.1子系统说明

生产系统子系统包括：

创建站点管理、页面管理、应用系统选择、挂件装配、挂件样式设置、站点资源管理、站点发布管理、用户、权限管理、工作日志管理、与中间件、客管平台对接管理。

用户、权限管理：

用户系统利用SSO，使生产系统与客管系统、应用系统使用的是同一个用户模块，用户在各模块内的权限由各模块独立提供。

流程说明：

在用户首次进入系统时（生产，应用，中间件），系统检查用户提交信息是否附带了token信息，如果没有附带，将引导用户登录，将用户名密码提交到SSO服务统一验证，如验证通过将用户名及密码等信息加密生成token返回给用户系统，系统将用户提交的token信息提交到SSO服务进行验证，如果用户没有登录，则登录成功进入系统，如果用户已经登录，则提示用户已经登录，登录失败的信息

工作日志管理：

目前主要是针对用户聊天截图，可以附带文字说明，除文字说明外和资源管理可以共用图片管理。

与中间件对接：

生产系统仅在新建项目和升级项目应用系统或挂件时才会和中间件系统产生联系，其它时间为独立运行。

说明：

仅在创建站点及升级时才需从中间件中获取信息

与客管平台对接管理：

由客官系统发起项目，最终由生产系统，将项目使用信息反馈给客管系统。

3.1.2类图

总体依懒图

业务层：

数据层：

3.1.3界面设计

3.2中间件子系统

3.2.1子系统说明

中间件子系统主要功能包括：

挂件注册、解包、动态编译、简单版本管理、挂件获取、挂件升级，并记录每次用户获取的信息，及获取次数，及统计挂件或应用使用的热度。

备注：

用户自定义的挂件，不需涉及到动态库的问题。

3.2.2类图

Repository包提供两种挂件

1、公司内部自主研发的挂件

2、公司外的兴趣爱好者开发的挂件

3.2.3界面设计

3.3应用系统子系统

3.3.1子系统说明

应用系统子系统包括：

制作挂件，注册挂件，挂件升级

3.3.2类图

3.3.3界面设计

4约束和假定

描述系统设计中最主要的约束，这些是由客户强制要求并在需求说明书写明的。

说明系统是如何来适应这些约束的。

　　另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功能辅助，那么系统可能还受到其它的约束。

这种情况下，要求清楚地描述与本系统有交互的软件类型（比如某某某数据库软件，某某某EMail软件）以及这样导致的约束（比如只允许纯文本的Email）。

　　实现的语言和平台也会对系统有约束，同样在此予以说明。

　　对于因选择具体的设计实现而导致对系统的约束，简要地描述你的想法思路，经过怎么样的权衡，为什么要采取这样的设计等等。

包括运行环境的约束，简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定，详细说明参见附录C。

5系统数据结构设计

5.1逻辑结构设计

注：

表和表字段命名规范：

参考开发设计规范

5.2物理结构设计

给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。

5.3数据结构与程序的关系

说明各个数据结构与访问这些数据结构的形式:

6系统出错处理设计

6.1出错信息

用一览表的方式说朗每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。

6.2补救措施

说明故障出现后可能采取的变通措施，包括：

a.后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术；

b.降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录；

c.恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。

6.3系统维护设计

说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。

各个程序之间的对应关系，可采用如下的矩阵图的形式；