详细设计文档的生成方法、装置、电子设备和存储介质

技术领域

本发明涉及计算机技术领域，尤其涉及一种详细设计文档的生成方法、装置、电子设备和存储介质。

背景技术

软件开发是一项包括需求捕捉、需求分析、设计、实现和测试的系统工程。详细设计是软件开发的一个关键步骤，直接影响开发人员的编程效率和质量。传统的详细设计通过绘制统一建模语言(Unified Model Language，UML)图或者人工编写固定格式的详细设计说明书来实现，但绘制UML图更侧重于设计，不利于开发人员理解，对设计人员的专业性要求较高，而人工编写详细设计说明书工作量大，效率低，修订成本高，内容的一致性较差，不能有效指导开发人员进行编码。

发明内容

本发明提供一种详细设计文档的生成方法、装置、电子设备和存储介质，用以解决现有技术中通过绘制UML图实现详细设计，依赖设计人员的专业能力，不利于开发人员理解的缺陷，以及通过编写固定格式的详细设计说明书实现详细设计，工作量大，修订成本高，内容的一致性较差，不易指导开发的缺陷。

第一方面，本发明提供一种详细设计文档的生成方法，包括：

获取完成每一目标功能所需的所有动作；

确定每一动作对应的事件；

生成每一动作的工作项数据以及所述每一动作对应的事件的工作项数据，得到多个细节描述文档；

确定所述多个细节描述文档与每一目标功能对应的动作的第一关联关系，以及所述多个细节描述文档与每一目标功能对应的事件的第二关联关系；

基于所述每一目标功能对应的动作、所述每一目标功能对应的事件、所述多个细节描述文档，以及所述第一关联关系和所述第二关联关系，生成详细设计文档。

在一些实施例中，所述生成每一动作的工作项数据以及所述每一动作对应的事件的工作项数据，得到多个细节描述文档，包括：

基于所述每一动作以及所述每一动作对应的事件，生成多个细节描述模板，其中每一细节描述模板包括多个字段；

对需求分析文档进行解析，得到关键信息；

基于所述关键信息，生成每一动作的工作项数据以及所述每一动作对应的事件的工作项数据；

基于所述字段，将所述每一动作的工作项数据以及所述每一动作对应的事件的工作项数据分类填充至所述多个细节描述模板中，得到多个细节描述文档。

在一些实施例中，所述多个细节描述模板的类型至少包括：参数整合、角色与权限设置、结构化查询语言(Structured Query Language，SQL)语句设计、查询条件、查询结果显示列表。

在一些实施例中，所述确定所述多个细节描述文档与每一目标功能对应的动作的第一关联关系，以及所述多个细节描述文档与每一目标功能对应的事件的第二关联关系，包括：

从每一目标功能对应的所有动作和事件中确定目标动作和目标事件；

从所述多个细节描述文档中确定所述目标动作关联的细节描述文档以及所述目标事件关联的细节描述文档；

在所述目标动作中插入第一超链接，所述第一超链接指向所述目标动作关联的细节描述文档，在所述目标事件中插入第二超链接，所述第二超链接指向所述目标事件关联的细节描述文档。

在一些实施例中，所述获取完成每一目标功能所需的所有动作，包括：

对需求分析文档进行解析，得到关键字；

基于所述关键字，得到完成每一目标功能所需的所有动作，并按照执行的先后顺序依次对各个动作进行编号。

在一些实施例中，所述方法还包括：

对软件需求进行分析，基于需求分析结果，确定多个目标功能。

第二方面，本发明还提供一种详细设计文档的生成装置，包括：

获取单元，用于获取完成每一目标功能所需的所有动作；

第一确定单元，用于确定每一动作对应的事件；

第一生成单元，用于生成每一动作的工作项数据以及所述每一动作对应的事件的工作项数据，得到多个细节描述文档；

第二确定单元，用于确定所述多个细节描述文档与每一目标功能对应的动作的第一关联关系，以及所述多个细节描述文档与每一目标功能对应的事件的第二关联关系；

第二生成单元，用于基于所述每一目标功能对应的动作、所述每一目标功能对应的事件、所述多个细节描述文档，以及所述第一关联关系和所述第二关联关系，生成详细设计文档。

第三方面，本发明还提供一种电子设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述程序时实现如上述任一种所述详细设计文档的生成方法。

第四方面，本发明还提供一种非暂态计算机可读存储介质，其上存储有计算机程序，该计算机程序被处理器执行时实现如上述任一种所述详细设计文档的生成方法。

第五方面，本发明还提供一种计算机程序产品，包括计算机程序，所述计算机程序被处理器执行时实现如上述任一种所述详细设计文档的生成方法。

本发明提供的一种详细设计文档的生成方法、装置、电子设备和存储介质，通过获取完成每一目标功能所需的所有动作，确定每一动作对应的事件，生成每一动作的工作项数据以及每一动作对应的事件的工作项数据，得到多个细节描述文档，确定多个细节描述文档与每一目标功能对应的动作的第一关联关系，以及多个细节描述文档与每一目标功能对应的事件的第二关联关系，基于每一目标功能对应的动作、每一目标功能对应的事件、多个细节描述文档，以及第一关联关系和所述第二关联关系，生成详细设计文档，本发明的方法效率高、成本低，不依赖设计人员的专业能力，生成的详细设计文档简洁明了，内容的一致性较强，通俗易懂，能够有效指导软件开发。

附图说明

为了更清楚地说明本发明或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作一简单地介绍，显而易见地，下面描述中的附图是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1是本发明提供的详细设计文档的生成方法的流程示意图；

图2是本发明实施例提供的详细设计文档的结构示意图；

图3是本发明实施例提供的生成每一动作的工作项数据以及每一动作对应的事件的工作项数据，得到多个细节描述文档的流程示意图；

图4是本发明提供的详细设计文档的生成装置的结构示意图；

图5是本发明提供的电子设备的结构示意图。

具体实施方式

为使本发明的目的、技术方案和优点更加清楚，下面将结合本发明中的附图，对本发明中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有作出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

图1为本发明实施例提供的详细设计文档的生成方法的流程示意图。如图1所示，提供了一种详细设计文档的生成方法，包括以下步骤：步骤110、步骤120、步骤130、步骤140、步骤150。该方法流程步骤仅仅作为本发明一个可能的实现方式。

步骤110、获取完成每一目标功能所需的所有动作。

需要说明的是，功能是指软件系统或应用程序所能执行的任务、操作或提供的服务。功能描述了系统的主要目标和主要特性，以及用户可以通过系统执行的各种操作和交互。动作是指在软件系统中进行的具体操作或行为。动作通常是由用户或系统触发的，用于执行某个特定的任务或操作。例如，点击按钮、输入文本、发送请求等。

步骤120、确定每一动作对应的事件。

需要说明的是，事件是指在软件系统中发生的特定事情或状态变化。事件可以是由用户、系统或外部环境触发的，用于通知系统需要采取相应的行动。例如，用户点击按钮、接收到网络请求、设备状态变化等。

可以理解的是，功能、动作和事件用于描述系统的行为和交互方式，有助于开发团队明确需求、设计系统功能，并确保软件系统按预期工作。

步骤130、生成每一动作的工作项数据以及每一动作对应的事件的工作项数据，得到多个细节描述文档。

其中，工作项数据指的是对于某个特定的动作或事件，所涉及到的具体细节信息，比如动作或事件发生的时间、地点、参与者、行为方式、结果等信息。在不同的情境中，动作和事件的细节可以有所不同，但工作项数据都是为了给动作或事件提供更全面和准确的描述。

需要说明的是，细节描述文档通常是指关于某个任务、项目或系统的详细描述文档。它包含了该任务、项目或系统的各个方面的具体细节和要求，以便确保所有相关人员对于实现目标有清晰的了解。细节描述文档的种类多样，可以包括技术规范、功能需求、设计细节、接口说明、算法描述等等，具体内容取决于所描述的任务或项目的性质。细节描述文档的目的是为了确保项目的各个方面得到详尽的描述，从而使开发人员、设计人员以及其他相关人员能够更好地理解开发任务。

步骤140、确定多个细节描述文档与每一目标功能对应的动作的第一关联关系，以及多个细节描述文档与每一目标功能对应的事件的第二关联关系。

可选地，在多个细节描述文档中确定每一目标功能对应的动作关联的细节描述文档，在多个细节描述文档中确定每一目标功能对应的事件关联的细节描述文档。

步骤150、基于每一目标功能对应的动作、每一目标功能对应的事件、多个细节描述文档，以及第一关联关系和第二关联关系，生成详细设计文档。

图2为本发明实施例提供的详细设计文档的结构示意图。如图2所示，详细设计文档包括功能1和功能2，每个功能都有与其对应的动作、事件，以及多个细节描述文档，功能1对应动作1，动作1对应事件1，功能1对应的多个细节描述文档包括附表11、附表12、附表13、附表14和附表15，上述附表与动作1关联，且与事件1关联；功能2对应动作2，动作2对应事件2，功能2对应的多个细节描述文档包括附表21、附表22、附表23、附表24和附表25，上述附表与动作2关联，且与事件2关联。

可以理解的是，针对每一目标功能，将该目标功能对应的动作、事件和多个细节描述文档进行组合，并将多个细节描述文档与动作关联，并与事件关联，生成的详细设计文档由多个轻量级的组合单元构成，简洁明了，非常适用于中小型软件系统的详细设计。

在本发明实施例中，通过获取完成每一目标功能所需的所有动作，确定每一动作对应的事件，生成每一动作的工作项数据以及每一动作对应的事件的工作项数据，得到多个细节描述文档，确定多个细节描述文档与每一目标功能对应的动作的第一关联关系，以及多个细节描述文档与每一目标功能对应的事件的第二关联关系，基于每一目标功能对应的动作、每一目标功能对应的事件、多个细节描述文档，以及第一关联关系和所述第二关联关系，生成详细设计文档，本发明的方法效率高、成本低，不依赖设计人员的专业能力，生成的详细设计文档简洁明了，内容的一致性较强，通俗易懂，能够有效指导软件开发。

需要说明的是，本发明每一个实施方式可以自由组合、调换顺序或者单独执行，并不需要依靠或依赖固定的执行顺序。

图3为本发明实施例提供的生成每一动作的工作项数据以及每一动作对应的事件的工作项数据，得到多个细节描述文档的流程示意图。如图3所示，在一些实施例中，步骤130生成每一动作的工作项数据以及每一动作对应的事件的工作项数据，得到多个细节描述文档，包括：

步骤131、基于每一动作以及每一动作对应的事件，生成多个细节描述模板，其中每一细节描述模板包括多个字段。

其中，细节描述模板是一种用于描述动作或事件的结构化模板。

示例性地，查询条件类的细节描述模板包括“查询条件”和“特殊说明”字段。

步骤132、对需求分析文档进行解析，得到关键信息。

其中，需求分析文档是指记录和明确对于软件系统或产品的需求和期望的文档，关键信息包含功能需求、数据需求、约束和限制等信息。

步骤133、基于关键信息，生成每一动作的工作项数据以及每一动作对应的事件的工作项数据。

可选地，确定每一动作对应的关键信息，生成每一动作的工作项数据。

可选地，确定每一动作对应的事件的关键信息，生成每一动作对应的事件的工作项数据。

步骤134、基于字段，将每一动作的工作项数据以及每一动作对应的事件的工作项数据分类填充至多个细节描述模板中，得到多个细节描述文档。

示例性地，查询条件设计模板中包含字段“查询条件”和“特殊说明”，将动作“点击查询按钮”对应的工作项数据分类填充至上述两个字段对应的位置。

可以理解的是，通过基于每一动作以及每一动作对应的事件，生成多个细节描述模板，进而便于对不同的细节信息进行分类整合，通过对需求分析文档进行解析，得到关键信息，进而能够基于关键信息，生成每一动作的工作项数据以及每一动作对应的事件的工作项数据，基于字段，将每一动作的工作项数据以及每一动作对应的事件的工作项数据分类填充至多个细节描述模板中，得到多个细节描述文档，提高了细节描述文档的准确性，便于用户进行查看。

在一些实施例中，多个细节描述模板的类型至少包括：参数整合、角色与权限设置、SQL语句设计、查询条件、查询结果显示列表。

表1-5为本发明实施例提供的细节描述模板示例。表1为参数整合模板，包含“参数说明”和“决策方案”两个字段；表2为角色与权限设置模板，包括“用户角色”和“权限控制”两个字段；表3为SQL语句设计模板，包括“SQL语句”和“工程中的SQL---复核人”两个字段；表4为查询条件模板，包括“查询条件”和“特殊说明”两个字段；表5为查询结果显示列表模板，包括“字段名称”和“字段来源”两个字段。

表1参数整合模板

表2角色与权限设置模板

表3 SQL语句设计模板

表4查询条件模板

表5查询结果显示列表模板

在一些实施例中，确定多个细节描述文档与每一目标功能对应的动作的第一关联关系，以及多个细节描述文档与每一目标功能对应的事件的第二关联关系，包括：

从每一目标功能对应的所有动作和事件中确定目标动作和目标事件；

从多个细节描述文档中确定目标动作关联的细节描述文档以及目标事件关联的细节描述文档；

在目标动作中插入第一超链接，第一超链接指向目标动作关联的细节描述文档，在目标事件中插入第二超链接，第二超链接指向目标事件关联的细节描述文档。

示例性地，确定页面功能对应的目标动作为“点击查询按钮”，该目标动作关联的细节描述文档为“附表3”，则在该目标动作所在的行插入指向“附表3”的第一超链接。

可以理解的是，对于每一目标功能，通过确定目标动作和目标事件，进而能够确定目标动作关联的细节描述文档以及目标事件关联的细节描述文档，从而便于在目标动作中插入指向目标动作关联的细节描述文档的第一超链接，在目标事件中插入指向目标事件关联的细节描述文档的第二超链接，有助于开发人员更好地理解和组织相关信息，提高编码效率。

在一些实施例中，获取完成每一目标功能所需的所有动作，包括：

对需求分析文档进行解析，得到关键字；

基于关键字，得到完成每一目标功能所需的所有动作，并按照执行的先后顺序依次对各个动作进行编号。

可选地，关键字可以是技术术语、方法名或特定功能的名称。

可以理解的是，根据动作的依赖关系和执行的先后顺序，为每个动作分配一个编号，从而能够确保按照正确的顺序执行这些动作，以便实现每个目标功能。

表6为本发明实施例提供的页面功能对应的动作和事件示例。如表6所示，页面功能对应的动作包括：

步骤601、配置菜单；

步骤602、信用担保机构管理-->基本信息-->基本信息查询；

步骤603、跳转至查询页面；

步骤604、查询条件的特殊处理(查询条件保存，所有页面跳转都需要重新查询)；

步骤605、点击查询按钮(SQL语句见【附表3】)；

步骤606、查询结果列表范围(隐含查询条件)；

步骤607、查询列表的处理；

步骤608、分页的实现；

步骤609、点击客户名称链接，查看信用担保机构详细信息；

步骤610、性能的考虑。

其中步骤601-610中每个步骤的动作都有对应的事件，如表6所示，通过上述各个动作和事件的描述，便于开发人员更好地理解页面功能对应的开发任务。

表6页面功能对应的动作和事件示例

在一些实施例中，上述方法还包括：

对软件需求进行分析，基于需求分析结果，确定多个目标功能。

可选地，可以通过面对面的会议、问卷调查、用户访谈等方式来收集需求，对软件需求进行分析，明确软件需要实现的功能，评估需求的可行性和可实现性，确定目标功能。

可以理解的是，通过对软件需求进行分析，基于需求分析结果，确定多个目标功能，进而便于生成准确性较高的详细设计文档，有助于确保开发出满足用户需求的软件系统。

下面对本发明实施例提供的详细设计文档的生成装置进行描述，下文描述的详细设计文档的生成装置与上文描述的详细设计文档的生成方法可相互对应参照。

图4为本发明提供的详细设计文档的生成装置的结构示意图，如图4所示，该详细设计文档的生成装置400包括：

获取单元410，用于获取完成每一目标功能所需的所有动作；

第一确定单元420，用于确定每一动作对应的事件；

第一生成单元430，用于生成每一动作的工作项数据以及每一动作对应的事件的工作项数据，得到多个细节描述文档；

第二确定单元440，用于确定多个细节描述文档与每一目标功能对应的动作的第一关联关系，以及多个细节描述文档与每一目标功能对应的事件的第二关联关系；

第二生成单元450，用于基于每一目标功能对应的动作、每一目标功能对应的事件、多个细节描述文档，以及第一关联关系和第二关联关系，生成详细设计文档。

可选地，生成每一动作的工作项数据以及每一动作对应的事件的工作项数据，得到多个细节描述文档，包括：

基于每一动作以及每一动作对应的事件，生成多个细节描述模板，其中每一细节描述模板包括多个字段；

对需求分析文档进行解析，得到关键信息；

基于关键信息，生成每一动作的工作项数据以及每一动作对应的事件的工作项数据；

基于字段，将每一动作的工作项数据以及每一动作对应的事件的工作项数据分类填充至多个细节描述模板中，得到多个细节描述文档。

可选地，多个细节描述模板的类型至少包括：参数整合、角色与权限设置、结构化查询语言(Structured Query Language，SQL)语句设计、查询条件、查询结果显示列表。

可选地，确定多个细节描述文档与每一目标功能对应的动作的第一关联关系，以及多个细节描述文档与每一目标功能对应的事件的第二关联关系，包括：

从每一目标功能对应的所有动作和事件中确定目标动作和目标事件；

从多个细节描述文档中确定目标动作关联的细节描述文档以及目标事件关联的细节描述文档；

在目标动作中插入第一超链接，第一超链接指向目标动作关联的细节描述文档，在目标事件中插入第二超链接，第二超链接指向目标事件关联的细节描述文档。

可选地，获取完成每一目标功能所需的所有动作，包括：

对需求分析文档进行解析，得到关键字；

基于关键字，得到完成每一目标功能所需的所有动作，并按照执行的先后顺序依次对各个动作进行编号。

可选地，该装置还包括：

功能确定单元，用于对软件需求进行分析，基于需求分析结果，确定多个目标功能。

在此需要说明的是，本发明实施例提供的详细设计文档的生成装置，能够实现上述详细设计文档的生成方法实施例所实现的所有方法步骤，且能够达到相同的技术效果，在此不再对本实施例中与方法实施例相同的部分及有益效果进行具体赘述。

图5示例了一种电子设备的实体结构示意图，如图5所示，该电子设备可以包括：处理器(processor)510、通信接口(Communications Interface)520、存储器(memory)530和通信总线540，其中，处理器510，通信接口520，存储器530通过通信总线540完成相互间的通信。处理器510可以调用存储器530中的逻辑指令，以执行详细设计文档的生成方法，该方法包括：获取完成每一目标功能所需的所有动作；确定每一动作对应的事件；生成每一动作的工作项数据以及每一动作对应的事件的工作项数据，得到多个细节描述文档；确定多个细节描述文档与每一目标功能对应的动作的第一关联关系，以及多个细节描述文档与每一目标功能对应的事件的第二关联关系；基于每一目标功能对应的动作、每一目标功能对应的事件、多个细节描述文档，以及第一关联关系和第二关联关系，生成详细设计文档。

此外，上述的存储器530中的逻辑指令可以通过软件功能单元的形式实现并作为独立的产品销售或使用时，可以存储在一个计算机可读取存储介质中。基于这样的理解，本发明的技术方案本质上或者说对现有技术做出贡献的部分或者该技术方案的部分可以以软件产品的形式体现出来，该计算机软件产品存储在一个存储介质中，包括若干指令用以使得一台计算机设备(可以是个人计算机，服务器，或者网络设备等)执行本发明各个实施例所述方法的全部或部分步骤。而前述的存储介质包括：U盘、移动硬盘、只读存储器(ROM，Read-Only Memory)、随机存取存储器(RAM，Random Access Memory)、磁碟或者光盘等各种可以存储程序代码的介质。

另一方面，本发明还提供一种计算机程序产品，所述计算机程序产品包括计算机程序，计算机程序可存储在非暂态计算机可读存储介质上，所述计算机程序被处理器执行时，计算机能够执行上述各方法所提供的详细设计文档的生成方法，该方法包括：获取完成每一目标功能所需的所有动作；确定每一动作对应的事件；生成每一动作的工作项数据以及每一动作对应的事件的工作项数据，得到多个细节描述文档；确定多个细节描述文档与每一目标功能对应的动作的第一关联关系，以及多个细节描述文档与每一目标功能对应的事件的第二关联关系；基于每一目标功能对应的动作、每一目标功能对应的事件、多个细节描述文档，以及第一关联关系和第二关联关系，生成详细设计文档。

又一方面，本发明还提供一种非暂态计算机可读存储介质，其上存储有计算机程序，该计算机程序被处理器执行时实现以执行上述各方法提供的详细设计文档的生成方法，该方法包括：获取完成每一目标功能所需的所有动作；确定每一动作对应的事件；生成每一动作的工作项数据以及每一动作对应的事件的工作项数据，得到多个细节描述文档；确定多个细节描述文档与每一目标功能对应的动作的第一关联关系，以及多个细节描述文档与每一目标功能对应的事件的第二关联关系；基于每一目标功能对应的动作、每一目标功能对应的事件、多个细节描述文档，以及第一关联关系和第二关联关系，生成详细设计文档。

以上所描述的装置实施例仅仅是示意性的，其中所述作为分离部件说明的单元可以是或者也可以不是物理上分开的，作为单元显示的部件可以是或者也可以不是物理单元，即可以位于一个地方，或者也可以分布到多个网络单元上。可以根据实际的需要选择其中的部分或者全部模块来实现本实施例方案的目的。本领域普通技术人员在不付出创造性的劳动的情况下，即可以理解并实施。

通过以上的实施方式的描述，本领域的技术人员可以清楚地了解到各实施方式可借助软件加必需的通用硬件平台的方式来实现，当然也可以通过硬件。基于这样的理解，上述技术方案本质上或者说对现有技术做出贡献的部分可以以软件产品的形式体现出来，该计算机软件产品可以存储在计算机可读存储介质中，如ROM/RAM、磁碟、光盘等，包括若干指令用以使得一台计算机设备(可以是个人计算机，服务器，或者网络设备等)执行各个实施例或者实施例的某些部分所述的方法。

最后应说明的是：以上实施例仅用以说明本发明的技术方案，而非对其限制；尽管参照前述实施例对本发明进行了详细的说明，本领域的普通技术人员应当理解：其依然可以对前述各实施例所记载的技术方案进行修改，或者对其中部分技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本发明各实施例技术方案的精神和范围。