CN105528418B - 一种设计文档生成方法及装置 - Google Patents

Abstract

本发明提供了一种设计文档生成方法及装置，其中，方法包括:解析系统的模型文件得到元数据；调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息；将所述系统设计图和对应的文字描述信息映射到预设的文档模板中，以生成设计文档。如此技术方案，能够面向软件开发过程的任何一个时期，最重要的是，能够面向软件开发期，无需手动操作系统功能点，而自动地生成设计文档。

Description

一种设计文档生成方法及装置

技术领域

本发明涉及软件开发技术领域，特别是涉及一种设计文档生成方法及装置。

背景技术

近年来，软件行业所面临的主要矛盾仍就是不断增长、日益复杂的用户需求与落后的软件生产力之间的矛盾。特别是随着云计算、大数据、移动互联网等新技术、新业态的出现，这一矛盾尤其突出，具体表现在产品开发效率低下、开发成本和进度失控等等。设计文档是贯穿软件开发、软件应用过程的重要资料，其编写和维护通常需要投入大量的人力成本，因此设计文档的编写效率是影响软件开发时间、开发成本的重要因素。

现有的设计文档生成方案主要是在软件运行期通过手动操作执行业务系统的方式实现，一种方式是在系统执行过程中，手动操作系统各功能点，记录系统各功能点的元数据，通过分析元数据并根据文档模板导出设计文档。另一种方式是通过保留系统原版本及原版本对应的设计文档，通过手动操作执行更新后的业务系统，获取更新版本中变化的元数据，根据变化的元数据增量修改原版本对应的设计文档。

综上所述，现有的设计文档生成方案存在的主要问题：

(1)只能在系统运行期生成设计文档，开发期阶段当系统尚未开发完成时无法实时、有效的获取当前系统所对应的设计文档。

(2)必须手动操作执行系统所有功能点，不仅操作过程繁琐且覆盖不全面，而且效率低，特别的对于大规模应用系统而言，这种实现方式是相当耗时。

随着用户需求的不断变化以及软件规模日益庞大等问题的出现，现有方案已经难以满足当前大规模软件系统快速开发和交付的需要。

发明内容

为了解决上述技术问题，本发明提供了一种设计文档生成方法及装置，能够面向软件开发过程的任何一个时期，最重要的是，能够面向软件开发期，无需手动操作系统功能点，而自动地生成设计文档。

本发明第一方面提供了一种设计文档生成方法，所述方法包括:

解析系统的模型文件得到元数据；

调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息；

将所述系统设计图和对应的文字描述信息映射到预设的文档模板中，以生成设计文档。

可选的，所述解析系统的模型文件得到元数据的步骤，包括：

解析系统的页面模型文件得到系统外观元数据；

解析系统的业务流程操作模型文件得到业务操作流程元数据；

解析数据访问操作模型文件得到数据访问操作元数据；

解析数据实体模型文件得到数据库实体元数据。

可选的，所述解析系统的页面模型文件得到系统外观元数据的步骤，包括

解析系统的页面模型文件，获取每个标签描述的内容；

根据每个标签描述的内容，提取系统用例元数据、时序图元数据、页面流图元数据和页面效果预览元数据。

可选的，所述解析系统的业务流程操作模型文件得到业务操作流程元数据的步骤，包括：

解析系统的业务流程操作模型文件，获取每个标签描述的内容；

根据每个标签描述的内容，提取用于描述业务流程操作的元数据、用于描述业务流程操作类和类关系的元数据、用于描述业务流程操作时序关系的元数据。

可选的，所述解析数据访问操作模型文件得到数据访问操作元数据的步骤，包括：

解析系统的数据访问操作模型文件，获取每个标签描述的内容；

根据每个标签描述的内容，提取用于描述数据访问操作类的元数据、用于描述数据访问操作时序关系的元数据、用于描述数据访问操作类关联关系的元数据。

可选的，所述解析数据实体模型文件得到数据库实体元数据的步骤，包括：

解析系统的数据实体模型文件，获取每个标签描述的内容；

根据每个标签描述的内容，提取用于描述数据库概要设计的元数据、用于描述实体关系图的元数据、用于描述数据实体类的元数据。

可选的，所述调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息的步骤，包括：

根据绘图工具的应用程序编程接口类型，将所述元数据转换成绘图工具可识别的数据格式，以得到绘图元数据；

利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成系统设计图和对应的文字描述信息。

可选的，所述利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成系统设计图和对应的文字描述信息的步骤：

利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成用例图、时序图、业务流程操作类图、数据访问操作类图、数据实体图、数据库表概要设计图、页面预览效果图及每个图对应的文字描述信息。

可选的，所述绘图工具是基于统一建模语言的绘图工具。

可选的，所述调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息的步骤，包括：

通过统一建模语言的绘图工具调用所述绘图元数据生成用例图、时序图、业务流程操作类图、数据访问操作类图、数据实体图、数据库表概要设计图及每个图对应的文字描述信息；

通过浏览器界面预览的接口调用所述页面预览元数据，生成页面预览效果图及对应的文字描述信息。

本发明第二方面提供了一种设计文档生成装置，所述装置包括:

解析单元，用于解析系统的模型文件得到元数据；

绘图单元，用于调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息；

映射单元，用于将所述系统设计图和对应的文字描述信息映射到预设的文档模板中，以生成设计文档。

可选的，所述解析单元包括：

第一解析子单元，用于解析系统的页面模型文件得到系统外观元数据；

第二解析子单元，用于解析系统的业务流程操作模型文件得到业务操作流程元数据；

第三解析子单元，用于解析数据访问操作模型文件得到数据访问操作元数据；

第四解析子单元，用于解析数据实体模型文件得到数据库实体元数据。

可选的，所述第一解析子单元包括：

第一解析模块，用于解析系统的页面模型文件，获取每个标签描述的内容；

第一提取模块，用于根据每个标签描述的内容，提取系统用例元数据、时序图元数据、页面流图元数据和页面效果预览元数据。

可选的，所述第二解析子单元包括：

第二解析模块，用于解析系统的业务流程操作模型文件，获取每个标签描述的内容；

第二提取模块，用于根据每个标签描述的内容，提取用于描述业务流程操作的元数据、用于描述业务流程操作类和类关系的元数据、用于描述业务流程操作时序关系的元数据。

可选的，第三解析子单元包括：

第三解析模块，用于解析系统的数据访问操作模型文件，获取每个标签描述的内容；

第三提取模块，用于根据每个标签描述的内容，提取用于描述数据访问操作类的元数据、用于描述数据访问操作时序关系的元数据、用于描述数据访问操作类关联关系的元数据。

可选的，所述第四解析子单元包括：

第四解析模块，用于解析系统的数据实体模型文件，获取每个标签描述的内容；

第四提取模块，用于根据每个标签描述的内容，提取用于描述数据库概要设计的元数据、用于描述实体关系图的元数据、用于描述数据实体类的元数据。

可选的，所述绘图单元包括：

格式转换子单元，用于根据绘图工具的应用程序编程接口类型，将所述元数据转换成绘图工具可识别的数据格式，以得到绘图元数据；

绘制子单元，用于利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成系统设计图和对应的文字描述信息。

可选的，所述绘制子单元具体用于：

利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成用例图、时序图、业务流程操作类图、数据访问操作类图、数据实体图、数据库表概要设计图、页面预览效果图及每个图对应的文字描述信息。

可选的，所述绘图工具是基于统一建模语言的绘图工具。

可选的，所述绘图单元包括：

第一绘制子单元，用于通过统一建模语言的绘图工具调用所述绘图元数据生成用例图、时序图、业务流程操作类图、数据访问操作类图、数据实体图、数据库表概要设计图及每个图对应的文字描述信息；

第二绘制子单元，用于通过浏览器界面预览的接口调用所述页面预览元数据，生成页面预览效果图及对应的文字描述信息。

与现有技术相比，本发明提供的技术方案具有以下有益效果：

本发明提供的设计文档生成方法，解析系统的模型文件得到元数据；调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息；将所述系统设计图和对应的文字描述信息映射到预设的文档模板中，以生成设计文档。本发明在生成设计文档时，借助基于模型结构的系统，其在开发期沉淀的模型资产，由于在开发期中系统潜在的大量设计过程元数据都会沉淀在模型文件中，因此，本发明从模型文件中解析得到元数据，利用这些元数据结合预设的文档模型就能够自动建立设计文档。这样，既避免了运行期导出设计文档需要手动执行系统操作存在的操作复杂、覆盖不全等问题。同时又突破了现有技术在开发期生成设计文档时存在的解析效率低、设计元数据无法有效沉淀和获取等一系列技术瓶颈。特别是对于功能结构层次交叠、系统规模异常庞大、用户需要频繁变更的大规模应用系统而言，本发明的优势尤其突出。

附图说明

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

图1是本发明提供的一种设计文档生成方法实施例的流程图；

图2是图1步骤101的一种实现方式示意图；

图3是页面模型文件的解析过程示意图；

图4是业务流程操作模型的解析过程示意图；

图5是数据访问操作模型文件的解析过程示意图；

图6是数据实体模型文件的解析过程示意图；

图7是本发明提供的一种设计文档生成装置实施例的结构图；

图8-12分别是图7所示装置中解析单元的结构示意图；

图13-14分别是图7所示装置中绘图单元的结构示意图。

具体实施方式

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

为了更好地解释说明本发明提供的技术方案，下面先对基于模型结构的系统开发过程进行简单介绍。

在系统开发过程中，基于结构良好的模型文件来替代HTML文件、JavaScript脚本文件等来开发系统，主要是采用结构良好的模型文件分别针对页面展现层、业务逻辑层、数据访问层、实体数据层进行开发。具体情况如下：

(1)采用页面模型文件代替HTML文件进行页面展现层的开发。

在实现时，使用集成开发环境IDE，在页面模型文件中编写HTML、JavaScript脚本代码。

页面模型文件中完整记录了HTML页面中的所有页面元素信息以及页面请求的标题名称、方法描述等元数据。

(2)采用业务流程操作模型文件实现对应的业务逻辑层的接口及实现类的初始化创建。

业务流程操作模型文件中完整的记录了对应实现类以及类中的方法定义、类依赖和调用、继承等关联信息。当修改业务逻辑层对应实现类中的代码时，系统将自动同步更新业务流程操作模型文件中的记录的元数据，保证业务流程操作模型文件中记录的信息和实现类的一致性。

(3)采用数据访问操作模型文件实现对应的数据访问层的接口及实现类的初始化创建。

数据访问操作模型文件中完整的记录了对应实现类以及类中的方法定义、类依赖和调用、继承等关联信息。当修改数据访问层对应实现类中的代码时，系统将自动同步更新数据访问操作模型文件中的记录的元数据，保证数据访问操作模型文件中记录的信息和实现类的一致性。

(4)采用数据实体模型文件替代实体类进行数据实体对象类的开发。

在数据实体模型文件中完整的记录了实体属性、类型、实体名称等信息；并且当修改实体类时，系统会自动更新数据实体模型文件，保持数据实体模型文件和实体类的一致性。

开发人员编写的页面展现代码、业务流程操作代码、数据访问操作代码以及数据实体代码的元数据全部保存在对应的模型文件中。考虑到模型文件是不能够在浏览器中运行的，在应用时，还需要系统将页面模型文件转换成HTML文件，将业务流程操作模型文件转换成业务流程操作实现类文件、将数据访问操作模型文件转换成数据访问操作实现类文件以及将数据实体模型文件转换成对应的数据实体对象类。

本发明的核心思想就是借助开发期搭建的结构良好的模型文件，基于模型文件记录的元数据，提取设计文档所需的数据，并基于文档模板来快速地生成设计文档。整个解析和生成文档的过程都无须手动操作，其实现过程简单、高效。该方案有效解决了现有技术无法在开发期生成设计文档以及手动执行操作的繁琐低效的缺点，同时也有效解决了在开发期生成设计文档需要遍历和解析系统中类、HTML等文件获取和解析元数据时间复杂度过高的瓶颈问题。当然，本发明的实现并不局限于系统开发期使用，而是可以再任何一个时期，利用本发明都可以生成设计文档。

下面结合附图对本发明提供的技术方案进行解释说明。

请参阅图1，图1为本发明提供的一种设计文档生成方法实施例的流程图，如图1所示，该方法包括：

步骤101：解析系统的模型文件得到元数据。

在具体实现时，所述解析系统的模型文件得到元数据的步骤，可以按照以下方式实现，参见图2，该步骤可以进一步包括：

步骤1011：解析系统的页面模型文件得到系统外观元数据；

步骤1012：解析系统的业务流程操作模型文件得到业务操作流程元数据；

步骤1013：解析数据访问操作模型文件得到数据访问操作元数据；

步骤1014：解析数据实体模型文件得到数据库实体元数据。

这里需要说明的是，在图2中步骤1011至1014依次按照箭头所示顺序执行，但图2仅是一种示例，可选的，步骤1011至1014这四个步骤间可以没有执行顺序限制，可以按照任意串行顺序执行，也可以并行执行。

下面结合附图2-5对上述解析过程作解释说明。

其中，所述解析系统的页面模型文件得到系统外观元数据的步骤，包括：

解析系统的页面模型文件，获取每个标签描述的内容；

根据每个标签描述的内容，提取系统用例元数据、时序图元数据、页面流图元数据和页面效果预览元数据。

下面结合图3，对上述步骤1011的具体解析过程进行解释说明。

参见图3，图3是页面模型文件的解析过程示意图；如图2所示：

从页面模型文件中<processor/>(过程调用)标签的内容中，提取页面操作功能点名称、操作的实体对象、执行角色、功能描述信息；以及，提取页面操作所调用的业务流程层方法、操作回调方法等信息。这些数据能够为系统设计中的用例图、时序图的绘制和描述提供必要的数据基础。

从页面模型文件中<baseinfo/>(基本信息)标签的内容中,提取页面标题、作者、版本号、功能描述等基本信息。

从页面模型文件中<dataStore/>(数据集)标签的内容中,提取页面关联的实体对象信息列表、包括实体对象名称、类型等信息。

从页面模型文件中<resources/>(资源)标签的内容中,提取页面依赖或引用的其他页面、脚本资源等信息。

从页面模型文件中<controls/>(控件)标签的内容中,提取页面控件及页面布局信息；以及提取页面控件对应的样式信息。

基于从页面模型文件中提取出来的信息，生成系统用例元数据、时序图元数据、页面流图元数据和页面效果预览元数据。

其中，所述解析系统的业务流程操作模型文件得到业务操作流程元数据的步骤，包括：

解析系统的业务流程操作模型文件，获取每个标签描述的内容；

根据每个标签描述的内容，提取用于描述业务流程操作的元数据、用于描述业务流程操作类和类关系的元数据、用于描述业务流程操作时序关系的元数据。

下面结合图4，对上述步骤1012的具体解析过程进行解释说明。

参见图4，图4是业务流程操作模型的解析过程示意图；如图4所示：

从业务流程操作模型文件中<baseinfo/>(基本信息)标签的内容中，提取业务操作实现类及类标题、功能描述等信息。

从业务流程操作模型文件中<class/>(类)标签的内容中，提取业务操作实现类及类标题、功能描述等信息。

从业务流程操作模型文件中<interface/>(接口)标签的内容中,提取业务操作实现类依赖和引用的类资源。

从业务流程操作模型文件中<import/>(导入)标签的内容中，提取业务流程操作类依赖的实体对象。

从业务流程操作模型文件中<method/>(方法)标签的内容中,提取业务操作方法名称、标题、参数、返回值信息以及业务操作方法调用的数据访问层操作方法。

基于从业务流程操作模型文件中提取出来的信息，生成用于描述业务流程操作的元数据、用于描述业务流程操作类和类关系的元数据、用于描述业务流程操作时序关系的元数据。

其中，所述解析数据访问操作模型文件得到数据访问操作元数据的步骤，包括：

解析系统的数据访问操作模型文件，获取每个标签描述的内容；

根据每个标签描述的内容，提取用于描述数据访问操作类的元数据、用于描述数据访问操作时序关系的元数据、用于描述数据访问操作类关联关系的元数据。

参见图5，图5是数据访问操作模型文件的解析过程示意图；如图4所示：

从数据访问操作模型文件<baseinfo/>(基本信息)标签的内容中，提取数据访问操作实现类标题、功能描述等信息。

从数据访问操作模型文件<class/>(类)标签的内容中，提取数据访问操作接口类信息。

从数据访问操作模型文件<interface/>(接口)标签的内容中，提取数据访问操作实现类依赖和引用的类资源等信息。

从数据访问操作模型文件<import/>(导入)标签的内容中，提取数据访问操作类依赖的实体对象等信息。

从数据访问操作模型文件<method/>(方法)标签的内容中，提取数据访问操作方法名称、标题、参数、返回值等信息。

从数据访问操作模型文件<dataSource/>(数据源)标签的内容中，提取数据访问操作方法依赖的数据源信息。

基于数据访问操作模型文件中提取的信息，生成用于描述数据访问操作类的元数据、用于描述数据访问操作时序关系的元数据、用于描述数据访问操作类关联关系的元数据。

其中，所述解析数据实体模型文件得到数据库实体元数据的步骤，包括：

解析系统的数据实体模型文件，获取每个标签描述的内容；

根据每个标签描述的内容，提取用于描述数据库概要设计的元数据、用于描述实体关系图的元数据、用于描述数据实体类的元数据。

参见图6，图6是数据实体模型文件的解析过程示意图；如图6所示：

从数据实体模型文件<class/>(类)标签的内容中，提取数据实体类名、标题等信息。

从数据实体模型文件<title/>(标题)标签的内容中，提取数据实体关联的数据库表等信息。

从数据实体模型文件<table/>(表)标签的内容中，提取实体属性等信息。

从数据实体模型文件<property/>(属性)标签的内容中，提取实体属性、实体关联关系等信息。

从数据实体模型文件<many-to-one/>、<one-to-many/>(多对一、一对多)标签的内容中，提取实体关联关系等信息。

从数据实体模型文件<import/>(导入)标签的内容中，提取实体引用的资源等信息。这些数据为系统设计中的实体图、实体类图、数据库表概要信息提供必要的数据基础。

基于数据实体模型文件中提取的信息，生成用于描述数据库概要设计的元数据、用于描述实体关系图的元数据、用于描述数据实体类的元数据。

通过步骤101的操作已经获得系统设计过程中的元数据，基于这些元数据利用步骤102和步骤103就能够生成对应的设计文档。

步骤102：调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息。

在具体实现时，步骤102可以包括：

根据绘图工具的应用程序编程接口类型，将所述元数据转换成绘图工具可识别的数据格式，以得到绘图元数据；

利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成系统设计图和对应的文字描述信息。

由于，不同的绘图工具支持的数据格式可能不同，因此，不同的绘图工具的应用程序编程接口(Application Program Interface，API)各不相同。这样，利用绘图工具对元数据进行处理时，先需要将元数据转换成绘图工具API可识别的数据格式，然后再调用绘图工具API对数据进行处理以生成系统设计图和对应的文字描述信息。

具体的，基于步骤101解析得到的元数据，可以利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成用例图、时序图、业务流程操作类图、数据访问操作类图、数据实体图、数据库表概要设计图、页面预览效果图及每个图对应的文字描述信息。

进一步地，发明人考虑到基于统一建模语言的绘图工具(UML绘图工具)的绘图性能较好，其可绘制用例图、类图、序列图、状态图、活动图、通信图、模块图、部署图、对象图、以及复合结构图等多种类型图。因此，可选的，在实现步骤102时，可以采用UML绘图工具。考虑到，一些UML绘图工具缺少绘制页面效果预览图的功能，而该页面效果预览图是软件文档设计必不可少的一种图，因此，发明人提出利用浏览器来完成页面效果预览图的功能。

具体的，可以通过以下方式实现：

通过统一建模语言的绘图工具调用所述绘图元数据生成用例图、时序图、业务流程操作类图、数据访问操作类图、数据实体图、数据库表概要设计图及每个图对应的文字描述信息；

通过浏览器界面预览的接口调用所述页面预览元数据，生成页面预览效果图及对应的文字描述信息。

步骤103：将所述系统设计图和对应的文字描述信息映射到预设的文档模板中，以生成设计文档。

在执行步骤102时，可以将生成的系统设计图和文字描述信息以临时文件的形式保存，然后再临时文件中保存的各种系统设计图和对应的文字描述信息导入并映射到预设的文档模块中，最终生成设计文档。

可见：本发明第一方面提供的设计文档生成方法，通过系统的模型文件在开发期沉淀的模型资产，能够快速地实现元数据的解析，再基于解析的元数据和预设的文档模板自动生成设计文档。由于模型文件的良好结构，模型文件在系统开发期就可以将设计过程元数据同步保存下来，因此，本发明借助模型文档的良好结构，就能够快速解析得到设计文档所需的元数据。相比现有技术，本发明避免了在运行期导出设计文档需要人工手动执行系统操作存在的操作复杂、覆盖不全等问题。同时，本发明又突破了现有技术在开发期生成设计文档时存在的解析效率低、设计元数据无法有效沉淀和获取等一系列技术瓶颈。特别是对于功能结构层次交叠、系统规模异常庞大、用户需要频繁变更的大规模应用系统而言，本发明的优势尤其突出。

与本发明提供的方法相对应的，本发明第二方面提供了一种设计文档生成装置，下面对该装置进行解释说明。

参见图7，图7是本发明提供的一种设计文档生成装置，如图7所示，该装置可以包括：

解析单元701，用于解析系统的模型文件得到元数据；

绘图单元702，用于调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息；

映射单元703，用于将所述系统设计图和对应的文字描述信息映射到预设的文档模板中，以生成设计文档。

可选的，如图8所示，所述解析单元701可以包括：

第一解析子单元7011，用于解析系统的页面模型文件得到系统外观元数据；

第二解析子单元7012，用于解析系统的业务流程操作模型文件得到业务操作流程元数据；

第三解析子单元7013，用于解析数据访问操作模型文件得到数据访问操作元数据；

第四解析子单元7014，用于解析数据实体模型文件得到数据库实体元数据。

可选的，如图9所示，所述第一解析子单元7011可以包括：

第一解析模块70111，用于解析系统的页面模型文件，获取每个标签描述的内容；

第一提取模块70112，用于根据每个标签描述的内容，提取系统用例元数据、时序图元数据、页面流图元数据和页面效果预览元数据。

可选的，如图10所示，所述第二解析子单元7012可以包括：

第二解析模块70121，用于解析系统的业务流程操作模型文件，获取每个标签描述的内容；

第二提取模块70122，用于根据每个标签描述的内容，提取用于描述业务流程操作的元数据、用于描述业务流程操作类和类关系的元数据、用于描述业务流程操作时序关系的元数据。

可选的，如图11所示，所述第三解析子单元7013可以包括：

第三解析模块70131，用于解析系统的数据访问操作模型文件，获取每个标签描述的内容；

第三提取模块70132，用于根据每个标签描述的内容，提取用于描述数据访问操作类的元数据、用于描述数据访问操作时序关系的元数据、用于描述数据访问操作类关联关系的元数据。

可选的，如图12所示，所述第四解析子单元7014可以包括：

第四解析模块70141，用于解析系统的数据实体模型文件，获取每个标签描述的内容；

第四提取模块70142，用于根据每个标签描述的内容，提取用于描述数据库概要设计的元数据、用于描述实体关系图的元数据、用于描述数据实体类的元数据。

可选的，如图13所示，所述绘图单元702可以包括：

格式转换子单元7021，用于根据绘图工具的应用程序编程接口类型，将所述元数据转换成绘图工具可识别的数据格式，以得到绘图元数据；

绘制子单元7022，用于利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成系统设计图和对应的文字描述信息。

可选的，所述绘制子单元具体用于：

利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成用例图、时序图、业务流程操作类图、数据访问操作类图、数据实体图、数据库表概要设计图、页面预览效果图及每个图对应的文字描述信息。

可选的，所述绘图工具是基于统一建模语言的绘图工具。

可选的，如图14所示，所述绘图单元702可以包括：

第一绘制子单元7023，用于通过统一建模语言的绘图工具调用所述绘图元数据生成用例图、时序图、业务流程操作类图、数据访问操作类图、数据实体图、数据库表概要设计图及每个图对应的文字描述信息；

第二绘制子单元7024，用于通过浏览器界面预览的接口调用所述页面预览元数据，生成页面预览效果图及对应的文字描述信息。

本发明提供的一种设计文档生成装置，通过解析模型文件为软件文档设计提供必要的数据基础，再利用预设的文档模板结合解析到的数据，自动生成设计文档，这样就能够提高设计文档编写效率，解决现有技术方案存在的手动执行操作复杂、效率低的问题，实现了设计文档的自动化生成过程，特别是对于大规模应用系统而言，本发明的优势尤其突出。

需要说明的是，在本文中，诸如第一和第二等之类的关系术语仅仅用来将一个实体或者操作与另一个实体或操作区分开来，而不一定要求或者暗示这些实体或操作之间存在任何这种实际的关系或者顺序。而且，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括所述要素的过程、方法、物品或者设备中还存在另外的相同要素。

本发明可以在由计算机执行的计算机可执行指令的一般上下文中描述，例如程序模块。一般地，程序模块包括执行特定任务或实现特定抽象数据类型的例程、程序、对象、组件、数据结构等等。也可以在分布式计算环境中实践本发明，在这些分布式计算环境中，由通过通信网络而被连接的远程处理设备来执行任务。在分布式计算环境中，程序模块可以位于包括存储设备在内的本地和远程计算机存储介质中。

以上所述仅是本发明的具体实施方式，应当指出，对于本技术领域的普通技术人员来说，在不脱离本发明原理的前提下，还可以做出若干改进和润饰，这些改进和润饰也应视为本发明的保护范围。

Claims (11)

1.一种设计文档生成方法，其特征在于，所述方法包括:

解析系统的模型文件得到元数据；所述模型文件包括页面模型文件、业务流程操作模型文件、数据访问操作模型文件和数据实体模型文件；其中，所述页面模型文件包括页面展现代码的元数据；所述业务流程操作模型文件包括业务流程操作代码的元数据；所述数据访问操作模型文件包括数据访问操作代码的元数据；所述数据实体模型文件包括数据实体代码的元数据；

调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息；

将所述系统设计图和对应的文字描述信息映射到预设的文档模板中，以生成设计文档。

2.根据权利要求1所述的方法，其特征在于，所述解析系统的模型文件得到元数据的步骤，包括：

解析系统的页面模型文件得到系统外观元数据；

解析系统的业务流程操作模型文件得到业务操作流程元数据；

解析系统的数据访问操作模型文件得到数据访问操作元数据；

解析系统的数据实体模型文件得到数据库实体元数据。

3.根据权利要求2所述的方法，其特征在于，所述解析系统的页面模型文件得到系统外观元数据的步骤，包括

解析系统的页面模型文件，获取每个标签描述的内容；

根据每个标签描述的内容，提取系统用例元数据、时序图元数据、页面流图元数据和页面效果预览元数据。

4.根据权利要求2所述的方法，其特征在于，所述解析系统的业务流程操作模型文件得到业务操作流程元数据的步骤，包括：

解析系统的业务流程操作模型文件，获取每个标签描述的内容；

根据每个标签描述的内容，提取用于描述业务流程操作的元数据、用于描述业务流程操作类和类关系的元数据、用于描述业务流程操作时序关系的元数据。

5.根据权利要求2所述的方法，其特征在于，所述解析数据访问操作模型文件得到数据访问操作元数据的步骤，包括：

解析系统的数据访问操作模型文件，获取每个标签描述的内容；

根据每个标签描述的内容，提取用于描述数据访问操作类的元数据、用于描述数据访问操作时序关系的元数据、用于描述数据访问操作类关联关系的元数据。

6.根据权利要求2所述的方法，其特征在于，所述解析数据实体模型文件得到数据库实体元数据的步骤，包括：

解析系统的数据实体模型文件，获取每个标签描述的内容；

根据每个标签描述的内容，提取用于描述数据库概要设计的元数据、用于描述实体关系图的元数据、用于描述数据实体类的元数据。

7.根据权利要求1所述的方法，其特征在于，所述调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息的步骤，包括：

根据绘图工具的应用程序编程接口类型，将所述元数据转换成绘图工具可识别的数据格式，以得到绘图元数据；

利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成系统设计图和对应的文字描述信息。

8.根据权利要求7所述的方法，其特征在于，所述利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成系统设计图和对应的文字描述信息的步骤：

利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成用例图、时序图、业务流程操作类图、数据访问操作类图、数据实体图、数据库表概要设计图、页面预览效果图及每个图对应的文字描述信息。

9.根据权利要求8所述的方法，其特征在于，

所述绘图工具是基于统一建模语言的绘图工具。

10.根据权利要求9所述的方法，其特征在于，所述调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息的步骤，包括：

通过统一建模语言的绘图工具调用所述绘图元数据生成用例图、时序图、业务流程操作类图、数据访问操作类图、数据实体图、数据库表概要设计图及每个图对应的文字描述信息；

通过浏览器界面预览的接口调用元数据中的页面预览元数据，生成页面预览效果图及对应的文字描述信息。

11.一种设计文档生成装置，其特征在于，所述装置包括:

解析单元，用于解析系统的模型文件得到元数据；所述模型文件包括页面模型文件、业务流程操作模型文件、数据访问操作模型文件和数据实体模型文件；其中，所述页面模型文件包括页面展现代码的元数据；所述业务流程操作模型文件包括业务流程操作代码的元数据；所述数据访问操作模型文件包括数据访问操作代码的元数据；所述数据实体模型文件包括数据实体代码的元数据；

绘图单元，用于调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息；

映射单元，用于将所述系统设计图和对应的文字描述信息映射到预设的文档模板中，以生成设计文档。