CN102495832A - 软件开发过程中文档自动生成系统 - Google Patents

Abstract

本发明公开了一种软件开发过程中文档自动生成系统，包括根据软件模块收集模块名称、模块使用的变量、方法和注释的收集模块，其特征在于，所述系统还包括监视软件模块变更行为的监听模块和将模块名称、模块使用的变量、方法和注释输出形成文档的输出模块，所述输出模块根据监听模块的监听结果对形成的文档进行变更和修改。该系统可以避免项目黑洞，提高项目实施效率；通过文档可以实时监视项目情况，并且可以快速生成项目进度文档等。

Description

软件开发过程中文档自动生成系统

技术领域

本发明涉及一种开发软件中形成文档的系统及方法，尤其涉及一种软件开发过程中文档自动生成系统。

背景技术

大多数项目都是在开发前期做好设计数据字典文档、系统详细设计文档，而往往在项目过程中会出现在临时修改应用结构，导致应用系统与设计文档没有保证一致，为了让项目经理更快更全面的关注开发过程中的文档管理，文档工具很好的解决了这一问题。

设计数据字典文档是基于应用的业务表、维护表，生成应用模块对应的表结构，包括：字段名称、显示名称、主键、数据类型、字段大小等信息。系统详细设计文档是基于系统应用模块，从登录模块开始，生成对应模块的业务表、维护表、流程详细设计文档；其中业务表包含：显示格式、查询设置、关联明细表、表单权限、数据安全、每个表单的截图等详细信息；流程包含：流程图、流程属性、每个流程节点属性、每个流程节点对应表单图、流程节点之间的线条属性等信息。

现在有很多项目追求的快速高效的完成项目开发工作，提高项目开发的开发效率，同时降低开发成本。但在快速开发的同时，对项目的管理就会忽略了，项目经理更多的是关注项目开发的进度，而对项目黑洞往往忽视或无视。

发明内容

针对现有技术中所存在的问题，本发明的目的是提供一种开发效率高、技术实现简单的软件开发过程中文档自动生成系统。

为了解决现有技术中的这些问题，本发明提供的技术方案如下：

一种软件开发过程中文档自动生成系统，包括根据软件模块收集模块名称、模块使用的变量、方法和注释的收集模块，其特征在于，所述系统还包括监视软件模块变更行为的监听模块和将模块名称、模块使用的变量、方法和注释输出形成文档的输出模块，所述输出模块根据监听模块的监听结果对形成的文档进行变更和修改。

在软件开发过程中自动生成的文档系统，用于将开发过程中的数据库业务字段及过程描述信息以及界面定义进行收集按分类整理，其特征在于，所述系统包含设置在应用系统开发时的：

数据字典，用于将数据库中每个业务对象的描述信息通过SQL语句或格式化数据信息键值进行说明，使得所述数据对象清晰记录每个业务标识；和，

详细设计方案，用于将系统中定义的功能界面以及模型画面通过截图以及功能配置界面文字说明的方式进行说明，使得所述应用模型界面清晰记录每个业务功能画面。

优选的，所述数据字典还用于：

将每个业务数据对象的描述显示在系统中，并统一定义业务数据对象的命名规范，以及业务实体的名称一致性，提高业务数据对象信息可读性。系统通过数据库对象sysobjects进行收集整个业务数据系统的对象名称，用sysobjects对象的xtype字段值进行标识对应name值中数据对象的类型(S系统级对象、PK主键名称、P存储过程对象、V视图对象、FN函数对象、U业务表对象)，再通过sp_helptext命令执行生成存储过程、视图、函数对象的记录的sql语句，通过sp_help查看业务表对象有结构信息，然后再业务表所属用户、创建时间、字段名、字段类型、长度、及标识的主键，外键，默认值都按需要收集的信息进行格式化整理。

通过所述对象统一的收集整理方法将数据字典进行Word文件模板文件的输出。

优选的，详细设计方案还用于：

将每个业务功能的设计结果截图显示在系统中，并统一根据业务对象设计原型将页面进行截图处理。系统通过用画布(Tcanvas)对象封装了windows的图形输出功能，图形输出一是夺取屏幕的句柄，二是知道屏幕句柄后获取屏幕的图像。在图形输出时将截取的图形数据信息用image控件保存，应用首先是创建一个BITMAP来存放图像，然后取得屏幕DC，参数0指的是屏幕，创建一个CANVAS对象，最后将屏幕复制到BITMAP中，再释放CANVAS对象和DC对象，将拷贝下的图像赋给image对象，释放BITMAP。被截取的数据对象信息包含应用系统本身的登录页、系统框架主页、以及每个应用功能中设计功能模型form、report、search、dataview、data Access、Data Association，workflow等实体页，都按需要收集的信息进行格式化整理。

通过所述对象统一的收集整理方法将详细设计方案进行Word文件模板文件的输出。

由于现有技术中软件都没有一款针对自己的文档系统。本发明目的在于让项目经理更多的关注开发过程中的文档管理，不管是设计文档还是数据字典文档，都能够有效的参现出来。本发明使用文档系统，可以生成系统模块对应的数据库字典文档和系统详细设计文档。

设计思路：一般软件产品开发，首先要做数据建模，并且要根据实施过程不断修改和完善，同样软件的系统详细设计也是在需求基础上产生。如果能在软件设计过程中，能实时监视整个项目的实施，数据模型的关联等信息，将会给项目管理者减轻很多的工作量，提高工作效率，所以开发了文档自动生成系统。

与现有技术相比，本发明的有益效果为：

(1)可以在文档自动生成系统中快速的随时生成数据字典；(2)可以在文档自动生成系统中快速的随时生成详细设计方案；(3)可以保证系统功能开发与应用软件文档编制同步；(4)根据详细设计方案可以快速转换成交付客户的操作手册。

附图说明

下面结合附图及实施例对本发明作进一步描述：

图1为本发明实施例的软件开发过程中文档自动生成系统进行文档生成的流程图。

具体实施方式

以下结合具体实施例对上述方案做进一步说明。应理解，这些实施例是用于说明本发明而不限于限制本发明的范围。实施例中采用的实施条件可以根据具体厂家的条件做进一步调整，未注明的实施条件通常为常规使用的条件。

实施例

如图1所示是软件开发过程中文档自动生成系统，包括根据软件模块收集模块名称、模块使用的变量、方法和注释的收集模块，所述系统还包括监视软件模块变更行为的监听模块和将模块名称、模块使用的变量、方法和注释输出形成文档的输出模块，所述输出模块根据监听模块的监听结果对形成的文档进行变更和修改。所述收集模块还进行数据库的业务表、维护表、数据接口、流程相关信息进行收集，并将收集的信息由输出模块输出形成word文档。所述收集模块还负责截取开发过程中形成的业务表表单和流程图。

所述系统包含设置在应用系统开发时的：

数据字典，用于将数据库中每个业务对象的描述信息通过SQL语句或格式化数据信息键值进行说明，使得所述数据对象清晰记录每个业务标识；和，

详细设计方案，用于将系统中定义的功能界面以及模型画面通过截图以及功能配置界面文字说明的方式进行说明，使得所述应用模型界面清晰记录每个业务功能画面。

所述数据字典还用于：

将每个业务数据对象的描述显示在系统中，并统一定义业务数据对象的命名规范，以及业务实体的名称一致性，系统通过数据库对象sysobjects进行收集整个业务数据系统的对象名称，用sysobjects对象的xtype字段值进行标识对应name值中数据对象的类型，再通过sp_helptext命令执行生成存储过程、视图、函数对象的记录的sql语句，通过sp_help查看业务表对象有结构信息，然后再业务表所属用户、创建时间、字段名、字段类型、长度、及标识的主键，外键，默认值都按需要收集的信息进行格式化整理；通过所述对象统一的收集整理方法将数据字典进行Word文件模板文件的输出。所述数据对象的类型包括S系统级对象、PK主键名称、P存储过程对象、V视图对象、FN函数对象、U业务表对象。

所述详细设计方案还用于：

将每个业务功能的设计结果截图显示在系统中，并统一根据业务对象设计原型将页面进行截图处理；系统通过用画布(Tcanvas)对象封装了windows的图形输出功能，图形输出一是夺取屏幕的句柄，二是知道屏幕句柄后获取屏幕的图像。在图形输出时将截取的图形数据信息用image控件保存，应用首先是创建一个BITMAP来存放图像，然后取得屏幕DC，参数0指的是屏幕，创建一个CANVAS对象，最后将屏幕复制到BITMAP中，再释放CANVAS对象和DC对象，将拷贝下的图像赋给image对象，释放BITMAP。被截取的数据对象信息包含应用系统本身的登录页、系统框架主页、以及每个应用功能中设计功能模型form、report、search、dataview、data Access、Data Association，workflow实体页，都按需要收集的信息进行格式化整理；通过所述对象统一的收集整理方法将详细设计方案进行Word文件模板文件的输出。

使用软件开发过程中文档自动生成系统进行文档生成时，按照如下步骤进行：

1、查找各模块对应业务表设计字段，并在文档展示

2、查找各模块对应业务表显示字段，并在文档展示

3、收集过程参数列表

4、收集流程对应的表

5、收集流程名称、流程属性

6、收集菜单信息表

7、收集菜单类型

8、收集菜单参数说明

9、收集流程图

10、截登录图(主页)

11、业务表表单截图

12、确定映射表

13、{表显示风格仅树，树加表格}

14、明细表框架结构

15、表格的显示内容查询语句，排序字段，显示字段

16、表的查询字段

17、表的查询表单

18、表的导出设置

19、表的UISCRIPT

20、表的关联表列表

21、关联表名，显示名称，是否显示，级联删除，级联更新，级联添加，添加菜单名称

22、显示格式，表格-＞引用关联表显示格式，表格-＞自定显示内容，表单(表单截图)

23、关联表字段关系

24、表是否有附件

25、表的查询列表条件名，内容，是否默认

26、表的递归设置

27、表单权限

28、表的数据安全

29、表关联的流程

30、流程的属性流程名，表名，标准处理时间，

31、任务主题表达式，启动设置，是否停用

32、流程节点线条信息

33、流程节点说明

34、流程线条说明

35、URL权限说明

36、导出成WORD

本发明的文档生成系统把系统开发过程中所有的设计模型通过WORD文档形式展现出来；根据应用模块，将对应模块下的业务表、维护表、数据接口、流程等相关信息生成文档，自动截取业务表表单、流程图等相关信息。

显然，本领域的技术人员应该明白，上述的本发明的各模块或各步骤可以用通用的计算装置来实现，它们可以集中在单个的计算装置上，或者分布在多个计算装置所组成的网络上，可选地，它们可以用计算装置可执行的程序代码来实现，从而，可以将它们存储在存储装置中由计算装置来执行，或者将它们分别制作成各个集成电路模块，或者将它们中的多个模块或步骤制作成单个集成电路模块来实现。这样，本发明不限制于任何特定的硬件和软件结合。

上述实例只为说明本发明的技术构思及特点，其目的在于让熟悉此项技术的人是能够了解本发明的内容并据以实施，并不能以此限制本发明的保护范围。凡根据本发明精神实质所做的等效变换或修饰，都应涵盖在本发明的保护范围之内。

Claims (5)

1.一种软件开发过程中文档自动生成系统，包括根据软件模块收集模块名称、模块使用的变量、方法和注释的收集模块，其特征在于，所述系统还包括监视软件模块变更行为的监听模块和将模块名称、模块使用的变量、方法和注释输出形成文档的输出模块，所述输出模块根据监听模块的监听结果对形成的文档进行变更和修改。

2.根据权利要求1所述的软件开发过程中文档自动生成系统，其特征在于所述系统包含设置在应用系统开发时的：

数据字典，用于将数据库中每个业务对象的描述信息通过SQL语句或格式化数据信息键值进行说明，使得所述数据对象清晰记录每个业务标识;和，

详细设计方案，用于将系统中定义的功能界面以及模型画面通过截图以及功能配置界面文字说明的方式进行说明，使得所述应用模型界面清晰记录每个业务功能画面。

3.根据权利要求2所述的软件开发过程中文档自动生成系统，其特征在于所述数据字典还用于：

将每个业务数据对象的描述显示在系统中，并统一定义业务数据对象的命名规范，以及业务实体的名称一致性，系统通过数据库对象sysobjects进行收集整个业务数据系统的对象名称，用sysobjects对象的xtype字段值进行标识对应name值中数据对象的类型，再通过sp_helptext命令执行生成存储过程、视图、函数对象的记录的sql语句，通过sp_help查看业务表对象有结构信息，然后再业务表所属用户、创建时间、字段名、字段类型、长度、及标识的主键，外键，默认值都按需要收集的信息进行格式化整理；通过所述对象统一的收集整理方法将数据字典进行Word文件模板文件的输出。

4.根据权利要求3所述的软件开发过程中文档自动生成系统，其特征在于所述数据对象的类型包括S系统级对象、PK 主键名称、P存储过程对象、V视图对象、FN函数对象、U业务表对象。

5.根据权利要求2所述的软件开发过程中文档自动生成系统，其特征在于所述详细设计方案还用于：

将每个业务功能的设计结果截图显示在系统中，并统一根据业务对象设计原型将页面进行截图处理；系统通过用画布(Tcanvas)对象封装了windows的图形输出功能，图形输出一是夺取屏幕的句柄，二是知道屏幕句柄后获取屏幕的图像;在图形输出时将截取的图形数据信息用image控件保存，应用首先是创建一个BITMAP来存放图像，然后取得屏幕DC，参数0指的是屏幕，创建一个CANVAS对象，最后将屏幕复制到BITMAP中，再释放CANVAS对象和DC对象，将拷贝下的图像赋给image对象，释放BITMAP;被截取的数据对象信息包含应用系统本身的登录页、系统框架主页、以及每个应用功能中设计功能模型form、report、search、dataview、data Access、 Data Association，workflow实体页，都按需要收集的信息进行格式化整理；

通过所述对象统一的收集整理方法将详细设计方案进行Word文件模板文件的输出。

Images