《信息化项目设计阶段概要设计工作规范》

2T/NMPA003—2024信息化项目概要设计工作规范本文件规定了信息化项目概要设计工作的定位、过程，以及概要设计说明书的编写内容基本要求。本文件原则上适用于所有信息系统的概要设计工作，使用者可根据实际情况对本标准进行适当剪裁。2规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T5271.1信息技术词汇第一部分：基本术语GB/T11457软件工程术语GB/T8566软件生存周期过程3术语、定义和缩略语GB/T5271.1、GB/T11457界定的以及下列术语和定义适用于本文件。3.1工程化是一种系统化、模块化和规范化的过程，旨在通过标准化的方法和工具来提高效率、降低成本并保证质量。3.2需求体系表RequirementsTable需求体系表是一个详细记录和管理项目需求的系统化工具，旨在帮助项目团队明确、分配、跟踪和变更需求。3.3业务架构是企业治理结构、商业能力与价值流的正式蓝图，明确定义企业的治理结构、业务能力、业务流程和业务数据。4框架图信息化项目概要设计工作规范框架图如下所示：3T/NMPA003—20245软件工程中概要设计的定位在软件工程的框架中，主要包括需求工程阶段、设计工程阶段以及开发工程阶段。详细设计属于设计工程阶段的第二步，在概要设计之后。5.1需求工程阶段需求工程是构建信息系统的第一步工作，是对客户的现状和需求进行调研，并按照工程化的方法和标准完整、准确地记录和分析客户的需求，主要包括需求调研和需求分析。a)需求调研：收集、梳理客户的原始需求。b)需求分析：对需求实体的内容进行抽提、分类，建立需求体系表。5.2设计工程阶段设计工程是运用软件设计的理论、方法、工具，对需求工程获取的需求按照不同的理论和方法进行分阶段、分层地细化，给出满足客户需求和符合软件开发要求的设计资料。设计工程划分为概要设计、详细设计、应用设计。a)概要设计：从设计的角度出发对需求的定义和解释，经过一系列粗粒度的规划和设计，让后续的设计师大致了解系统的结构和操作模式。概要设计的内容包含：1)根据领导意图，确定系统的设计理念、业务主线等；2)根据需求分析成果、设计理念等确定系统的业务架构;3)根据需求分析和业务架构的成果，确定系统的业务功能规划；4)根据需求、架构和功能的规划成果，确定系统的业务数据规划。b)详细设计：描述业务设计的实现细节、方法、函数等。c)应用设计：将前面设计的内容转换为系统的表达方式。5.3开发工程阶段开发工程是基于设计工程阶段成功，采取技术手段，编码实现系统开发，提供用户使用的工程，包括技术设计、软件开发、软件测试、系统验收，根据采用的开发方式进行裁剪。a)技术设计：是以计算机技术为基础，用技术设计特有的方法来转换应用设计的成果。技术设计的成果可以直接作为后续软件开发的依据，同时技术设计部分还需要确定系统的开发语言、基础框架、部署环境、硬件以及测试等方面的设计要求。4T/NMPA003—2024b)软件开发：按照技术设计成果进行编码开发。c)软件测试：使用设计工程阶段的用力进行软件不同方面的测试，保障软件功能、性能符合用户要求。d)系统验收：依据与客户签订的合同、需求规格说明书等资料进行系统的验收。6概要设计过程概要设计的过程是使设计者能够通过设计模型，描述将要构造软件的所有侧面。主要包括以下几个方面：6.1制定规范为了适应团队式开发的需要，应该制定共同遵守的规范，以便协调与规范团队内各成员的工作。概要设计需要制定的规范或标准包括以下内容。a)需要采用的管理规则：包括操作流程、交流方式、工作纪律等。b)设计文档的编制标准：包括文档体系、文档格式、图表样式等。c)信息编码形式，硬件、操作系统的接口规约，命名规则等。d)设计目标、设计原则。6.2体系结构设计软件体系结构为软件系统提供了一个结构、行为和属性的高级抽象，由构成系统的元素的描述、这些元素的相互作用、指导元素集成的模式以及这些模式的约束组成。体系结构设计就是根据系统的需求框架，确定系统的基本结构，以获得有关系统创建的总体方案。体系结构设计的主要内容包括：a)设计规范的确定：设计规范中对系统构成影响比较大的是理念和主线，它们的作用分别包括：1)设计理念：针对未来要设计的系统，业务设计师要根据客户的目标需求（目的、价值、期望等）确定对系统的设计理念，这个理念可以指导和判断信息系统应该选用的业务处理的方式、管控的手法，以及系统最终可以为客户带来什么样的使用效果和价值等。2)设计主线：根据设计理念，寻找支持理念的核心价值点，将它们连接成线，并将实现这些价值点的功能沿着主线展开，形成了系统设计的主线。b)模型与标准的确定：架构模型主要是业务模型，需要输出业务架构图。业务架构图是后续设计的指导依据，因此采用的基本图表、表达方式等必须是统一的标准。业务模型的主要表达方式包括拓扑图、分层图、框架图、分解图、流程图等,如下所示：1)拓扑图：将多个软件系统用网络图连接起来的表达方式。示例如下：图2拓扑图示例2)分层图：将研究对象按照不同内容分成不同的逻辑层的方法。示例如下：5T/NMPA003—2024图3分层图示例3)框架图：规划功能的范围、分区、区域之间的关系。示例如下：图4框架图示例4)分解图：表达具有分解或汇总的关系。示例如下：6T/NMPA003—2024图5分解图示例5)流程图：表达为完成某个目标的活动之间的相互关系。示例如下：图6流程图示例6.3软件结构设计通常软件是由模块组成的。软件中的每个模块完成一个适当的功能，应该把模块组织成良好的层次系统，顶层模块调用它的下层模块以实现系统的完整功能，每个下层模块再调用更下层的模块，从而完成系统的一个子功能，最下层模块完成具体的功能。如果数据流图已经细化到了适当的层次，则可以直接从数据流图中映射出软件结构。软件结构设计主要内容包括：a)功能分类：需要将收集到的功能需求进行分类，找出它们的共性、特点，这为后续建立通用的业务功能设计模型奠定了基础。b)功能规划：通过规划用的关联图，可以交互印证功能需求是否是必要的、有无重复的、有无可以合并的同类功能，最终确定功能需求一览中的哪些功能需求留下、哪些不要，留下的就成为正式的业务功能。其中：1)功能需求：术语系统功能的设计，未确定是否术语必须实现的功能。2)业务功能：是已经确定为必须要实现的功能，且已经分类。c)业务功能一览：将完成了分类和规划的功能汇总成业务功能一览。业务功能的分类包括：a)活动功能：指用来记录、展示在生产过程中产生过程数据的功能，是实际操作工作在系统中的映射，同时管理规则业主要加载在活动功能上。7T/NMPA003—2024b)字典功能：指来维护需要标准化的组织基础数据，是对基础数据进行维护的功能，包含对数据的记录、展示、更新、发布等。c)看板功能：指用来展示经过加工处理后的数据，是应用于查看数据的功能，不进行数据输入维护，通常用仪表盘、导航、图形曲线等进行展示。d)表单功能：指用来报表的形式展示数据的功能，包含了各类统计和分析，以及各类凭证形式的单据。6.4公共数据结构设计在概要设计阶段还要确定那些将被许多模块共同使用的公共数据的构造。例如，公共变量、数据文件和数据库中的数据等。对公共数据的设计包括以下内容。a)公共数据变量的数据结构与作用范围。b)输入、输出文件的结构。c)数据库中的表结构、视图结构以及数据完整性等。对于数据规划，按照粒度主要分为整体、领域和模块。a)数据整体规划：根据业务范围规划基础数据、过程数据、管理数据、加工数据、其他数据的内b)业务领域规划：根据具体业务领域，划分不同的业务主体数据、过程数据，从而形成子系统的数据规划。c)业务模块规划：根据具体的业务模块，按照业务操作的流程，分段进行不同业务主体的数据规划设计。6.5安全性设计系统安全性设计包括操作权限管理设计、操作日志管理设计、文件与数据加密设计、特定功能的操作校验设计等。概要设计需要对这些方面的问题做出专门的说明，并制定出相应的处理规则。为在概要设计阶段，通过设计来有效减少安全漏洞和风险，保护系统免受各种威胁和攻击，确保关键数据的安全和系统稳定运行，应对以下安全方面进行设计考虑：a)认证与授权机制：是软件系统安全性设计中的核心组成部分，旨在确保只有经过身份验证和权限核实的用户才能访问系统资源。包括：1)用户认证：采用强化的密码策略，结合多因素认证技术，如短信验证码、生物识别等，以验证用户身份的真实性。2)权限授权：基于角色的访问控制模型，为不同的用户角色分配相应的权限，实现对系统资源和功能的细粒度访问控制。b)数据保护措施：是确保数据的机密性、完整性和可用性的一系列策略和工具，根据系统安全性要求不同，进行不同程度设计。包括：1)数据加密：对敏感数据在存储和传输过程中进行加密处理，使用业界认可的加密算法和协议，如AES、SSL/TLS等。2)数据完整性校验：通过数字签名和哈希算法来确保数据的完整性，防止数据在传输或存储过程中被篡改。c)安全审计与日志管理：是记录、审查和监控关键系统活动，以侦测、警报和应对潜在安全事件或违规行为的过程。包括：1)审计跟踪：记录所有关键操作的日志，包括登录尝试、系统异常、数据访问和修改等，以便事后分析和追踪。2)日志安全管理：实施严格的日志管理策略，包括日志的定期备份、加密和安全传输，以防日志被篡改或删除。d)代码安全与日志管理：是确保软件稳定、可靠运行的关键，通过规范开发流程和实时监控，保障了代码质量和系统安全。包括：1)安全编码规范：制定和执行安全编码标准，避免常见的安全漏洞，如SQL注入、跨站脚本攻击等。2)漏洞扫描与修复：定期进行自动化的漏洞扫描，及时发现潜在的安全威胁，并通过快速补丁更新流程来修复确认的漏洞。8T/NMPA003—2024e)网络安全防护：通过多层防御措施，保护网络免受未经授权的访问和各种网络攻击。包括：1)防火墙与入侵检测：部署网络防火墙和入侵检测系统，监控和控制进出网络流量，防止未授权的访问和探测。2)隔离与分区：通过网络分段和虚拟专用网络技术，实现系统组件的隔离，减少攻击面，限制潜在攻击者在网络内的横向移动。f)业务连续性与灾难恢复：是确保在面对意外中断或灾害时，能够快速恢复和持续提供关键业务功能的策略和过程。包括：1)备份策略：制定定期备份计划，包括全量和增量备份，确保关键数据能够在紧急情况下恢复。2)灾难恢复规划：建立灾难恢复中心，制定详细的恢复流程和预案，以应对自然灾害、人为破坏等导致的系统中断事件。g)安全培训与意识提升：是通过教育组织内部的员工，提高他们对网络安全威胁的认识，并教授他们如何采取预防措施来减少安全漏洞和防止数据泄露。包括：1)安全培训：根据系统要求定期为用户提供安全意识和最佳实践的培训，包括密码管理、系统操作规范等。2)安全政策宣传：根据系统要求，通过内部沟通渠道宣传安全政策，提高用户对安全重要性的认识，鼓励报告潜在的安全问题。6.6故障处理设计在概要设计时，需要对各种可能出现的，来自于软件、硬件以及网络通信方面的故障做出专门考虑。例如，提供备用设备、设置出错处理模块、设置数据备份模块等。以下是一些常见的故障问题应对措施：a)冗余机制：为关键系统引入备用设备或冗余系统，确保一旦主要组件发生故障，系统能够自动切换到备用设备上继续运行，最大程度减少停机时间。b)出错处理模块：在软件架构中集成专门的出错处理模块，用于监测、记录和响应各种错误状态。这个模块负责分析错误原因，实施预设的恢复流程，或者将错误信息及时反馈给维护人员以进行人工干预。c)数据备份与恢复：实现一个数据备份模块，负责定期备份关键数据，并验证备份数据的完整性和可恢复性。在数据丢失或损坏的情况下，该模块能够迅速地将数据恢复到最近一次的有效状态。d)网络通信容错：针对网络通信可能出现的故障，设计容错机制，比如使用冗余的网络连接、建立故障转移策略，以及在网络不稳定时，提供本地缓存或离线工作模式，确保数据传输的可靠性。e)负载均衡和过载保护：在高流量或高负载情况下，通过负载均衡技术分散请求压力，同时设置阈值进行过载保护，防止系统因超负荷运转而导致的性能下降或服务中断。f)监控与预警：部署监控系统来实时监视软件、硬件资源及网络状态，配合预警机制，当发现异常行为或性能指标超出正常范围时，能够及时通知维护团队。g)灾难恢复计划：制定全面的灾难恢复计划，涵盖从数据备份到硬件、软件的恢复流程，确保在发生重大灾难时，能够以最快的速度恢复系统的正常运行。h)测试与验证：通过严格的测试，包括单元测试、集成测试和压力测试等，来验证故障应对措施的有效性，并确保它们在必要时能够正确执行。6.7编写文档在软件工程中，文档记录了从需求分析到产品设计再到产品实现及测试的过程，甚至到产品交付及交付后的使用情况等各个阶段的相关信息。本阶段应该用正式文档记录概要设计的结果。合格的概要设计文档应该满足以下特性：a)及时性：在一个阶段的工作完成后，此阶段的相关文档应该及时地完成，而且开发人员应该根据工作的变更及时更改文档，保证文档是最新的。可以说，文档的组织和编写是不断细化、不断修改、不断完善的过程。9T/NMPA003—2024b)完整性：应该按有关标准或规范，将软件各个阶段的工作成果写入有关文档，极力防止丢失一些重要的技术细节而造成源代码与文档不一致的情况出现，从而影响文档的使用价值。c)实用性：文档的描述应该采用文字、图形等多种方式，语言应准确、简洁、清晰、易懂。d)规范性：文档编写人员应该按有关规定采用统一的书写格式，包括各类图形、符号等的约定。此外，文档还应该具有连续性、一致性和可追溯性。e)结构化：文档应该具有非常清晰的结构，内容上脉络要清楚，形式上要遵守标准，让人易读、易理解。f)简洁性：切忌无意义地扩充文档，以内容为核心。充实的文档在于用简练的语言，深刻而全面地对问题展开论述，而不在于文档的字数多少。6.8概要设计评审最后需要对概要设计的结果进行严格的技术审查，在技术审查通过之后再由使用部门的负责人从使用、管理的角度进行评审。概要设计评审内容主要包括以下几项。a)需求确认：确认所设计的软件是否覆盖了所有已确定的软件需求。b)接口确认：确认该软件的内部接口与外部接口是否已经明确定义。c)模块确认：确认所设计的模块是否满足高内聚性、低耦合度的要求，模块的作用范围是否在其控制范围之内。d)风险性：该设计在现有技术条件下和预算范围内是否能按时实现。e)实用性：该设计对于需求的解决是否实用。f)可维护性：该设计是否考虑了今后的可维护性。g)质量：该设计是否表现出了良好的质量特征。7概要设计说明书内容概要设计说明书是概要设计阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。概要设计说明书的编写内容应包括：7.1引言引言内容应包括但不限于：a)编写目的：说明编写这份概要设计说明书的目的，指出预期的读者。b)背景：说明待开发软件系统名称；列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站（中心）。c)定义：列出概要设计说明书中用到的专门术语的定义和外文首字母组词的原词组。d)参考资料：列出有关的参考文件，如：1)本项目的经核准的计划任务书或合同，上级机关的批文；2)属于本项目的其他已发表文件;3)本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。7.2总体设计总体设计内容应包括但不限于：a)需求规定：说明对本系统的主要的输入输出项目、处理的功能性能要求。b)运行环境：简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定。c)基本设计概念和处理流程：说明本系统的基本设计概念和处理流程，尽量使用图表的形式。d)结构：用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系。e)功能需求与程序的关系：采用表格形式说明各项功能需求的实现同各块程序的分配关系。f)人工处理过程：说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。T/NMPA003—2024g)尚未解决的问题：说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。7.3接口设计接口设计内容应包括但不限于：a)用户接口：说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。b)外部接口：说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。c)内部接口：说明本系统之内的各个系统元素之间的接口的安排。7.4运行设计运行设计内容应包括但不限于：a)运行模块组合：说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。b)运行控制：说明每一种外界的运行控制的方式方法和操作步骤。c)运行时间：说明每种运行模块组合将占用各种资源的时间。7.5系统数据结构设计系统数据结构设计内容应包括但不限于：a)逻辑结构设计要点：给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系统标识、定义、长度及它们之间的层次的或表格的相互关系。b)物理结构设计要点：给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。c)数据结构与程序的关系：说明各个数据结构与访问这些数据结构的形式。7.6系统出错处理设计系统出错处理设计内容应包括但不限于：a)出错信息：用一览表的方式说朗每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。b)补救措施：说明故障出现后可能采取的变通措施，包括：1)后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术；2)降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录；3)恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。c)系统维护设计：说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。各个程序之间的对应关系，可采用如下的矩阵图的形式。T/NMPA003—2024（资料性附录）概要设计说明书【模板】概要设计说明书1引言1.1编写目的说明编写这份概要设计说明书的目的，指出预期的读者。说明：a.待开发软件系统的名称；b.列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站（中心）。列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1.4参考资料列出有关的参考文件，如：a.本项目的经核准的计划任务书或合同，上级机关的批文；b.属于本项目的其他已发表文件；c.本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。2总体设计2.1需求规定说明对本系统的主要的输入输出项目、处理的功能性能要求，详细的说明可参见附录C。2.2运行环境简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定，详细说明参见附录C。2.3基本设计概念和处理流程说明本系统的基本设计概念和处理流程，尽量使用图表的形式。用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系.2.5功能器求与程序的关系本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系：程序1程序2程序n功能需求1√功能需求2√功能需求n√√2.6人工处理过程说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。2.7尚未问决的问题T/NMPA003—2024说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。3接口设计3.1用户接口说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。3.2外部接口说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。3.3内部接口说明本系统之内的各个系统元素之间的接口的安排。4运行设计4.1运行模块组合说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。4.2运行控制说明每一种外界的运行控制的方式方法和操作步骤。4.3运行时间说明每种运行模块组合将占用各种资源的时间。5系统数据结构设计5.1逻辑结构设计要点给出本系统内所使用的每个数据结构的名称、标识符以及它们