概要设计说明书-模板(referrence)

1.第1章 引言
 目的
 背景
 参看资料
 定义
2.第2章 系统概述
 实现目标
 运行环境
  开发环境
  运行环境
3.第3章 总体设计
 设计思想
 设计规范
  界面设计规范
  程序设计规范
  数据库设计规范
 系统设计总体描述
  体系结构
  技术选型
  核心框架
  系统功能设计、
 系统详细功能描述
4.第4章 接口设计
 外部接口
 内部接口
5.第5章 模块结构设计
6.第6章 系统出错处理设计
 出错处理信息
 出错处理机制
7.第7章 代码定义
 业务状态

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
中国移动无线城市集中运营服务平台系统 概要设计说明书 文档标识: 当前版本: 1.0 当前状态: 草稿 发布日期: 2012-8-28 发布  修改历史 日期 版本 作者 修改内容 评审号 变更控制号 2012-8-28 1.0 新建 目 录 1 总则 3 1.1 目的 3 1.2 读者对象 3 1.3 参考文档 3 1.4 术语与缩写 4 2 概述 4 2.1 设计目标 4 2.2 实现功能 5 3 总体架构 5 3.1 软件体系结构 5 3.2 物理架构 5 3.2.1 硬件系统部署图 5 3.2.2 各主机、存储及网络系统规划 6 3.2.3 关键技术 6 4 系统接口 6 5 系统平台搭建 7 5.1 平台资源 7 5.2 系统软件部署情况 7 6 规范与规则 8 6.1 设计工具 8 6.2 设计规范与约定 8 6.3 编程工具 8 6.4 编程规范 8 7 附录 8 1 总则 1.1 编写目的 描述撰写该文档的目的。 示例:为了开发人员更好的从整体上把把握系统,理解需求、快速准确地进行概要设计与详细设计,同时方便今后设计人员和开发人员的维护工作,特在《01-湖南移动渠道系统功能规格说明书.doc》的基础上撰写此文档资料。 1.2 读者对象 描述该文档的阅读对象。 示例:该文档的读者主要是设计师,开发人员,项目经理,需求分析师, 以及相关人员等。 1.3 参考文档 描述该文档的参考文档。 示例:【中国移动集团公司】: 《中国移动省级经营分析系统规范总册1.5.0.doc》 《中国移动省级经营分析系统业务规范-基础业务分册1.5.0.doc》 《中国移动省级经营分析系统业务规范-数据业务分册1.5.0.doc》 《中国移动省级经营分析系统业务规范-集团客户分册1.5.0.doc》 《中国移动省级经营分析业务规范渠道运营管理分析监控分册v2.0(送审稿).doc》 1.4 术语与缩写 描述该文档的术语及解释。 缩写 英文描述 中文描述 CMCC China Mobile Communication Corporation 中国移动通信公司 BASS Bussiness & Analysis Suport System 经营分析支撑系统 BOSS Business & Operation Support System 业务运营支撑系统 DSMP Data Service Management Platform 数据业务管理平台 ETL Extraction, Transformation, Loading 抽取、转换和加载(是数据获取过程) 2 概述 对该系统进行设计概述,设计模式等; 2.1 设计目标 描述该文档的设计目标。 示例:渠道运营支撑系统产品设计需要在技术、业务需求等方面满足以下目标。 1、技术上: 在系统的外部接口以及内部子系统的接口设计上。建立统一接口平台和数据分发平台,分别用于处理联机交易接口和批量数据接口,采用通用的标准协议、提供丰富的底层封装,提高了标准化和开放性。 2、业务需求 渠道运营支撑系统产品通过对系统的重新构建,全面系统地支持自BASS2.0运行后移动运营商新的业务需求,同时满足中国移动BASS2.0部分业务技术规范的功能要求。 2.2 实现功能 描述能够实现的需求范围。 枚举各模块(根据需求规格分析说明书来描述) 3 总体架构 3.1 软件体系结构 描述该项目的软件体系架构(附图)。一般为三层结构。 示例: 3.2 物理架构 3.2.1 硬件系统部署图 描述该项目的硬件系统部署情况(附图)。 3.2.2 各主机、存储及网络系统规划 详细描述该项目的各主机,存储以及网络规划情况。包括:数据库服务器,ETL服务器,Web服务器;存储规划,网络规划以及接口机和备份机的规划情况(根据项目的实际运行环境进行描述)。 3.2.3 关键技术 描述该系统所采用的关键技术。 示例:ETL(数据的抽取,转换和加载) 多维分析(OLAP) 电子地图 4 功能模块 4.1 模块1 场景 功能说明 输入输出 功能点 流程图 4.2 模块2 5 系统接口 描述本系统与外部系统的接口,以及与各系统之间的数据传输约定(传输协议,传输频率等)。 示例: 渠道运营支撑系统的外部接口包括:BOSS系统,数据仓库,电子渠道以及新业务体验营销等。渠道运营支撑系统与BOSS系统采用FTP的传输协议,由联创公司按照日接口,月接口等约定进行数据传输。 日接口:每日13:00之前将前日的日数据主动传输至以下目录: 以标志文件进行传输过程结束的标志(该文件需要说明文件大小,文件记录数等信息) 6 系统平台搭建 6.1 平台资源 详细描述该项目的平台资源。 示例: 主机功能 主机型号(CPU/GB) 主机名 IP地址 操作系统 系统软件(版本) 加载存储(分升级前、升级后) 数据仓库数据库服务器1 IBM P690,16CPU,32GB Memory BASDBB 10.154.144.11 AIX 5200-09 DB2 V8.2(fp10),JDK 64bit 26.5T+14.5T=41T 数据仓库数据库服务器2 IBM P690,16CPU,32GB Memory BASDBB 10.154.144.13 AIX 5200-09 DB2 V8.2(fp10),JDK 64bit 。。。。。。。 。。。。。。。 。。。。。。。 。。。。。。。 。。。。。。。 。。。。。。。 6.2 系统软件部署情况 详细描述该项目的系统软件部署情况。包括数据库,展现工具、其它工具的部署。 示例:BRIO平台 序号 主机地圵 用户 口令 说明 1 10.154.144.163 administrator ****** 仓库Brio Server;Windows操作系统,远程连接(VNC)密码:hnbas2005 2 10.154.144.165 administrator ****** 集市Brio Server;Windows操作系统,远程终端连接 7 规范与规则 7.1 设计工具 确定该项目模型设计设计工具。目前是ERWIN4.1或powerdesign。 示例: 采用Rational Rose2003、PowerDesign12作为设计工具。 7.2 设计规范与约定 描述设计的参考规范和设计约定。 7.3 编程工具 描述该项目的编程工具。 示例: 本系统采用.net(c#)进行开发。 7.4 编程规范 描述编程的参考规范。 示例: 本系统采用拓维公司发布的.net编码规范进行编码。 8 附录 描述该文档需要参考的其他文档目录。
项目名称 软件概要设计说明书 版本:V1.0 文 档 编 号 保 密 等 级 作 者 最后修改日期 审 核 人 最后审批日期 批 准 人 最后批准日期 修订记录 日期 版本 修订说明 修订人 目 录 1 引言 1 1.1 编写目的 1 1.1.1 作用 1 1.1.2 预期读者 1 1.2 编写背景 1 1.2.1 系统名称及版本号 1 1.2.2 任务提出者 1 1.2.3 任务承接者及实施者 1 1.2.4 使用者 1 1.2.5 与其它系统的关系 1 1.3 文档结构 1 1.4 电子文档编写工具 1 1.5 定义说明与符号规定 2 1.6 参考资料 2 2 系统概述 2 2.1 系统目标 2 2.2 设计原则 3 2.3 运行环境 3 2.3.1 硬件平台 3 2.3.2 软件平台 3 2.3.3 网络体系结构 3 2.4 应用软件整体结构概述 3 2.5 关键技术 4 3 数据库设计 4 4 代码设计 4 5 功能概述 4 5.1 功能模块命名原则 4 5.2 功能层次图 4 5.3 功能简介 4 5.4 外部接口 4 6 用户界面设计 4 6.1 基本原则 4 6.2 设计概述 4 7 出错处理 5 7.1 出错信息设计 5 7.2 异常情况处理 5 引言 编写目的 作用 【说明】《软件概要设计说明书》是在《软件需求规格说明书》的基础上,通过我方与用户方反复沟通形成的。它必须充分反映《软件需求规格说明书》中的用户需求,如有改动必须征得用户的认可。它将作为项目验收时重要的的标准和依据。 从另一方面讲,它又是开发人员在下一阶段进行系统详细设计的纲领性文件,也是考核系统总体质量的重要技术文档。 预期读者 【说明】本文档的阅读对象是软件开发人员、业务规范设计人员、软件测试人员、系统安装人员及用户代表。 编写背景 系统名称及版本号 【说明】形如“北京市地方税务局管理信息系统V3.0”。其中,版本号的格式为“XX.XX”,X为阿拉伯数字,左“0”可省略。 任务提出者 【说明】指《工作说明书》中规定的我方领导机构或项目负责人。 任务承接者及实施者 【说明】指承担概要设计的负责人及工作人员名单。 使用者 【说明】适应对象和范围。主要指预期读者,也供有关领导审阅。 与其它系统的关系 【说明】在用户现有的及预期的整个应用系统中,给本系统准确定位。用示意图及相应的文字予以说明。 文档结构 【说明】章节划分原则、内容的取舍、重点的确定等。 电子文档编写工具 【说明】工具名、版本号、操作系统平台。使用多种工具时,应分别说明。形如: Microsoft Word 97 for Windows 95 Power-Designor 6.0 for Windows 95 PhotoShop 4.0 for Windows 95 Visio或Power Point 定义说明与符号规定 【说明】包括对专用术语及缩略语的解释、所用到的图(E-R图/功能层次图)中图符的表示与解释、屏幕界面中图标与按钮的表示与含义等。如在E-R图中,表示两个实体之间的关系时,我们定义了以下图符(部分举例): 终结符 基数(自左至右) 1 多 终结符 基数 存在性 说明(自左至右) 1 强制 必须存在且只能存在1个 多 强制 必须存在1个或多个 1 任选 可能存在1个,或没有 多 任选 可能存在1个或多个,或没有 参考资料 【说明】格式:作者,[版本号,]资料来源,日期 [,起止页号]。其中,《质量保证计划》与《需求规格说明书》是必选的参考资料。 系统概述 系统目标 【说明】开发意图、应用目标(总目标、分期目标)、作用范围、预期效益等。 设计原则 【说明】设计原则应包括: 质量管理应贯穿于整个设计之全过程。 对质量保证的承诺应落实到全体人员。 实际执行的过程中,必须符合项目自身的特点,体现个性差异,切实做到有的放矢。 运行环境 硬件平台 【说明】指出本系统对硬件设备的需求、我们选型的原则和依据、推荐的型号与配置、性能综述、技术优势、特殊约定等。 软件平台 【说明】使用操作系统的名称、生产厂家、版本号等。 使用数据库的名称、生产厂家、版本号等。如使用了多种数据库,则要说明如何 实现互连。 其它支撑软件:指出开发与运行时需要的工具软件的情况,如4GL等。 对于选用的各类软件,均应着重说清其技术特点、与国内外同类产品的比较,明 确阐述我方选择的理由。 网络体系结构 【说明】写明网络设计原则、技术要求、产品选型、拓扑结构、基本部件与配件、传输介质、接口情况、通信协议、约束条件、结构化综合布线方案等。 画出网络结构图。图中应标出各类服务器与客户机、网管机、路由器、网关等的数量与分布;应反映出局域网、广域网及其互连的情况;如使用国内的公用数据网或Internet,也须具体标出。 用文字说明各个服务器/客户机的作用、配置与具体位置。例如:Oracle数据库服务 器1台,位于局信息中心,用于支撑征管业务信息处理、领导决策辅助支持、各征管业务科室的信息采集、查询及统计工作。它安装在IBM RS6000小型机上,操作系统是AIX 3.2。 说明拟采取的网络保护技术,如防火墙等。 应用软件整体结构概述 【说明】说明本系统的各层模块、公用模块的划分原则。 如果系统复杂而开发者又有比较多的技术积累,应说明其分层构造(如组件层、构件层与应用子系统层)。 对于大的系统,应画出体系结构图并予以说明。 关键技术 【说明】本系统采用了哪些关键技术,如算法、中间件、构件等。 指出使用了那些主要工具。 解释作出上述选择的理由。 说明这些关键技术在整体结构中的位置及内外接口。 数据库设计 【说明】单独成册,见《数据库设计说明书模板》 代码设计 【说明】 给出系统设计中的代码的设计内容,代码设计包括系统代码(硬码)、系统代码(软码)、业务代码以及标准化代码等。对于硬码的引用需要在数据库设计的PDM中注明,对于其他代码的引用需要在数据字典或数据库设计中注明。 功能概述 功能模块命名原则 【说明】指出本系统的各层模块/公用模块的划分原则、命名原则、编号原则。并且需要指出在概要设计中的功能模块编号与《软件需求规格说明书》中的业务需求编号及性能需求编号之间的对应关系。 功能层次图 【说明】指明在输入信息转变为输出信息的过程中,为了满足用户的业务需求,应用软件必须完成的基本动作。采用自然语言叙述+树状功能图描绘的方式。由此确定系统最终的菜单结构。 功能简介 【说明】用一览表或框图的形式扼要说明每个模块的编号、名称和基本功能。用矩阵形式标明《软件需求规格说明书》中列出的各项功能需求与模块之间的对应关系。 外部接口 用户界面设计 基本原则 【说明】指出基本风格、屏幕总体布局和输入/输出的常规手段。 设计概述 【说明】本节的内容也可以归入附录“设计与编程规范、惯例及约定”中,而不在这里 叙述。 一般地讲,界面设计应包括以下几项: □屏幕环境设置 □字型与字体 □颜色 □提示 □菜单(Menu) □按钮(Command Button) □图标 □列表框 □常用键 □Data Windows生成标准 □窗口定义 □日期类型 (特别要注意解决“千年虫”问题) □界面语言 □其它 出错处理 出错信息设计 【说明】扑捉出错信息、分析定位、提示信息。 异常情况处理 【说明】错误处理方案与帮助手段。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值