《概要设计说明书模版v》由会员分享，可在线阅读，更多相关《概要设计说明书模版v（14页珍藏版）》请在金锄头文库上搜索。
1、概要设计说明书（HLD） （版本V1.0）【项目名称】修订历史记录版本日期AMD修订者说明注：A-添加M-修改D-删除目 录1.文档介绍11.1.文档目的11.2.文档读者11.3.文档范围11.4.名词定义及缩略词11.5.文档引用及相关文档11.6.文档结构概要12.系统目标22.1.系统描述22.2.系统上下文22.3.系统接口22.4.非功能性需求23.系统架构33.1.系统概貌33.2.系统组件33.2.1.组件33.2.2.组件233.3.系统接口43.3.1.内部接口43.3.2.外部接口44.系统动态视图54.1.场景54.2.系统机制(可选)55.系统其它视图(可选)65.1
2、.系统进程视图(可选)65.2.系统开发视图(可选)65.3.系统物理视图(可选)65.4.其它用例场景65.5.限制条件65.6.出错处理65.7.其它66.系统概念框架77.系统非功能性设计87.1.系统易用性（人机界面设计）87.2.系统管理87.2.1.系统启动与关闭87.2.2.系统配置87.2.3.系统备份与恢复87.2.4.系统安全性管理87.2.5.数据库访问服务97.3.系统的性能97.4.系统的可靠性，容灾性98.结论综述10附件1：组件与需求对照表111. 文档介绍1.1. 文档目的本节阐述本文档的编写目的。为系统的设计设定方向性的目标，譬如系统将如何工作，它和哪些其它系
3、统或产品相关，它会用到哪些关键的业界标准和技术。1.2. 文档读者本节列出本文档的分类读者，具体包括系统设计师，具体设计实施组，系统测试组，其他需要了解系统体系结构，系统集成，系统拓展的技术人员。同时包括需要详细了解系统组成，架构等信息的其他人员，如系统文档，手册编写人员，系统培训人员等。1.3. 文档范围本节描述本文档的描述范围。它应阐述客户的短期和长期需求，系统层次体系架构，日后系统版本的发放。描述系统组件模块，相应的功能表现，以及之间的相互交互关系。描述基于本文档的系统体系架构，系统会和哪些其它系统集成，以及如何实现集成。如，本文档应包含但不仅限于以下内容：1. 总体商业对象模型；2.
4、概要的模块分解及和其它系统的集成；3. 概要的主要数据结构；4. 公共处理策略；5. 处理模型；6. 数据流模型及关键用例图处理。1.4. 名词定义及缩略词本节以列表形式给出在本文档中出现和使用的所有专用词汇，词汇缩写及其大略解释。1.5. 文档引用及相关文档本节提供一份在本文档中援引到的完整的文档资料清单，包括文档名称及版本号。1.6. 文档结构概要本节描述本文档的章节组成结构及每章的大概内容。2. 系统目标描述系统目标，黑盒描述系统功能及质量特性。2.1. 系统描述阐述系统主旨及其实现的功能和解决的问题。2.2. 系统上下文本节描述系统同actor、外部设备、以及其他需要集成的系统之间的关
5、系。2.3. 系统接口说明系统提供的服务。2.4. 非功能性需求阐明系统体系结构的宗旨，系统服务质量，外部限定条件等。3. 系统架构本节阐述系统的逻辑视图，包括其包含的组件（component)，各组件之间的关系，接口和每一个组件所提供的服务和操作。3.1. 系统概貌采用自顶向下的描述方法，阐述系统的概貌结构，组件组成，衔接关系，结构风格，其存在的限制条件和其它备数据选方案。3.2. 系统组件对系统中的每一个组件进行描述，包括组件的职能，提供的接口，组件间的互动和耦合，以及限制条件等。3.2.1. 组件描述组件模块功能设计，方法及技术实现。3.2.1.1. 输入对组件模块的输出数据进行说明。3
6、.2.1.2. 处理描述从输入到输出之间的所有处理过程。3.2.1.3. 输出对模块的输出数据进行说明。3.2.1.4. 用户界面如果模块包含与用户互操作的界面应说明界面设计内容。3.2.1.5. 出错处理描述对此组件模块的出错处理功能。3.2.2. 组件2描述组件模块功能设计，方法及技术实现。3.2.2.1. 输入对组件模块的输出数据进行说明。3.2.2.2. 处理描述从输入到输出之间的所有处理过程。3.2.2.3. 输出对模块的输出数据进行说明。3.2.2.4. 用户界面如果模块包含与用户互操作的界面应说明界面设计内容。3.2.2.5. 出错处理描述对此组件模块的出错处理功能。3.3. 系
7、统接口对系统中的每一个组件的每一个接口进行描述，包括其所提供的服务操作，操作顺序的限制条件，可选性的操作等。同时对系统外部接口的功能，操作，数据格式进行说明。3.3.1. 内部接口对系统内部组件间的接口包括操作和数据格式进行阐述。3.3.2. 外部接口对系统内部组件间的接口包括操作和数据格式进行阐述。4. 系统动态视图描述系统动态表现形式，如各组件的互动。4.1. 场景描述系统所有核心关键用例及各种可能的场景，将系统各组件作为对象，采用顺序图（Sequence Diagram）方式描述对于每一场景中系统各组件间的互动。可将用例及相应场景分组。1. 营业员输入查询条件2. 密码校验3. 查询界面
8、向清单处理器发出查询指令4. 清单处理器调用清单管理的服务查询清单5. 记录系统日志4.2. 系统机制(可选)描述前段中未予描述的，需要特殊机制处理的或关键的图例和信息。5. 系统其它视图(可选)5.1. 系统进程视图(可选)描述系统内进程的划分及相互关系，体现系统内各组件到进程的对应关系。5.2. 系统开发视图(可选)描述系统逻辑组件到系统编码组件（文件）或编码结构（文件组）的对应关系，系统开发工具的选型，配置和开发环境等。5.3. 系统物理视图(可选)描述系统硬件架构，体现系统组件，进程，编码文件和系统硬件节点的对应关系，系统硬件配置，网络及设备的布局等。5.4. 其它用例场景5.5. 限
9、制条件描述其它会影响或限制系统设计或实现的问题的描述, 包括:1. 硬件限制, 如：服务器数量大小等；2. 与其它系统的界面；3. 并行处理要求；4. 系统监控审计功能；5. 系统安全等。5.6. 出错处理描述系统对出错处理的综合考量及相应处理措施。5.7. 其它描述未在以上各章节中描述的用例场景。6. 系统概念框架描述系统商业业务概念模型，包括业务类型，功能模块及其相互间的关系。7. 系统非功能性设计阐述对系统主要非功能性方面的设计考虑。7.1. 系统易用性（人机界面设计）描述系统用户交互界面，包含：1. 整个系统每个模块的交互界面显示和显示层次；2. 有效和无效的用户行为；3. 确定什么内
10、容可以由用户自行配置；4. 确定什么内容可以由开发人员配置等。7.2. 系统管理7.2.1. 系统启动与关闭描述对系统启动和关闭的服务考虑。7.2.2. 系统配置描述对系统可配置性的考虑。7.2.3. 系统备份与恢复描述对系统备份及恢复的考虑。7.2.4. 系统安全性管理描述系统安全性管理办法和系统设计。7.2.4.1. 使用人员管理描述对系统使用人员的管理，如系统操作员分组，安全级别划分等。7.2.4.2. 公共审计日志服务（audit log）描述系统审计日志管理。7.2.4.3. 系统使用日志服务（user log）描述系统使用者日志管理。7.2.4.4. 出错日志及跟踪（trace）服
11、务描述系统出错日志及跟踪服务管理。例如： 操作日志集中处理 统一的操作日志格式 日志服务返回ID，应用利用此ID实现操作日志与操作流水的对应 系统日志由各子系统分别处理 统一的系统日志格式 操作流水由各子系统分别处理 操作流水的格式由各子系统根据需要自行定义7.2.5. 数据库访问服务描述系统对系统数据库访问的管理，如提供使用接口API或界面。可靠性（软件冗余和分布式处理方式）、可管理性（日志、与管理软件接口，如：SNMP）7.3. 系统的性能描述对系统性能要求的策略。7.4. 系统的可靠性，容灾性描述对系统可靠性要求的策略，尤其是对系统容灾的考虑。8. 结论综述阐述文档描述的系统体系结构设计的长处和局限，包括对系统非功能需求和待解决问题的考量，影响概要设 计的每一个假设条件和依赖条件分析等。附件1：组件与需求对照表本节提供包和SRS中需求的跟踪表，可用excle来记录。需求IDA包B包Z包1XX2XXX3XX
