一种设计文档生成方法及装置制造方法及图纸

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

【技术实现步骤摘要】

本专利技术涉及软件开发
，特别是涉及一种设计文档生成方法及装置。
技术介绍
近年来，软件行业所面临的主要矛盾仍就是不断增长、日益复杂的用户需求与落后的软件生产力之间的矛盾。特别是随着云计算、大数据、移动互联网等新技术、新业态的出现，这一矛盾尤其突出，具体表现在产品开发效率低下、开发成本和进度失控等等。设计文档是贯穿软件开发、软件应用过程的重要资料，其编写和维护通常需要投入大量的人力成本，因此设计文档的编写效率是影响软件开发时间、开发成本的重要因素。现有的设计文档生成方案主要是在软件运行期通过手动操作执行业务系统的方式实现，一种方式是在系统执行过程中，手动操作系统各功能点，记录系统各功能点的元数据，通过分析元数据并根据文档模板导出设计文档。另一种方式是通过保留系统原版本及原版本对应的设计文档，通过手动操作执行更新后的业务系统，获取更新版本中变化的元数据，根据变化的元数据增量修改原版本对应的设计文档。综上所述，现有的设计文档生成方案存在的主要问题:(I)只能在系统运行期生成设计文档，开发期阶段当系统尚未开发完成时无法实时、有效的获取当前系统所对应的设计文档。(2)必须手动操作执行系统所有功能点，不仅操作过程繁琐且覆盖不全面，而且效率低，特别的对于大规模应用系统而言，这种实现方式是相当耗时。随着用户需求的不断变化以及软件规模日益庞大等问题的出现，现有方案已经难以满足当前大规模软件系统快速开发和交付的需要。
技术实现思路
为了解决上述技术问题，本专利技术提供了一种设计文档生成方法及装置，能够面向软件开发过程的任何一个时期，最重要的是，能够面向软件开发期，无需手动操作系统功能点，而自动地生成设计文档。本专利技术第一方面提供了一种设计文档生成方法，所述方法包括:解析系统的模型文件得到元数据；调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息；将所述系统设计图和对应的文字描述信息映射到预设的文档模板中，以生成设计文档。可选的，所述解析系统的模型文件得到元数据的步骤，包括:解析系统的页面模型文件得到系统外观元数据；解析系统的业务流程操作模型文件得到业务操作流程元数据；解析数据访问操作模型文件得到数据访问操作元数据；解析数据实体模型文件得到数据库实体元数据。可选的，所述解析系统的页面模型文件得到系统外观元数据的步骤，包括解析系统的页面模型文件，获取每个标签描述的内容；根据每个标签描述的内容，提取系统用例元数据、时序图元数据、页面流图元数据和页面效果预览元数据。可选的，所述解析系统的业务流程操作模型文件得到业务操作流程元数据的步骤，包括:解析系统的业务流程操作模型文件，获取每个标签描述的内容；根据每个标签描述的内容，提取用于描述业务流程操作的元数据、用于描述业务流程操作类和类关系的元数据、用于描述业务流程操作时序关系的元数据。可选的，所述解析数据访问操作模型文件得到数据访问操作元数据的步骤，包括:解析系统的数据访问操作模型文件，获取每个标签描述的内容；根据每个标签描述的内容，提取用于描述数据访问操作类的元数据、用于描述数据访问操作时序关系的元数据、用于描述数据访问操作类关联关系的元数据。可选的，所述解析数据实体模型文件得到数据库实体元数据的步骤，包括:解析系统的数据实体模型文件，获取每个标签描述的内容；根据每个标签描述的内容，提取用于描述数据库概要设计的元数据、用于描述实体关系图的元数据、用于描述数据实体类的元数据。可选的，所述调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息的步骤，包括:根据绘图工具的应用程序编程接口类型，将所述元数据转换成绘图工具可识别的数据格式，以得到绘图元数据；利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成系统设计图和对应的文字描述信息。可选的，所述利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成系统设计图和对应的文字描述信息的步骤:利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成用例图、时序图、业务流程操作类图、数据访问操作类图、数据实体图、数据库表概要设计图、页面预览效果图及每个图对应的文字描述信息。可选的，所述绘图工具是基于统一建模语言的绘图工具。可选的，所述调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息的步骤，包括:通过统一建模语言的绘图工具调用所述绘图元数据生成用例图、时序图、业务流程操作类图、数据访问操作类图、数据实体图、数据库表概要设计图及每个图对应的文字描述信息；通过浏览器界面预览的接口调用所述页面预览元数据，生成页面预览效果图及对应的文字描述信息。本专利技术第二方面提供了一种设计文档生成装置，所述装置包括:解析单元，用于解析系统的模型文件得到元数据；绘图单元，用于调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息；映射单元，用于将所述系统设计图和对应的文字描述信息映射到预设的文档模板中，以生成设计文档。可选的，所述解析单元包括:第一解析子单元，用于解析系统的页面模型文件得到系统外观元数据；第二解析子单元，用于解析系统的业务流程操作模型文件得到业务操作流程元数据；第三解析子单元，用于解析数据访问操作模型文件得到数据访问操作元数据；第四解析子单元，用于解析数据实体模型文件得到数据库实体元数据。可选的，所述第一解析子单元包括:第一解析模块，用于解析系统的页面模型文件，获取每个标签描述的内容；第一提取模块，用于根据每个标签描述的内容，提取系统用例元数据、时序图元数据、页面流图元数据和页面效果预览元数据。可选的，所述第二解析子单元包括:第二解析模块，用于解析系统的业务流程操作模型文件，获取每个标签描述的内容；第二提取模块，用于根据每个标签描述的内容，提取用于描述业务流程操作的元数据、用于描述业务流程操作类和类关系的元数据、用于描述业务流程操作时序关系的元数据。可选的，第三解析子单元包括:第三解析模块，用于解析系统的数据访问操作模型文件，获取每个标签描述的内容；第三提取模块，用于根据每个标签描述的内容，提取用于描述数据访问操作类的元数据、用于描述数据访问操作时序关系的元数据、用于描述数据访问操作类关联关系的元数据。可选的，所述第四解析子单元包括:第四解析模块，用于解析系统的数据实体模型文件，获取每个标签描述的内容；第四提取模块，用于根据每个标签描述的内容，提取用于描述数据库概要设计的元数据、用于描述实体关系图的元数据、用于描述数据实体类的元数据。可选的，所述绘图单元包括:格式转换子单元，用于根据绘图工具的应用程序编程接口类型，将所述元数据转换成绘图工具可识别的数据格式，以得到绘图元数据；绘制子单元，用于利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成系统设计图和对应的文字描述信息。可选的，所述绘制子单元具体用于:利用绘图工具的应用程序编程接口调用所述绘图元数据，以生成用例图、时序图、业务流程操作类图、数据访问操作类图、数据实体图、数据库表概要设计图、页面预览效果图及每个图对应的文字描述信息。可选的，所述绘图工具是基于统一建模语言的绘图工具。可选的，所述绘图单元包括:第一绘制子单元，用于通过统一建模语言的绘图工具调用所述绘图元数据生成用例图、时序图、业务流程操作类图、数据访问操作类图、本文档来自技高网...

【技术保护点】
一种设计文档生成方法，其特征在于，所述方法包括:解析系统的模型文件得到元数据；调用绘图工具处理所述元数据，以生成系统设计图和对应的文字描述信息；将所述系统设计图和对应的文字描述信息映射到预设的文档模板中，以生成设计文档。

【技术特征摘要】

【专利技术属性】
技术研发人员：谢新强，张德阳，周进刚，
申请(专利权)人：东软集团股份有限公司，
类型：发明
国别省市：辽宁;21