软件概要设计文档规格.doc

“软件概要设计文档”的编写提示概要设计说明书格式规范是指在概要设计阶段，制定概要设计报告所依据的标准，若在承接产品时，用户提供了概要设计说明书，则按此标准检查概要设计报告是否在内容上满足要求，若未提交概要设计说明书则需按此标准建立概要设计说明书。这里提供一个标准以供参考。目 录1 引言111编写目的112范围113术语定义214参考资料214引用标准215 版本更新信息22 概述23 系统分析34 系统体系结构35 界面设计定义36 接口定义37 模块设计471模块功能472模块对象（组件）473对象（组件）的触发机制574对象（组件）的关键算法58 故障检测和处理机制581故障检测触发机制582故障处理机制59 数据库设计591数据库管理系统选型592设计E-R图593数据库表设计610 系统开发平台61 引言11编写目的 说明编写这份软件需求说明书的目的，指出预期的读者。12范围 说明文档的覆盖范围。13术语定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。（若无则填写无）14参考资料 列出用得着的参考资料（若无则填写无），如： a本项目的经核准的计划任务书或合同、上级机关的批文； b属于本项目的其他已发表的文件；c本文件中各处引用的文件、资料、包括所要用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。14引用标准列出文档制定所依据、引用的标准（若无则填写无）。 15 版本更新信息本文档的更新记录如表A-1。表A-1 版本更新记录修改编号修改日期修改后版本修改位置修改内容概述2 概述 本节对系统定义和规格进行分析，并以此确定：n 设计采用的标准和方法；n 系统结构的考虑；n 错误处理机制的考虑。3 系统分析根据需求规格或产品规格对系统实现的功能进行分析归纳，以便进行概要设计。 4 系统体系结构根据已选用的软件、硬件以及网络环境构造系统的整体框架，划分系统模块，并对系统内各个模块之间的关系进行定义。确定已定义的对象及其组件在系统内如何传输、通信。如果本系统是用户最终投入使用系统得以个子系统或是将要使用现有的一些其他相关系统，在此应对他们各自的功能和相互之间的关系给予具体的描述。 可通过图形的方式表示系统结构5 界面设计定义设计用户的所有界面。用户界面设计原则：l 命令排序：（1）最常用的放在前面；（2）按习惯工作步骤排序；l 极小化：尽量少用键盘组合命令，减少用户击键次数；l 广度和深度：由于人的记忆局限，层次不宜大于3；l 一致性：使用一致的术语、一致的步骤、一致的动作行为；l 显示提示信息；l 减少用户记忆内容；l 存在删除操作时，应能恢复操作；l 用户界面吸引人。6 接口定义通常设计应包括的接口包括：人机交互接口人机交互接口应确定用户采用何种方式同系统交互，如键盘录入、鼠标操作、文件输入等以及具体的数据格式，其中包括具体的用户界面的设计形式。尽早确定人机交互接口，有利于确定概要设计的其他方面。网络接口若本系统跨异种网络运行则应确定网络接口或采用何种网络软件，以使系统各部分间能有效地联络、通信、交换信息等，从而使整个系统紧密有效地结合在一起。系统与外部接口系统经常会与外部进行数据交换，此时应确定数据交换的时机、方式（如是批处理方式还是实时处理），数据交换的格式（如是采用数据包还是其他方式）等。系统内模块之间的接口系统内部各模块之间也会进行数据交换，因此应确定数据交换的时机、方式等。数据库接口系统内部的各种数据通常会以数据库的方式保存，因此在接口定义时应确定与数据库进行数据交换的数据格式、时机、方式等。7 模块设计根据项目的实际需求情况，可将系统划分成若干模块，分别描述各模块的功能。这样可将复杂的系统简化、细化，有利于今后的设计和实现。划分各模块时，应尽量使其具有封闭性和独立性，具有低耦合性，减少各模块之间的关联，使其便于实现、调试、安装和维护。71模块功能描述该模块在整个系统中所处的位置和所起的作用以及和其他模块的相互关系，该模块要实现的功能，对外部输入数据和外部触发机制的具体要求和约定。如果采用面向对象（OO）技术，可结合用例（Use Case）技术进行描述。72模块对象（组件）对模块涉及的输入/输出，用户界面，对象或组件，对象或组件的关系以及功能实现流程进行定义。如果采用面向对象（OO）技术，可使用顺序图（Sequence）描述功能实现流程。对象设计应包括：类名（Class Name）,类描述（Class Describe），继承关系（Hierarchy），公共属性（Public Attribute），公共操作（Public Operation），私有属性（Private Attribute），保护属性（Protect Attribute），保护操作（Protect Operation）。组件设计应包括：组件属性，组件操作，组件关联，实现约束。73对象（组件）的触发机制规定对象（组件）中各个操作在什么外部条件触发下被调用以及调用后的结果。74对象（组件）的关键算法如果对象（组件）中涉及关键算法，如采用何种算法加密、何种方法搜索等，需在此规定并予以相应的说明。至于其他具体操作的算法可在系统构造中去设计实现。8 故障检测和处理机制81故障检测触发机制系统发生故障可以有多种检测机制，如自动向上层汇报、有上层定时检测、将故障写入错误文件等。在此明确系统所采用的故障检测机制。82故障处理机制它描述故障发生后系统如何处理，如只发个消息显示出错信息、写一个文件、或采取相应的措施，在这里应进行详尽的描述。9 数据库设计91数据库管理系统选型明确指出选用的数据库管理系统类型、版本，服务器与