信息化项目设计阶段详细设计工作规范

2T/NMPA004—2024信息化项目详细设计工作规范本文件规定了信息化项目详细设计工作的定位、过程，以及详细设计说明书的编写内容基本要求。本文件原则上适用于所有信息系统的详细设计工作，使用者可根据实际情况对本标准进行适当剪裁。2规范性引用文件下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。GB/T5271.1信息技术词汇第一部分：基本术语GB/T11457软件工程术语GB/T8566软件生存周期过程GB/T8567计算机软件文档编制规范3术语、定义和缩略语GB/T5271.1、GB/T11457界定的以及下列术语和定义适用于本文件。3.1工程化是一种系统化、模块化和规范化的过程，旨在通过标准化的方法和工具来提高效率、降低成本并保证质量。3.2业务板块指的是一个企业或组织内部的不同业务领域或产品线，这些板块可能涉及不同的市场、产品或服务。3.3业务架构是企业治理结构、商业能力与价值流的正式蓝图，明确定义企业的治理结构、业务能力、业务流程和业务数据。4框架图信息化项目详细设计工作规范框架图如图1所示：3T/NMPA004—20245软件工程中详细设计的定位在软件工程的框架中，主要包括需求工程阶段、设计工程阶段以及开发工程阶段。详细设计属于设计工程阶段的第二步，在概要设计之后。5.1需求工程阶段需求工程是构建信息系统的第一步工作，是对客户的现状和需求进行调研，并按照工程化的方法和标准完整、准确地记录和分析客户的需求，主要包括需求调研和需求分析。a)需求调研：收集、梳理客户的原始需求。b)需求分析：对需求实体的内容进行抽提、分类，建立需求体系表。5.2设计工程阶段设计工程是运用软件设计的理论、方法、工具，对需求工程获取的需求按照不同的理论和方法进行分阶段、分层地细化，给出满足客户需求和符合软件开发要求的设计资料。设计工程划分为概要设计、详细设计、应用设计。a)概要设计：从设计的角度出发对需求的定义和解释，经过一系列粗粒度的规划和设计，让后续的设计师大致了解系统的结构和操作模式。b)详细设计：描述业务设计的实现细节、方法、函数等。c)应用设计：将前面设计的内容转换为系统的表达方式。5.3开发工程阶段开发工程是基于设计工程阶段成功，采取技术手段，编码实现系统开发，提供用户使用的工程，包括技术设计、软件开发、软件测试、系统验收，根据采用的开发方式进行裁剪。a)技术设计：是以计算机技术为基础，用技术设计特有的方法来转换应用设计的成果。技术设计的成果可以直接作为后续软件开发的依据，同时技术设计部分还需要确定系统的开发语言、基础框架、部署环境、硬件以及测试等方面的设计要求。b)软件开发：按照技术设计成果进行编码开发。c)软件测试：使用设计工程阶段的用力进行软件不同方面的测试，保障软件功能、性能符合用户要求。4T/NMPA004—2024d)系统验收：依据与客户签订的合同、需求规格说明书等资料进行系统的验收。6详细设计过程详细设计是软件设计的第二阶段，是在概要设计阶段的成果上开展工作。详细设计的成果应该是得出对目标系统的精确描述，从而在编码阶段可以把这些描述直接翻译成某种程序设计语言书写的源程序。详细设计主要包括以下几个方面：6.1详细设计前期准备进行详细设计之前需要进行前期准备工作，包括：a)明确详细设计的目的和内容。b)作业方法的培训：包括流程的设计方法、功能界面的设计规则、数据的表达方式等。c)作业模板的准备：准备架构层、功能层和数据层进行详细设计的模板。d)作业路线的规划：强调作业路线的注意事项，例如：1)明确业务逻辑和数据逻辑之间的主从关系，作业要按照架构、功能、数据的顺序进2)功能（界面）设计必须要在业务流程图的框架下进行，要注意上下游的业务逻辑关系;3)功能（界面）设计时，要注意与上游功能之间的数据逻辑关系。6.2架构层详细设计架构层的详细设计，是对架构的概要设计成果进行进一步的细化，给出包括流程分歧、流转、规则在内的设计规格书。a)流程设计内容：在架构层面对业务流程进行设计，包括流程的起止点、分歧判断等。b)流程设计原则：考虑到业务流程的维护、升级问题，设计在信息系统中运行的业务流程时，要将业务流程进行合理的拆分、在不影响业务逻辑的正确性且处理效率不下降的同时，尽量将流程设计得短一些，遵循“化繁为简，用简单方法的组合完成复杂的业务处理”的原则。流程设计时要注意：1)将每条流程的业务目标设置得单一、清楚，长度设置得比较简单、短小；2)将短小的流程通过“组合、协同”的方式，形成可以处理复杂业务的组合流程。c)流程管理的设计：对流程的管理设计主要是将作用在各节点上的管理规则整合在一起，从整体上设计管理的预期效果。流程管理方式包括：1)标准流程的管控：让用户按照业务流程进行工作处理，通过业务处理过程的标准化、结构化来实现管理目的。2)数据对比的管控：利用节点内具体的数据来进行管控设计，当业务数据不符合标准时激活管理规则。3)审批流程的管控：在业务流程上，还可以通过设置审批流程来进行监督和管理。从流程整体上或划分的每个阶段（目标、计划、执行和结尾）中，找出关键的业务处理节点，在此节点上设置审批流程。6.3功能层详细设计功能层的详细设计，是将完成某个业务处理所需要的原型界面、数据结构、控件定义、操作方法以及相关规则整合在一起的设计过程。功能设计的类型包含：a)活动设计：对应着现实中一个独立的数据处理工作。活动设计是将现实的工作转换为系统处理的业务功能。b)字典设计：字典是对基础数据进行标准化管理的运维功能。通过设计字典功能，可以建立一套支持数据标准、数据输入、数据维护等的工作体系。c)看板设计：看板是以窗体为载体进行数据展示的功能。通过设计看板功能，可以静态或动态地展示统计分析数据、监控过程数据是否超标以及导引各类信息等。5T/NMPA004—2024d)表单设计：表单是以纸质形式为载体（包括电子版）的数据展示功能。表单的代表形式有报表和单据两种。通过设计表单功能，可以将常用的凭证类数据、分析类数据用固化的格式展示与打印。6.4数据层详细设计数据层的详细设计，是基于数据的概要设计成果（数据规划和标准）、功能的详细设计成果（字段的定义）等资料对数据进行逻辑层面的设计，给出数据的逻辑关系，包括：数据关系、复杂计算、数据建模等。a)数据关系：建立数据表之间的关系（利用主键/外键等）。b)复杂计算：在对数据定义的过程中会遇到很多复杂的数据逻辑和计算公式，解决这些复杂计算就会用到很多算式表达模型，如算式关联图、数据钩稽图、业务数据线等。c)数据建模：利用已经积累的数据建立模型，使其在业务处理过程中指导后续的工作。6.5业务用例设计验证为了确保设计的准确无误，需要对详细设计的结果进行验证，验证的方法是通过编写业务用例的方式进行。业务用例的设计包括4个步骤：用例场景、用例导图、用例数据和用例验证。7详细设计说明书内容详细设计说明书着重描述每一个模块是怎样实现的，包括实现算法、逻辑流程等。详细设计说明书的编写内容包括：7.1引言引言内容应包括但不限于：a)编写目的：阐明编写详细设计说明书的目的，指明读者对象。b)项目背景：应包括项目的来源和主管部门等。c)定义：列出文档中用到的专门术语定义和缩写词的原意。d)参考资料：列出有关的参考资料，包括资料的作者、标题、编号、发表日期、出版单位或资料来源，包括项目经核准的计划任务书，合同或批文；项目开发计划；需求规格说明书；总体设计说明书；测试计划（初稿）；用户操作手册（初稿）；文档所引用的其他资料、软件开发标准或规范。7.2系统总体结构依据总体设计的结果，给出系统的总体结构，包括功能结构、软件结构、系统构成、系统部署。用一系列图表列出系统内的每个模块的名称、标识符和它们之间的层次结构关系。在网络设计方面：7.2.1网络设计说明网络设计应根据系统的要求选择网络结构，按照系统结构的划分，安排网络和设备的分布，然后根据物理位置考虑网络布线和设备的部署，还应根据实际业务的要求划定各网络节点的权限、级别和管理方式等,选择相应的系统软件和管理软件。网络设计应包含以下内容：a)确定网络总体目标。应明确采用哪些网络技术和标准，构筑一个满足哪些应用的多大规模的网络，包括是否分期实施、网络的实施成本和运行成本等方面的问题。b)确定总体设计原则。应对主要设计原则进行选择和权衡，并确定其在方案设计中的优先级。网络设计的一些基本原则有实用性原则、开放性原则、高可用性/可靠性原则、安全性原则、先进性原则、易用性原则和可扩展性原则等。c)通信子网设计。通信子网设计应包括拓扑结构与网络总体规划、分层的设计，以及远程接入访问的设计。其中，拓扑结构与网络总体规划是整个网络设计的基础，应结合费用、灵活性和可靠性三个方面综合考虑。6T/NMPA004—2024d)资源子网设计。资源子网设计应考虑服务器的接入和子网连接的问题。服务器是网络中的核心设备,包括为全网服务的服务器和为部门业务服务的服务器两类，每类服务器可采用不同的接入方式。e)设备选型。设备选型应包括网络设备和各个层次的交换机的选择策略。网络设备的选型应考虑厂商选择原则(尽可能选取同一厂商，选择产品线全、技术认证队伍力强、市场占有率高的网络设备品牌)、扩展性原则(主干应预留扩展，低端够用即可)，根据方案实际需要选型(性能、端口类型和端口密度等),选择性价比高、质量好的设备；核心交换机的选型策略是设备应具备高性能和高速率、定位准确、便于升级和扩展、可靠性、强大网络控制能力、良好可管理性等特点；汇聚层/接入层交换机的选型策略是应具备灵活性、高性能，在满足要求的基础上尽量便宜、易用、简单，具备一定的QoS和控制能力，支持多级网络管理等特点。f)网络操作系统与服务器资源设备。选择服务器时，首先应看具体的网络应用,然后确定网络操作系统，再进行服务器选型。网络操作系统的选择应结合服务器的性能和兼容性、安全因素、价格因素、第三方软件和市场占有率等方面进行综合考查。根据需要，还应配置服务器集群或双机容错系统等，以便实现更好的性能。g)网络安全设计。网络安全设计的基本原则有木桶原则、整体性原则、有效性与实用性原则、等级性原则、设计为本原则、自主和可控性原则、安全有价原则等。网络安全设计与实施的步骤是，确定面临的攻击和风险，明确安全策略，建立安全模型，选择并实现安全服务，对安全产品的选型进行测试。7.3模块设计说明（类方法设计说明）结构化方法下，逐个地给出各个层次中的每个模块的设计考虑。面向对象方法下，逐个给出每个类的不同方法的设计。每个模块设计说明应包括：a)模块描述：给出对该基本模块的简要描述，主要说明安排设计本模块的目的意义，并且，还要说明本模块的特点。b)功能：说明该基本模块应具有的功能。c)性能：说明对该模块的全部性能要求。d)输入项：给出对每一个输入项的特性。e)输出项：给出对每一个输出项的特性。f)设计方法（算法对于软件设计，应详细说明本程序所选用的算法，具体的计算公式及计算步骤。g)流程逻辑：用图表辅以必要的说明来表示本模块的逻辑流程。h)接口：说明本模块与其他相关模块间的逻辑连接方式，说明涉及的参数传递方式。i)存储分配：根据需要，说明本模块的存储分配。j)注释设计：说明安排的程序注释。k)限制条件：说明本模块在运行使用中所受到的限制条件。l)测试计划：说明对本模块进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件、驱动程序及桩模块等的规定。m)尚未解决的问题：说明在本模块的设计中尚未解决而设计者认为在系统完成之前应解决的问题。其中处理流程设计、数据存储设计、用户界面设计、安全性和可靠性设计说明如下：7.4处理流程设计说明处理流程设计是系统详细设计的重要组成部分，应确定各个系统模块的内部结构，即内部执行过程，包括局部数据组织和控制流，以及每个具体加工过程和实施细节。7.4.1流程流程应包括6个基本要素，分别是输入资源、活动、活动的相互作用（结构）、输出结果、用户和价值。例如，在线教育平台系统中的“开通课程”流程，其6个要素如表1所示。表1开通课程流程的6个要素要素名称要素含义输入资源需要开通课程的注册用户名7T/NMPA004—2024活动开通课程的业务逻辑（例如，用户名合法性判断、时间判断和费用计算等）活动的相互作用开通课程与其他活动（例如，在线测试等）流程的相互关系输出结果开通课程成功后获取的短消息通知和电子邮件通知用户已交纳课程学习费用的注册用户价值用户可通过该流程实现学习课程的功能7.4.2工作流工作流是一系列相互衔接、自动进行的业务活动或任务，一个工作流应包括一组活动（或任务）及它们的相互顺序关系，还应包括流程和活动的启动和终止条件，以及对每个活动的描述。7.4.3活动及其所有者活动是流程定义中的一个基本要素，一次活动可改变流程处理数据的内容、流程的状态，并可将流程推动到其他活动中去。活动可由人来完成，也可以是系统自动进行处理。7.4.4工作项工作项代表流程实例中活动的参与者将要执行的工作。7.5数据存储设计说明数据存储设计需根据数据处理要求、处理方式、存储的信息量大小、数据使用的频率和所能提供的设备条件等，选择数据存储的方式、存储介质、数据组织方式和记录格式，并估算数据的容量。数据存储设计应充分体现系统的业务流程，充分满足组织的各级管理要求。同时，还应使得后续的系统开发工作方便、快捷，系统开销小，且易于管理和维护。7.5.1数据库设计阶段数据库系统生命周期的数据库设计可分为五个阶段：规划、需求分析、概念设计、逻辑设计和物理设计。a)规划阶段应建立数据库的必要性及可行性分析，确定数据库系统在企业和信息系统中的地位，以及各个数据库之间的联系。b)需求分析应通过调查研究，了解用户的数据和处理要求，并按一定格式整理形成需求说明书。需求说明书包括数据库所涉及的数据、数据的特征、使用频率和数据量的估计。c)概念设计应在需求分析阶段产生的需求说明书的基础上，按照特定的方法将它们抽象为一个不依赖于任何DBMS的数据模型，即概念模型。概念模型使设计人员的注意力能够从复杂的实现细节中解脱出来，而只集中在最重要的数据的组织结构和处理模式上。为保证所设计的概念模型能正确、完全地反映用户的数据及其相互关系，便于进行所要求的各种处理，在概念设计阶段中，可邀请用户参与。在进行概念设计时，可先设计各个应用的视图，即各个应用所看到的数据及其结构然后再进行视图集成，以形成一个单一的概念数据模型。d)逻辑设计需将概念模型转化为某个特定的DBMS上的逻辑模型。设计逻辑结构时，首先为概念模型选定一个合适的逻辑模型(例如，关系模型、网状模型或层次模型)，然后将其转化为由特定DBMS支持的逻辑模型，最后对逻辑模型进行优化。逻辑设计的目的是将概念设计阶段设计好的E-R图转换为与选用的具体机器上的DBMS所支持的数据模型相符合的逻辑结构。e)物理设计需对给定的逻辑模型选取一个最适合应用环境的物理结构，所谓数据库的物理结构，主要是指数据库在物理设备上的存储结构和存取方法。7.5.2实体联系模型数据库设计应用E-R模型描述概念世界，建立概念模型。E-R模型应包括以下三个要素：a)实体。实体应用矩形框表示，框内标注实体名称。b)属性。单值属性应用椭圆形表示，并用连线与实体连接起来。若是多值属性需应在椭圆形虚线外面再套实线椭圆；若是派生属性，则应用虚线椭圆表示。8T/NMPA004—2024c)实体之间的联系。实体之间的联系应用菱形框表示，框内标注联系名称，并用连线将菱形框分别与有关实体相连，并在连线上注明联系类型。例如，图2就是某在线教育平台系统的一个E-R图(为了简单起见，省略了部分实体的属性和联系的属性)。图2某教学系统E-R图7.6用户界面设计说明用户界面设计需要遵循以下基本原则：a)置于用户控制之下。在定义人机交互方式时，不应强迫用户采用不是必须的或者不情愿的方式来进行操作，允许交互的中断和撤销。当用户操作技能等级提高时，可以实现流水化的交互方式，允许用户定制交互方式，以便使用户界面与内部技术细节隔离,允许用户和出现在屏幕上的对象直接进行交互。b)减轻用户的记忆负担。宜减轻对用户记忆的要求，创建有意义的默认设置，定义一些符合用户直觉的访问途径，适当定义一些快捷方式，界面的视觉布局应该尽量与真实世界保持一致，并能够以不断扩展的方式呈现信息。c)保持界面一致性。用户应以一致的方式提供或获取信息，所有可视信息的组织需按照统一的设计标准，在系列化的应用软件中应保持一致性，用户已经很熟悉的一些界面交互模型不宜随意进行修改。应确保用户界面操作和使用的一致性。7.7安全性和可靠性设计说明9T/NMPA004—2024安全性和可靠性设计的目的是确保系统的安全性和可靠性，对系统的运行环境和数据处理进行有效的控制，保证系统安全、有效地运行。其主要内容应包括系统运行环境安全性分析和控制，如对管理结构的组织、硬件和系统软件、自然环境等方面的分析与必要的监督和控制等，还包括对数据处理的控制。7.7.1安全性设计安全防范体系的层次应划分为物理层安全、系统层安全、网络层安全、应用层安全和安全管理。a)物理层的安全应包括通信线路、物理设备和机房的安全等。物理层的安全主要体现在通信线路的可靠性(线路备份、网管软件和传输介质)、软硬件设备的安全性(替换设备、拆卸设备、增加设备)、设备的备份、防灾害能力、防干扰能力、设备的运行环境(温度、湿度、烟尘)和不间断电源保障等。b)系统层的安全问题应考虑计算机网络内使用的操作系统的安全，例如，WindowsServer和UNIX等。主要表现在3个方面，一是由操作系统本身的缺陷带来的不安全因素，主要包括身份认证、访问控制和系统漏洞等；二是对操作系统的安全配置问题；三是病毒对操作系统的威胁。c)网络层的安全问题主要体现在计算机网络方面，应包括网络层身份认证、网络资源的访问控制、数据传输的保密与完整性、远程接入的安全、域名系统的安全、路由系统的安全、入侵检测的手段和网络设施防病毒等。d)应用层的安全问题主要由提供服务所采用的应用软件和数据的安全性产生，应包括Web服务、电子邮件系统和DNS等。此外，还应包括病毒对系统的威胁。e)安全管理应包括安全技术和设备的管理、安全管理制度、部门与人员的组织规则等。管理的制度化极大程度地影响着整个计算机网络的安全，严格的安全管理制度、明确的部门安全职责划分与合理的人员角色配置，都可以在很大程度上降低其他层次的安全漏洞。7.7.2可靠性设计a)使用CMMI(能力成熟度模型集成)规范管理过程、应用测试等。b)设计层面降低系统复杂度。c)出错后报警，人工处理，成本较低。d)容错技术。1)N版本程序设计(静态元余)，多个版本同时计算获得到结果，通过表决器算法最终确定采用结果。主要应用在可靠性要求极高的场景，成本高。与通常软件开发过程不同的是，N版本程序设计增加了三个新的阶段:相异成分规范评审、相异性确认、背对背测试。N版本程序的同步、N版本程序之间的通信、表决算法(全等表决、非精确表决一致比较问题、数据相异性。Cosmetie表决)图3N版本程序设计T/NMPA004—20242)恢复块设计(动态冗余)，设计时应保证实现主块和后备块之间的独立性，避免相关错误的产生，使主块和备份块之间的共性错误降到最低程度。必须保证验证测试程序的正确性。图4恢复块方法3)防卫式程序设计，对于程序中存在的错误和不一致性，通过在程序中包含错误检查代码和错误恢复代码，使得一旦错误发生，程序能撤销错误状态，恢复到一个已知的正确的状态中去。T/NMPA004—2024（资料性附录）详细设计说明书【模板】详细设计说明书第1章引言1.1编写目的说明编写这份详细设计说明书的目的，指出预期的读者。a.待开发系统的名称。b.列出本项目的任务提出者、开发者、用户。