支持版本迭代的文档管理装置和文档管理方法

摘要

本发明提供了一种支持版本迭代的文档管理装置，包括：子系统数据生成模块，用于生成子系统数据；模块数据生成模块，用于基于所述子系统数据生成模块生成的子系统数据，生成模块数据；树型基本结构生成模块，用于基于所述模块数据生成模块生成的模块数据，生成树型基本结构。本发明还提供了一种支持版本迭代的文档管理方法。通过本发明的技术方案，可以在现有的文档管理支持的迭代方式基础上，充分利用单需求文档完成多需求文档的文档管理，建立多需求文档参与的面向需求文档管理的通用、统一管理思路。

说明书

技术领域

本发明涉及计算机技术领域，具体地，涉及一种支持版本迭代的文档管理装 置和一种支持版本迭代的文档管理方法。

背景技术

在大型软件的开发过程中，每个版本都会根据实际应用的需要增加功能或者 调整功能。这些变动一般都体现在需求文档上。需求文档的质量高低，往往决定某一 版本软件质量的高低。

如果按照软件版本从低到高的顺序排列，那么按照这个软件版本次序排列的 需求文档就能反映出软件功能变更和进化的过程。需求文档体现了软件的核心逻辑， 阅读需求文档是理解系统功能的重要手段。

传统的需求文档是孤立的，基于子系统的，基于版本的，基于文档的。当子 系统负责人需要查询某一程序的某一功能是在哪个版本实现的或者是在哪一个版本 变更的，只有打开所有版本的需求文档，进行逐一查找，这样的缺陷是显而易见的， 那就是效率低下。

传统的基于文档方式的需求文档还有三个弱点。第一个问题是文档的编写受 特定版本文字编辑器的限制，在不同环境中可能打开异常（例如不同操作系统和office 的组合问题），第二就是文档的存放是孤立的，易受丢失，误删除。第三就是跨文档 引用问题。大型软件中跨子系统功能引用是很常见的，在传统的模式下只能是使用“参 见”或者超链接的方式，而使用参见则会存在文档同步到问题，使用超链接的方式则 会存在物理文件访问失效的问题。

因此，一个不依赖于特定文字编辑器的，一个版本可以为基线展现需求变化 的，一个可以整合系统中各个子系统需求文档的，一个可以集中存储的需求文档整合 系统是有必要的。

也就是说，需要一种新的支持版本迭代的文档管理技术，可以在现有的文档 管理支持的迭代方式基础上，充分利用单需求文档完成多需求文档的文档管理，建立 多需求文档参与的面向需求文档管理的通用、统一管理思路。

发明内容

本发明正是基于上述问题，提出了一种新的支持版本迭代的文档管理技术， 可以在现有的文档管理支持的迭代方式基础上，充分利用单需求文档完成多需求文档 的文档管理，建立多需求文档参与的面向需求文档管理的通用、统一管理思路。

有鉴于此，本发明提出了一种支持版本迭代的文档管理装置，包括：子系统 数据生成模块，用于生成子系统数据；模块数据生成模块，用于基于所述子系统数据 生成模块生成的子系统数据，生成模块数据；树型基本结构生成模块，用于基于所述 模块数据生成模块生成的模块数据，生成树型基本结构。在该技术方案中，由于生成 了树型基本结构，可以将文档以最细的颗粒度存贮于树型基本结构的文档管理系统 中，从而实现通过一个需求文档管理系统管理所有的需求文档的目标。

在上述技术方案中，优选地，所述树型基本结构生成模块，具体包括：程序 数据生成模块，用于基于所述模块数据生成模块生成的模块数据，生成程序数据；主 节点数据生成模块，用于基于所述程序数据生成模块生成的程序数据，以程序节点为 主节点，生成该主节点的菜单数据和/或单据数据项数据；业务逻辑生成模块，用于基 于该主节点的菜单数据和/或单据数据项数据，生成相应的业务逻辑。

在上述技术方案中，优选地，所述树型基本结构生成模块，具体还包括：表 体判断模块，用于基于该主节点的菜单数据和/或单据数据项数据，判断该主节点的菜 单数据和/或单据数据项数据是否有表体：若是，则转向明细数据生成模块；否则，转 向从节点数据生成模块；从节点数据生成模块，用于当该主节点的菜单数据和/或单据 数据项数据没有表体、且当程序数据包含子屏幕时，以相应子屏幕为子节点，分别生成 该子节点的菜单数据和/或单据数据项数据；明细数据生成模块，当该主节点的菜单数据 和/或单据数据项数据有表体时，基于该主节点的菜单数据和/或单据数据项数据，生 成相应的明细数据；以及，所述业务逻辑生成模块还用于：基于该子节点的菜单数据 和/或单据数据项数据，生成相应的业务逻辑。

在上述技术方案中，优选地，所述树型基本结构生成模块，具体还包括：过 滤数据生成模块，用于基于所述程序数据生成模块生成的程序数据，当有过滤窗口或 过滤界面时，以程序节点为主节点，生成过滤窗口或过滤界面数据；表数据生成模块， 用于基于所述程序数据生成模块生成的程序数据，当有列表和/或类表时，以程序节点 为主节点，生成列表和/或类表数据；以及，所述业务逻辑生成模块还用于：基于所述 过滤数据生成模块生成的过滤窗口或过滤界面数据，生成相应的业务逻辑；和/或，基 于所述表数据生成模块生成的列表和/或类表数据，生成相应的业务逻辑。在该技术方 案中，可以根据树型基本结构的主节点和从节点，以便将文档以最细的颗粒度存贮于 文档管理系统中，以版本、修改人、功能颗粒等主线，串联文档，以实现多角度的查 询及展现，从而将大型软件系统的不同版本的需求文档整合到一个系统中，并支持按 版本树的追溯。

在上述技术方案中，优选地，所述支持版本迭代的文档管理装置还包括：数 据初始化模块，用于在所述子系统数据生成模块生成子系统数据之前，对用于生成所 述子系统数据的数据进行初始化。

根据本发明的又一个方面，还提出了一种支持版本迭代的文档管理方法，包 括：步骤304：生成子系统数据；步骤306：基于所述步骤304生成的子系统数据， 生成模块数据；步骤308：基于所述步骤306生成的模块数据，生成树型基本结构。 在该技术方案中，由于生成了树型基本结构，可以将文档以最细的颗粒度存贮于树型 基本结构的文档管理系统中，从而实现通过一个需求文档管理系统管理所有的需求文 档的目标。

在上述技术方案中，优选地，所述步骤308，具体包括：步骤402：基于所 述步骤306生成的模块数据，生成程序数据；步骤406：基于所述步骤402生成的程 序数据，以程序节点为主节点，生成该主节点的菜单数据和/或单据数据项数据；步骤 414：基于该主节点的菜单数据和/或单据数据项数据，生成相应的业务逻辑。

在上述技术方案中，优选地，所述步骤308，具体还包括：步骤410：基于 该主节点的菜单数据和/或单据数据项数据，判断该主节点的菜单数据和/或单据数据 项数据是否有表体：若是，则转向步骤416；否则，转向步骤412；步骤412：当该主 节点的菜单数据和/或单据数据项数据没有表体、且当程序数据包含子屏幕时，以相应 子屏幕为子节点，分别生成该子节点的菜单数据和/或单据数据项数据；步骤416：当该 主节点的菜单数据和/或单据数据项数据有表体时，基于该主节点的菜单数据和/或单 据数据项数据，生成相应的明细数据；以及，所述步骤414还包括：基于该子节点的 菜单数据和/或单据数据项数据，生成相应的业务逻辑。

在上述技术方案中，优选地，所述步骤308，具体还包括：步骤404：基于 所述步骤402生成的程序数据，当有过滤窗口或过滤界面时，以程序节点为主节点， 生成过滤窗口或过滤界面数据；步骤408：用于基于所述步骤402生成的程序数据， 当有列表和/或类表时，以程序节点为主节点，生成列表和/或类表数据；以及，所述 步骤414还包括：基于所述步骤404生成的过滤窗口或过滤界面数据，生成相应的业 务逻辑；和/或，基于所述步骤408生成的列表和/或类表数据，生成相应的业务逻辑。 在该技术方案中，可以根据树型基本结构的主节点和从节点，以便将文档以最细的颗 粒度存贮于文档管理系统中，以版本、修改人、功能颗粒等主线，串联文档，以实现 多角度的查询及展现，从而将大型软件系统的不同版本的需求文档整合到一个系统 中，并支持按版本树的追溯。

在上述技术方案中，优选地，在所述步骤304之前，还包括：步骤302：在 所述步骤304生成子系统数据之前，对用于生成所述子系统数据的数据进行初始化。

通过以上技术方案，可以在现有的文档管理支持的迭代方式基础上，充分利 用单需求文档完成多需求文档的文档管理，建立多需求文档参与的面向需求文档管理 的通用、统一管理思路。

附图说明

图1示出了根据本发明的实施例的支持版本迭代的文档管理装置的框图；

图2示出了根据本发明的实施例的树型基本结构生成模块的框图；

图3示出了根据本发明的实施例的支持版本迭代的文档管理方法的流程图；

图4示出了根据本发明的实施例的树型基本结构生成模块的流程图；

图5示出了根据本发明的实施例的支持版本迭代的文档管理装置的操作流程 图；

图6示出了根据本发明的实施例的支持版本迭代的文档管理装置的分支流程 图；

图7示出了根据本发明的实施例的系统用例图；

图8示出了根据本发明的实施例的程序实现的类图。

具体实施方式

为了能够更清楚地理解本发明的上述目的、特征和优点，下面结合附图和具 体实施方式对本发明进行进一步的详细描述。需要说明的是，在不冲突的情况下，本 申请的实施例及实施例中的特征可以相互组合。

在下面的描述中阐述了很多具体细节以便于充分理解本发明，但是，本发明 还可以采用其他不同于在此描述的其他方式来实施，因此，本发明的保护范围并不受 下面公开的具体实施例的限制。

图1示出了根据本发明的实施例的支持版本迭代的文档管理装置的框图。

如图1所示，根据本发明的实施例的支持版本迭代的文档管理装置100，包 括：子系统数据生成模块104，用于生成子系统数据；模块数据生成模块106，用于 基于子系统数据生成模块生成的子系统数据，生成模块数据；树型基本结构生成模块 108，用于基于模块数据生成模块生成的模块数据，生成树型基本结构。在该技术方 案中，由于生成了树型基本结构，可以将文档以最细的颗粒度存贮于树型基本结构的 文档管理系统中，从而实现通过一个需求文档管理系统管理所有的需求文档的目标。

图2示出了根据本发明的实施例的树型基本结构生成模块的框图。

在上述技术方案中，优选地，如图2所示，树型基本结构生成模块108，具 体包括：程序数据生成模块202，用于基于模块数据生成模块生成的模块数据，生成 程序数据；主节点数据生成模块206，用于基于程序数据生成模块生成的程序数据， 以程序节点为主节点，生成该主节点的菜单数据和/或单据数据项数据；业务逻辑生成 模块214，用于基于该主节点的菜单数据和/或单据数据项数据，生成相应的业务逻辑。

在上述技术方案中，优选地，树型基本结构生成模块108，具体还包括：表 体判断模块210，用于基于该主节点的菜单数据和/或单据数据项数据，判断该主节点 的菜单数据和/或单据数据项数据是否有表体：若是，则转向明细数据生成模块216； 否则，转向从节点数据生成模块212；从节点数据生成模块212，用于当该主节点的 菜单数据和/或单据数据项数据没有表体、且当程序数据包含子屏幕时，以相应子屏幕 为子节点，分别生成该子节点的菜单数据和/或单据数据项数据；明细数据生成模块216， 当该主节点的菜单数据和/或单据数据项数据有表体时，基于该主节点的菜单数据和/ 或单据数据项数据，生成相应的明细数据；以及，业务逻辑生成模块214还用于：基 于该子节点的菜单数据和/或单据数据项数据，生成相应的业务逻辑。

在上述技术方案中，优选地，树型基本结构生成模块108，具体还包括：过 滤数据生成模块204，用于基于程序数据生成模块202生成的程序数据，当有过滤窗 口或过滤界面时，以程序节点为主节点，生成过滤窗口或过滤界面数据；表数据生成 模块208，用于基于程序数据生成模块202生成的程序数据，当有列表和/或类表时， 以程序节点为主节点，生成列表和/或类表数据；以及，业务逻辑生成模块214还用于： 基于过滤数据生成模块204生成的过滤窗口或过滤界面数据，生成相应的业务逻辑； 和/或，基于表数据生成模块208生成的列表和/或类表数据，生成相应的业务逻辑。 在该技术方案中，可以根据树型基本结构的主节点和从节点，以便将文档以最细的颗 粒度存贮于文档管理系统中，以版本、修改人、功能颗粒等主线，串联文档，以实现 多角度的查询及展现，从而将大型软件系统的不同版本的需求文档整合到一个系统 中，并支持按版本树的追溯。

在上述技术方案中，优选地，支持版本迭代的文档管理装置还包括：数据初 始化模块102，用于在子系统数据生成模块104生成子系统数据之前，对用于生成子 系统数据的数据进行初始化。

图3示出了根据本发明的实施例的支持版本迭代的文档管理方法的流程图。

如图3所示，根据本发明的实施例的支持版本迭代的文档管理方法，包括： 步骤304：生成子系统数据；步骤306：基于步骤304生成的子系统数据，生成模块 数据；步骤308：基于步骤306生成的模块数据，生成树型基本结构。在该技术方案 中，由于生成了树型基本结构，可以将文档以最细的颗粒度存贮于树型基本结构的文 档管理系统中，从而实现通过一个需求文档管理系统管理所有的需求文档的目标。

图4示出了根据本发明的实施例的树型基本结构生成模块的流程图。

在上述技术方案中，优选地，如图4所示，步骤308，具体包括：步骤402： 基于步骤306生成的模块数据，生成程序数据；步骤406：基于步骤402生成的程序 数据，以程序节点为主节点，生成该主节点的菜单数据和/或单据数据项数据；步骤 414：基于该主节点的菜单数据和/或单据数据项数据，生成相应的业务逻辑。

在上述技术方案中，优选地，步骤308，具体还包括：步骤410：基于该主 节点的菜单数据和/或单据数据项数据，判断该主节点的菜单数据和/或单据数据项数 据是否有表体：若是，则转向步骤416；否则，转向步骤412；步骤412：当该主节点 的菜单数据和/或单据数据项数据没有表体、且当程序数据包含子屏幕时，以相应子屏 幕为子节点，分别生成该子节点的菜单数据和/或单据数据项数据；步骤416：当该主节 点的菜单数据和/或单据数据项数据有表体时，基于该主节点的菜单数据和/或单据数 据项数据，生成相应的明细数据；以及，步骤414还包括：基于该子节点的菜单数据 和/或单据数据项数据，生成相应的业务逻辑。

在上述技术方案中，优选地，步骤308，具体还包括：步骤404：基于步骤 402生成的程序数据，当有过滤窗口或过滤界面时，以程序节点为主节点，生成过滤 窗口或过滤界面数据；步骤408：用于基于步骤402生成的程序数据，当有列表和/或 类表时，以程序节点为主节点，生成列表和/或类表数据；以及，步骤414还包括：基 于步骤404生成的过滤窗口或过滤界面数据，生成相应的业务逻辑；和/或，基于步骤 408生成的列表和/或类表数据，生成相应的业务逻辑。在该技术方案中，可以根据树 型基本结构的主节点和从节点，以便将文档以最细的颗粒度存贮于文档管理系统中， 以版本、修改人、功能颗粒等主线，串联文档，以实现多角度的查询及展现，从而将 大型软件系统的不同版本的需求文档整合到一个系统中，并支持按版本树的追溯。

在上述技术方案中，优选地，在步骤304之前，还包括：步骤302：在步骤 304生成子系统数据之前，对用于生成子系统数据的数据进行初始化。

本申请的技术方案中，本申请技术方案的操作流程图如图5所示、分支流程 图如图6所示、系统用例图如图7所示。

如图7所示，本申请技术方案系统用例的详细说明如下：

⑴基础数据导入。

①按子系统，模块、程序导入数据，生成树型基本结构。

②以程序为基础节点，导入该程序的菜单子节点。

③以程序为基础节点，导入该程序的主数据数据项子节点。

④若程序节点有明细数据，则导入明细数据数据项节点。

⑤若程序节点有过滤条件，则导入过滤条件数据项节点。

⑥若程序节点有导航列表，则导入导航列表数据项节点。

⑦若程序节点含有子屏数据，则循环实现②-④步骤。

⑵数据录入/编辑：

按照基础数据导入阶段生成的数据项节点，录入与该数据项节点对应的详细 需求。详细需求数据包含以下具体内容：

需求内容：需求的具体内容，详细描述需求的定义及需求实现的内容及影响 范围。

需求来源：指出该需求是来自于内部产品定义还是外部客户改进需求，以后 用此数据统计产品的稳定性。

需求版本：按产品的版本输入。以此为线索进行迭代，查询，输出。

需求定义人：提出该需求的人员。后续操作会以此为关键字段进行查询。

需求定义日期：该需求定义的日期，用于分析某个时间段需求数量的分布状 况，进而分析产生需求的原因。

需求引用目标：指出该功能引用的外部需求，一般为需实现的公共功能，可 以通过链接跳转，查询具体内容。

⑶数据输出、查询

①可以根据当前登录用户的权限进行查询，输出作业。

②查询功能。可以按照版本范围、需求来源范围，需求定义人范围，关键数 据项等条件进行组合查询

③输出可以将查询出的资料按指定输出格式，可以选择PDF、HTML、WORD 中的一种格式输出。

本申请技术方案的程序实现的类图如图8所示，数据表如下面的表⑴至表⑹：

⑴过滤数据项表存放过滤数据项资料。

过滤数据项表

Id：主键；

FilterId：过滤的Id；

ProgramId：该过滤对应的程序Id；

Pos：过滤数据项的序号；

DataSource：数据项对应的数据源；

Caption：中文名称。

⑵子屏数据表存放主屏和子屏幕的对照映射关系。

子屏数据表

Id：主键；

ProgramId：主程序Id；

Cardnum：子屏幕模板号；

Caption：中文说明。

⑶列表数据表存放程序列表项数据信息。

列表数据表

Id：主键；

Ckey：列表模板号；

Fieldname：数据项；

Caption：数据项中文说明；

SubId：子系统编号；

ColPos：序号；

Fixed：是否固定列；

HideinColset：是否隐藏列。

⑷数据项表存放数据项显示、控制等信息。

数据项表

AutoId：主键；

TemplateId：模板号；

SortSeq：序号；

CellName：数据项名称；

CellCaption：数据项说明；

IsKey：是否为关键字；

Canmodify：是否可修改；

Visible：是否可见；

DataType：数据类型；

EditType：编辑类型；

IsRequired：是否必输；

IsDisplay：是否显示；

Enums：枚举类型。

⑸需求资料数据表存放最细颗粒度的需求信息。

需求资料数据表

Id：主键；

Remark：需求说明；

UserId：需求创建人；

CreateDate：需求建立日期；

SOurceType：需求来源；

LinkId：需求链接Id。

⑹程序数据表存放程序显示、控制等信息。

程序数据表

Id：主键；

ProgramId：程序Id；

ProgramName：程序名称；

SuperMenuId：上级程序菜单Id；

SubId：子系统Id；

Grade：程序级次；

Iorder：排列次序；

ProgramType：程序类型；

HasChild：是否有子屏幕；

HasFilter：是否有过滤窗口；

HasColumndic：是否有列表数据；

CardNumber：模板号。

本申请的技术方案中，关键语义定义如下：

⑴文档最细颗粒度：文档最细颗粒度是指文档中功能分解到最细的那一层 次。一般特指某一功能的定义或者某一数据发生变化所引起的特定操作或校验逻辑。 例如新增操作就作为一种最细颗粒度，物料编码的变化所引发的校验逻辑以及带值逻 辑也可视为一种最细颗粒度。

⑵版本：版本作为文档的一个重要特性贯穿于整个文档系统中。每个文档最 细颗粒度必然依赖于某一特定版本。

⑶引用：引用是指跨模块，跨子系统的功能引用。一般指本系统或模块实现 其他子系统或模块的功能。例如，生产订单中实现平台提供的工作流功能，则在生产 订单的需求文档中插入对平台工作流功能的引用。引用外部功能时需选择外部功能的 版本，以确定是实现该功能的历任版本的所有功能，还是只实现某一特定版本的功能。

⑷需求来源：需求来源分为外部来源和内部来源。外部来源一般指客户需求。 客户在使用系统的过程中发现的问题，经检查发现为原有逻辑存在缺陷或者为共性问 题，将此问题的解决方案作为需求来源。内部来源为版本规划中定义的需要实现的功 能。可以通过对需求来源的分析来判断上一版本需求定义的质量高低。

⑸输出：按指定条件（版本、修改人、子系统、程序等）通过接口生产指定 格式（html、word、pdf）的需求文档，测试文档。

本申请的技术方案，通过一个需求文档管理系统管理所有的需求文档；可以 以程序节点、版本、需求来源等为主线，单独或组合查找定位需求；生成指定版本、 指定子系统的需求文档、测试文档；可以在文档系统内部实现引用，并能根据引用关 系在一个界面内展示。

本申请的技术方案，将文档以最细的颗粒度存贮于文档管理系统中，以版本、 修改人、功能颗粒等主线，串联文档，以实现多角度的查询及展现，从而将大型软件 系统的不同版本的需求文档整合到一个系统中，并支持按版本树的追溯。本申请的技 术方案，不依赖于特定文字编辑器，可以以版本为基线展现需求变化，可以整合系统 中各个子系统需求文档，可以对需求文档进行集中存储和整合。

以上结合附图详细说明了本发明的技术方案，考虑到相关技术中没有简便 的、统一的针对多需求文档管理的解决办法。现有的文档管理无法完成有多需求文档 参与的文档管理过程。因此，本发明提出了一种支持版本迭代的文档管理装置和一种 支持版本迭代的文档管理方法，可以在现有的文档管理支持的迭代方式基础上，充分 利用单需求文档完成多需求文档的文档管理，建立多需求文档参与的面向需求文档管 理的通用、统一管理思路。

以上所述仅为本发明的优选实施例而已，并不用于限制本发明，对于本领域 的技术人员来说，本发明可以有各种更改和变化。凡在本发明的精神和原则之内，所 作的任何修改、等同替换、改进等，均应包含在本发明的保护范围之内。