系统概要设计说明书编写标准全套.docxVIP

系统概要设计说明书编写标准

1前言

1.1文档目的

文档编写目的是为了阐述XXX系统的概要设计。概要设计说明书是为了说明整个XXX系统的体系架构，以及需求用例的各个功能点在架构中的体现，为系统的详细设计人员进行详细设计时的输入参考文档。本说明书的预期读者为系统设计人员、系统开发人员和项目评审人员。

1.2背景

XXX系统是

[项目背景]

1.3文档范围

1、产品范围：根据《需求规格说明书》，该文档阐述软件产品的功能

2、涉及到的干系人有：公司高层、客户、项目经理、质量小组、开发小组。

1.4读者对象

项目经理、质量保证人员：据此来进入项目策划过程

测试人员：据此进入测试过程。

需求管理员、配置管理员：可以识别配置项制定相关的活动计划

用户IT主管：清楚与确认项目需求。

开发人员，包括设计人员、编码人员：明确任务与需求，清楚项目开发流程。

1.5参考文档

《需求规格说明书》

1.6术语与缩写解释

术语或缩略语

解释

2总体设计

2.1系统描述

2.1.1系统概述

XXX系统，采用XXX架构开发出的XXX平台。

2.1.2运行环境

对本平台所赖于运行的硬件、软件环境的描述。

1.服务端操作系统：WindowsServer2003SP2及以上；

2.服务端运行环境：JDK1.7及以上；

3.数据库支持：Oracle10g企业版；

4.协议支持：TCP/IP、HTTP、HTTPS、SMTP、POP3等；

5.硬件支持：服务器CPU2.0GHz以上、内存2G以上、需要300G以上的空闲磁盘空间；

6.网络环境：有固定公网IP，网络畅通，可以远程访问(远程桌面连接或者借助辅助工具)；

7.客户端要求：IE10以上；

2.1.3数据管理要求

2.1.4故障处理要求

（1）产品支撑环境运行错误，包括以下几个方面：

数据库运行错误：系统无法使用，将提供错误提示页面，并记录日志。

系统配置参数错误：系统提供错误提示页面，要求管理员修改相关配置参数。配置参数的修改方法应参考相关为管理员提供的手册。

系统参数初始化错误：提供系统初始化功能，用于成批完成系统初始化。在初始化过程中，对于严重影响平台运行的错误，提供错误提示页面。对于普通错误，记录日志。

应用程序错误：由应用程序提供错误提示页面，相关错误应记录日志。

2.1.5其他要求

2先进性：采用先进成熟的技术，确保系统的先进性、经济性和实用性。

2安全可靠：提供的应用框架及平台本身提供应用安全保证，并可以和第三方安全手段，如认证、加密、电子签名等进行集成。必须保证数据的安全性和必威体育官网网址性。对于基于平台开发的应用系统，只允许有权限的人员进行操作和浏览信息。必须有安全的手段来进行权限控制。

2开放互连：系统应对各类业务系统、数据库系统、WEB信息等具有通用的或可定制的接口策略和连接方法。

2规范性：开发过程控制、开发技术、系统编码、文档应规范化，并遵循相应的国内外标准。开发结束，需要提供必要的文档资料。

2可靠性：保证系统的可靠运行和在升级过程中的方便快捷。

2可扩充性：系统应当可以根据需求的变化，方便地进行功能的调整、增减，模块的升级和系统架构的逐步完善。

2界面友好、操作方便：操作界面要直观、简单、贴近实际，操作过程应当尽量简化，符合实际过程。身份认证过程即要保证安全，也要尽量简化认证过程。

2可维护性：系统维护应当简单。

2.2总体设计说明

2.2.1基本设计概述

从《需求规格说明书》出发，根据需求分析阶段确定的功能设计软件系统的整体结构、划分功能模块、确定每个模块的实现算法以及编写具体的代码，形成软件的具体设计方案。

2.2.2设计思想

本概要设计主要由结构设计、接口设计、全局数据结构设计及其他方面设计组成。需遵循软抽象、模块化、信息隐蔽及模块独立性等特征。模块独立性从两个方面度量：

(1)内聚性：偶然内聚、逻辑内聚、时间内聚、过程内聚、通信内聚、顺序内聚、功能内聚。

(2)耦合性：内容耦合、公共耦合、外部耦合、控制耦合、标记耦合、数据耦合、非直接耦合

2.2.3系统总体结构

系统总体结构

2.2.4处理流程

【描述系统主要功能模块的处理流程】

3接口设计

3.1外部接口

【描述系统与外部第三方系统之间的接口】

3.2内部接口

【描述系统内部各子系统之间的接口】

4系统结构设计

4.1模块1

4.1.1功能A

1.界面原型

2.实现功能

4.1.2功能B

1.界面原型

2.实现功能

4.2模块2

4.2.1功能C

1.界面原型

2.功能说明

4.2.2功能D

1.界面原型

2.功能说明

5系统数据结构

5.1逻辑结构设计要点

XXX系统采用ORACLE数据库。该数据库基都是关系数