概要设计说明书

一、概要设计的目的

  将软件系统需求转换为未来系统的设计;
  逐步开发强壮的系统构架;
  使设计适合于实施环境,为提高性能而进行设计;
  结构应该被分解为模块和库。


二、概要设计的任务

        制定规范: 代码体系、接口规约、命名规则。

        这是项目小组今后共同作战的基础,有了开发规范和程序模块之间和项目成员彼此之间的

    接口规则、方式方法,大家就有了共同的工作语言、共同的工作平台,使整个软件开发工作可以协调有序地进行。
  总体结构设计:

  功能(加工)->模块:每个功能用那些模块实现,保证每个功能都有相应的模块来实现;

  模块层次结构:某个角度的软件框架视图;

  模块间的调用关系:模块间的接口的总体描述;

  模块间的接口:传递的信息及其结构;

  处理方式设计:满足功能和性能的算法

  用户界面设计;

  数据结构设计:

  详细的数据结构:表、索引、文件;

  算法相关逻辑数据结构及其操作;

  上述操作的程序模块说明(在前台?在后台?用视图?用过程?- - - - - - )

  接口控制表的数据结构和使用规则

  其他性能设计。

概要设计说明书模板

1       引言
1.1       编写目的

[说明编写这份概要设计说明书的目的,指出预期的读者。 ]

1.2       背景

[说明:
待开发软件系统的名称;
列出此项目的任务提出者、开发者、用户以及运行该软件的最终用户。]

1.3       术语定义

[列出本文中用到的术语的定义和外文首字母组词的原词组。]

1.4       参考资料

[列出有关的参考文件,如:
本项目的经核准的计划任务书或合同,上级机关的批文;
属于本项目的其他已发表文件;
本文件中各处引用的文件、资料,包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。 ]

2     总体设计
 2.1      架构目标和约束

               [说明对架构具有某种重要影响的软件需求和目标,例如安全性、保密性、市售产品的使用、可移植性、发布和重新使用。还要记录可能适用的特殊约束;设计与实施策略,开发工具,团队结构,时间表,旧代码等]

   2.2.1      运行环境   

          _   _cpu:      内存:        硬盘:        网速:     操作系统:       浏览器:         java环境:      

 2.2      系统部署图

             部署图

一个UML部署图描述了一个运行时的硬件结点,以及在这些结点上运行的软件组件的静态视图。 部署图显示了系统的硬件,安装在硬件上的软件,以及用于连接异构的机器之间的中间件。 创建一个部署模型的目的包括∶

  1. 探究系统投产的相关问题.
  2. 探究你的系统和生产环境中的其它系统的依赖关系,这些系统可能是已经存在,或是将要引入的。
  3. 描述一个商业应用主要的部署结构。
  4. 设计一个嵌入系统的硬件和软件结构。
  5. 描述一个组织的硬件/网络基础结构。

结点和组件:*用描述性术语命名结点;仅仅建模重要的软件组件;为组件一致地应用一致版型;把可视化的版型应用到结点。

依赖和通信关联:*用版型来注明通信协议;仅仅建模组件间的关键性依赖

图一 学生管理系统应用部署图



 图二 网络架构部署图

 
 图三 售票系统描述层部署图



 2.3      技术架构图

             技术架构图

   2.3.1      设计构思   

             [说明对本系统的设计构思、采用的关键技术、主要算法和数据结构。要考虑子系统的运行控制、出错设计、安全运行控制、效率性能等问题]

3   逻辑视图
   3.1 概述

        1.总体功能模块分解视图  

[本节按照设计模型中包的层次结构来说明设计模型的整体分解情况。该视图以图形方式说明关键的用例实现、子系统、包和类,它们包含了在构架方面具有重要意义的行为。逻辑视图在每次迭代过程中都会加以改进。]

        2.分解的功能模块与需求的对应矩阵。

   3.2 子系统名称
    3.2.1  简要说明

    [对包/子系统做描述说明]

    3.2.2  包含元素

     [列出该包或子系统包含的包或子系统,再列出包所包含的类,用类图的方式展示。]

     [明确各元素之间关系]

    3.2.3  购买复用分析

     [确定哪些现有的可重用的包/子系统。重用表现为使用共享服务、循环利用服务器和基础硬件、建立的文档、构件、设计或任何以前为其它项目所用的参考资料]

    3.2.4  接口

     [定义包/子系统与其它包/子系统的数据交换接口。描述接口名称、类型、参数说明等描述]

    3.2.5  时序图

      [说明类要执行的既定行为,操作应支持序列图中的消息内容]



 

4. 接口
4.1外部接口

    [描述与本系统产生数据交换的外部系统之间的接口。

    1.接口分类:发送或接收

    2.数据结构设计:数据名称、数据类型、数据说明等。

    3.接口数据分类说明:说明共几种类型的接口数据,每种类型数据的典型说明

    4.接口数据之间的应答关系说明:发送和接收数据的对应关系说明。如:采用的交互方式、通讯协议、报文格式、是否需要特殊装置等。]   

4.2 用户接口

    [说明本系统向用户提供的命令、语法结构及系统回答信息等]

5. 系统维护               

    [说明专门安排用于系统检测与维护的检测点和系统检测维护的专用模块等。]     

6. 尚待解决的问题          

    [说明本设计中尚未解决而系统完成之前应该解决的问题。]  


  • 1
    点赞
  • 15
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
项目名称 软件概要设计说明书 版本: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生成标准 □窗口定义 □日期类型 (特别要注意解决“千年虫”问题) □界面语言 □其它 出错处理 出错信息设计 【说明】扑捉出错信息、分析定位、提示信息。 异常情况处理 【说明】错误处理方案与帮助手段。
bi 概要设计说明书是指仅包含主要设计内容的文档,用于概述和定义项目中的重要设计方案。该说明书通常由项目团队中的设计师或架构师编写,旨在向项目参与者和利益相关者传达设计的整体思路和目标。以下是关于 bi 概要设计说明书的详细解释。 首先,在 bi 概要设计说明书中,需要明确定义项目的目标和需求。这包括了解项目的背景信息、受众群体和他们的需求,以及项目的具体目标和预期成果。这些信息对于确定设计方案和设计原则至关重要。 其次,需要详细描述 bi 系统的整体框架和架构。这包括确定系统的主要组件、模块和功能,以及它们之间的关系和相互作用。同时,还需要定义数据模型和数据流程,以确保系统能够有效地收集、处理和呈现数据。 接下来,需要介绍 bi 系统的技术架构和基础设施要求。这涉及选择和集成适当的硬件和软件,以支持系统的运行和性能需求。同时,还需要考虑系统的可扩展性和可维护性,以确保其能够满足未来的业务需求。 在设计方案部分,需要详细描述 bi 系统的各个功能模块的设计思路和实现方法。这包括报表和仪表板设计、数据可视化方式、数据挖掘和分析方法等。同时,还需要注重用户体验和界面设计,以确保系统的易用性和用户满意度。 最后,需要附上 bi 概要设计说明书的时间表和预算计划。这有助于跟踪项目进展和确保按时交付。 综上所述,bi 概要设计说明书是一个重要的设计文档,用于概述 bi 系统的设计方案和关键内容。它确保项目的参与者和利益相关者对系统设计有清晰的理解,为项目的实施提供了指导和规划。

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值