2022年概要设计说明书_模板.docx

《2022年概要设计说明书_模板.docx》由会员分享，可在线阅读，更多相关《2022年概要设计说明书_模板.docx（23页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。

1、精选学习资料 - - - - - - - - - XXX项目概要设计说明书创智和宇信息技术股份有限公司名师归纳总结 拟制：PowerSI Information Technology Co. Ltd .第 1 页,共 12 页文档编号：审核：文档版本号：批准：生效日期：秘密等级：- - - - - - -精选学习资料 - - - - - - - - - 修改记录名师归纳总结 修订号作者日期简要说明第 2 页,共 12 页- - - - - - -精选学习资料 - - - - - - - - - 此页由 EPG 编写,项目实施人员不用更换任何地方模板编写及修订记录拟制：伏亮模板编号： CZHY_

2、TEMP_ 安装部署说明书审核：杜柏文批准：伍千虎 版本号： V2.0 生效日期： 2022 年 12 月 1 日 秘密等级： 内部公开修订号 作者 日期 简要说明V0.1 伏亮 2022 年 4 月 15 日 新制作V0.2 伏亮 2022 年 5 月 8 日 评审版V1.0 伏亮 2022 年 6 月 1 日 正式发布V1.1 伏亮 2022 年 11 月 29 日 修改文档格式V2.0 伏亮 2022 年 12 月 1 日 正式发布此页由 EPG 编写,项目实施人员不用更换任何地方名师归纳总结 - - - - - - -第 3 页,共 12 页精选学习资料 - - - - - - - -

3、 - 目 录XXX项目 _概要设计书 . 1 名师归纳总结 1 引言 . 1 第 4 页,共 12 页2 1.1 编写目的 . 1 1.2 参考文献 . 1 1.3 术语与缩写说明. 1 总体设计 . 1 3 2.1 系统概述 . 1 2.2 系统设计原就 . 1 2.3 设计中应用的关键技术. 1 2.4 系统结构图 . 2 2.5 网络结构图 . 2 2.6 系统功能模块图. 2 2.7 数据流向图（或称为时序图）. 2 2.8 模块构成 . 2 环境设计 . 2 4 硬件设备 . 2 5 支持软件 . 3 6 接口设计 . 错误！未定义书签；7 6.1 用户接口 . 3 6.2 外部接口

4、 . 5 6.3 内部接口 . 5 数据库设计 . 6 8 7.1 数据库环境说明. 6 7.2 数据库命名规章. 6 7.3 规律设计 . 6 7.4 物理设计 . 6 7.5 安全性设计 . 7 公用结构 . 错误！未定义书签；9 界面设计 . 8 10 出错处理设计 . 8 11 开发工具 . 错误！未定义书签；12 附录 . 8 - - - - - - -精选学习资料 - - - - - - - - - 1 引言1.1 编写目的说明编写这份概要设计说明书的目的 ,指出预期的读者 例如：本设计说明书简洁阐明白 XXX 系统的 XXX 模块的基本设计思想、基本功能、模 块划分以及模块间接口

5、； 以便于各模块开发人员能更好地明白该系统的基本情形及各模块具体功能；1.2 参考文献提示：列出本文档的全部参考文献（可以是非正式出版物）,格式如下： 标识符 作者,文献名称,出版单位（或归属单位）,日期 例如：AAA 作者,立项调查报告,机构名称,日期 BBB 作者,立项可行性分析报告 ,机构名称,日期 SPP-PROC-PIM EPG ,立项治理规范,机构名称,日期 1.3 术语与缩写说明 缩写、术语 解 释 SPP 精简并行过程, Simplified Parallel Process PIM 立项治理, Project Initialization Management 2 总体设计2

6、.1 系统概述 说明对本系统或模块的设计思想：模块划分原就、网络设计原就、开发模型等； 2.2 系统设计原就 说明本文件设计应遵循的原就等； 2.3 设计中应用的关键技术说明本文件设计应用的关键技术, 如多类型空间数据集成技术、 海量图库治理技术、国土资源信息治理的多级服务器组建技术、国土资源信息 动技术、时域 GIS 治理技术WEB 发布技术、工作流驱名师归纳总结 - - - - - - -第 5 页,共 12 页精选学习资料 - - - - - - - - - 2.4 系统结构图说明系统的内部结构,子系统/模块间的联系等,必需以图示和文字说明相结合2.5 网络结构图说明本系统在整体网络中的

7、位置,及其和外界网络的关系,必需以图示和文字说明 相结合 2.6 系统功能模块图说明本系统的功能模块组成,及其各模块间的数据接口,各模块之间的掌握与被控 制关系,必需以图示和文字说明相结合 2.7 数据流向图（或称为时序图）说明系统和外界的数据交互流程,并注明数据类型 或是模块和其它模块的数据交互流程,并注明模块间交互的数据类型 【可参考需求开发指南5.2】2.8 模块构成 系统划分模块：对系统 或模块 中每一个功能,用图示或文字具体描述：概述 - 表达功能名称、目标和作用；输入 - 表达该功能输入的消息；处理 - 描述该功能做什么,如何对输入信息进行加工并转换成输出信息；输出 - 详述该功能

8、输出的信息；自主开发、复用、外包、选购方案 复用、外包、选购的选项；-详述该模块的设计方案,包括自主开发、模块名称概述输入输出处理自主开发、复用、外包、选购方案3 环境设计简要地说明对本系统的运行环境的规定 4 硬件设备名师归纳总结 列出运行该软件所需要的硬设备.说明其中的新型设备及其特地功能.第 6 页,共 12 页- - - - - - -精选学习资料 - - - - - - - - - 5 支持软件列出支持软件 ,包括要用到的操作系统、 编程语言、编译 或汇编程序、测试支持软件等及各软件的版本； 6 接口设计接口设计原就取得一样性类似的情形应当有让使用者有一样性的操作；采纳同样的名词；并

9、且保持命令的一贯性；让重度使用者使用快捷方式在提示、 选单与说明文件中, 应当当使用频率增加时, 使用者会期望削减互动的次数、 让每次的互动能够一次做更 多的动作；缩写、功能键、隐匿功能与综观全局的功能,对专家来说特别有用；供应有意义的回馈 当使用者做出一些动作时, 系统应当供应回馈； 越频繁的动作, 其回馈的强度可 以低一些；越重要或不平常的动作,其回馈强度应当要显著一些；设计对话产生终止 一连串的动作应当被组织成开头、中间、终止三部份；当动作终止的时候,要提供回馈让使用者知道动作已经完成；在做下个一连串的动作之前, 先告知使用者整个流程,能够减轻使用者的压力、提高中意度；供应简洁的错误处理

10、最好不要让系统有严峻错误的可能性；假如仍是造成错误, 系统应当能够侦测出来,并供应一个简洁、使用者可以懂得的错误处理方式；答应回到上一步这个功能可以减低使用者的焦虑,由于使用者只到做错了可以重来；这个功能鼓励使用者探究不熟识的选项； 回到上一步的功能, 可以包含一个、 或是一连串的动作；满意使用者掌握的需求 有体会的使用者剧烈的感觉到他们在掌握系统,做出动作之后,系统供应回馈；系统设计上要让使用者作为动作的处发者,而不是响应者；名师归纳总结 - - - - - - -第 7 页,共 12 页精选学习资料 - - - - - - - - - 削减短期记忆需求人类的短期记忆有限,因此显示上要保持简

11、洁、能同时显示多页数据以削减窗口切换频率,削减记忆指令和动作次序的时间；设计方法 接口是供应应其他模块或者系统使用的一种商定或者规范；因此接口必需要保证 足够的稳固性和易用性；这是设计接口的基本要求；1.稳固性 接口必需相对稳固, 否就将导致接口的使用者和供应者为了适应新接口而不断修 改接口的实现, 可能重复进行无用功, 严峻时影响整个软件开发进度；那么如何 保证设计的接口相对稳固呢？第一,接口的语义必需明确； 包括接口调用方法、 接口名称、 参数的类型和名称；抽象的接口名称或者参数名称使人困惑或者懂得错误；如下例：History:SetAttribute 设置历史记录的属性,初看不知道该接口

12、要做什么；除非 History 的属性许多否 就没有必要设计这样的接口；ioctl C 库中的 ioctl,其实很难用缘由是需要设置项太多,每个项的参数又不太一样,接口使用者的压力就较大了；但是接口设计者也是不得已而为之,由于 IO 的设 置接口的应用情形较多, 假如每个设置接口都单独供应一个接口就会导致特别多 的接口,另外就是保证接口的相对稳固, 采纳抽象的数据的接口便于移植和稳固；因此,明确的接口语义例外情形就是对于帮助功能,假如需要较多接口, 就可以合成一个接口, 采纳不同参数区分 （如 windows 中的窗口处理过程类型的定义也 是这种情形）；其次,采纳版本定义来区分接口的差异；着供

13、应接口版本的查询功能；2.易用性比如供应接口版本查询功能, 接口实现接口是供应应第三方使用的, 较难用的接口会导致接口使用者的埋怨；如：SetCookievoid* handle, const CookieParam& param; GetCookievoid* handle, CookieParam& param; 此 接 口 名 称 的 意 义 仍 是 比 较 明 确 的 , 但 是 参 数 CookieParam 过于抽象,将导致接口的调用者在使用接口时,需要将基本数据类 型的值组成一个 CookieParam 类型,然后才能调用接口； 这是一种糟糕的接口设计；既不便于使用又不便于编译器

14、优化（待确认）假如该为下面的接口就较容易 使 用 SetCookievoid* handle, const URL& url, const String& cookie; GetCookievoid* handle, const URL& url, String cookie; 除非接口的参数个数超过5 个,否就最好采纳基本数据类型作为参数；超过 5 个参数的函数一方面给调用者带来困难, 参数排列组合的情形过多, 另一方面就是不利于编译器优化时采纳寄存器传递参数；6.1 用户接口名师归纳总结 说明将向用户供应的命令和它们的语法结构,以及相应的回答信息； 第 8 页,共 12 页- - - -

15、- - -精选学习资料 - - - - - - - - - 说明供应应用户操作的用户界面采纳的形式,如屏幕格式、报表格式、菜单格式等6.2 外部接口说明本系统同外界的全部接口的支配包括软件与硬件之间的接口、本系统与各支持 系统之间的接口关系； ,配置文件；6.3 内部接口说明本系统之内的各个系统元素之间的接口的支配；7 制作购买重用分析软件复用有三个基本原就：（1）必需有可以复用的对象；（2）所设计的可复用对象必需是有用的；（3）复用者需要知道如何使用被复用的对象； ,配置文件等；软件复用包括两个相关过程：即可复用软件 （构件） 或软件的可复用部分的开发Development for Reus

16、e和基于可复用软件（构件）或软件可复用的部分的应用系统构造（集成和组装） （Development with Reuse ）；采纳软件复用技术主要有以下优点：（1）提高软件生产率、削减开发时间；（2）提高软件质量,开发出来的软件牢靠性高；（3）降低开发风险；（4）简化软件开发流程,使得软件开发易于治理；（5）降低保护难度、工作量和费用,提高了软件系统效益；（6）便于学习系统结构和建立好的系统,促进软件开发过程的标准化；（7）易于供应文档资料等；软件外购的原就（1）外购费用小于开发人力成本；名师归纳总结 - - - - - - -第 9 页,共 12 页精选学习资料 - - - - - - -

17、- - （2）外购软件能大量缩短工期；（3）外购软件集成成本小于项目成本的 1%；（4）外购软件技术是本公司急迫需要的；7.1 外购模块的设计简要地说明本系统的需要外购的模块及外购缘由,存在的问题和留意事项 7.2 复用模块的设计简要地说明本系统的需要复用的模块及复用的缘由,存在的问题和留意事项 8 数据库设计客户化开发类、 保护类项目可将数据库设计独立一份文档,8.1 数据库环境说明 说明所采纳的数据库系统,设计工具,编程工具等； 8.2 数据库命名规章 提示：（1） 完整并且清晰的说明本数据库的命名规章；数据库表的命名规章 列的命名规章 储备过程的命名规章 触发器的命名规章见数据库设计说明

18、书 （2）假如本数据库的命名规章与机构的标准不完全一样的话,请作出说明； 8.3 规律设计 数据库设计人员依据需求文档, 创建与数据库相关的那部分实体关系图 假如采纳面对对象方法（ OOAD）,这里实体相当于类（ class）； （ERD）；8.4 物理设计 主要是设计表结构；一般地,实体对应于表,实体的属性对应于表的列,实体名师归纳总结 - - - - - - -第 10 页,共 12 页精选学习资料 - - - - - - - - - 之间的关系成为表的约束； 规律设计中的实体大部分可以转换成物理设计中的表,但是它们并不肯定是一一对应的；对表结构进行规范化处理（第三范式） ； 8.4.1

19、表汇总Sys_dict表名功能说明数据字典表 8.4.2 Sys_dict（数据字典表）表名： Sys_dict 用户模式：分区：无 索引： group_id+dict_id（key ）实体存放：用途说明：维护：数据类型NN NULL 中文说明字段名group_id Number8 组编码Group_name Varchar280 NN 组名称dict_id Number8 NN 字典编码Varchar280 NN 字典名称dict_name Dict_value Varchar2255 NN 字典值Number3 N 字典次序Dict_index remark Varchar2255 N 备

20、注8.5 安全性设计8.5.1 防止用户直接操作数据库的方法 提示：用户只能用帐号登陆到应用软件,通过应用软件拜访数据库,而没有其它途 径操作数据库； 8.5.2 用户帐号密码的加密方法 提示：对用户帐号的密码进行加密处理,确保在任何地方都不会显现密码的明文； 8.5.3 角色与权限名师归纳总结 提示：确定每个角色对数据库表的操作权限,如创建、检索、更新、删除等；每个就每第 11 页,共 12 页角色拥有刚好能够完成任务的权限,不多也不少； 在应用时再为用户安排角色,个用户的权限等于他所兼角色的权限之和； - - - - - - -精选学习资料 - - - - - - - - - 角色可以拜访的表与列操作权限角色 A 角色 B 9 界面设计本文档是对应遵循的界面设计的基本原就进行描述；10 出错处理设计本文档是对应遵循的出错处理的基本原就进行描述；11 附录把其他与设计相关的文档放在这里,可以直接写在文档中, 也可以放到其他文档中,名师归纳总结 在这里进行索引；比如利用其他工具所做的各种模型文件等；第 12 页,共 12 页- - - - - - -