[发明专利]用于编制文档的方法

说明书

技术领域

本发明涉及一种用于编制文档的方法、一种关于项目的文档、用于执行该方法的一种计算机程序以及一种计算机程序产品。

背景技术

关于软件产品的动态文档，恰好在较大的编制这种软件产品的小组中具有很重要的意义。利用这种文档，可以避免通常包含其它添加到真正的有效数据中的数据的交流-开销(Overhead)以及可能出现的误解。一种统一而广泛的文档的提供在一种拥有许多方案的产品上目前还是个问题，因为尚未公开任何统一的工具，利用这种统一的工具可以将关于产品的不同的方面合并并且由此提供文档。

发明内容

在这种背景下，介绍了具有独立权利要求所述特征的一种方法、一种文档、一种计算机程序以及一种计算机程序产品。

在按本发明的用于自动编制关于项目的文档的方法中，用配置管理工具将至少一份对所述项目的具有单个架构元素的架构进行描述的架构说明与关于所述架构元素的详细说明组合在一起。

利用这种方法，为所述项目提供了一种综合的文档，所述项目也可以是一种产品。在该文档中汇合了至少一份架构说明或者说至少一份架构信息及详细说明。所述架构元素可以是不同的软件元素如模块、函数、结构体(Struct)、决策树方法(Enum)、应用或者说编程接口(API)、变量、文件、模型、设计信息、文件代码及类似元素。

在编制或开发所述产品例如软件产品时，所述软件元素由于伴随开发过程的修改、修正及传输而发生变化。相应地，所述软件元素可以作为动态的或者说非静态的文件而存在。在编制的相应时刻，该产品的每个软件元素可以分别以自己的版本而存在。这表明，对一些软件元素应该比对其它软件元素进行更深入的或更经常地改动。

配置管理工具可以构造为用于对所有在所述产品内部在不同的时刻以相应不同的版本存在的软件元素进行管理和/或版本监控的工具或程序。利用这种配置管理工具，必要时也在考虑至少一个特定的软件元素的不同版本的情况下按照时间来组织在所述软件元素之间的关联。

为测试产品，有必要对该产品的在特定的时刻最新的总版本进行冻结。在一个特定的在这个时刻静态存在的状态中对该产品进行测试。在此，要对所有在这个时刻以相应最新的版本存在的软件元素加以考虑。其它将来的修改以及由此有待更新的版本则不予考虑。

由此利用所述的配置管理工具可以在相应的时刻自动地提供最新的、与该产品的总版本相匹配的文档。在这种情况下，自动地对来自不同来源或者软件库并且又以不同的版本存在的结构及架构信息进行汇编。对于软件元素不必强制性地考虑最新版本，按要求较旧的版本可能更好地适合于特定的要求。相应地，在整个产品内部，软件元素以至少一个版本存在，其中该软件元素的不同版本与不同的其它的软件元素相互关联或相互作用。

在所述用于编制关于项目的文档的方法中，可以在一种可行的实施方式中用代码生成器生成一个框架，该框架具有至少一份关于该项目的架构说明。通过所述至少一份架构说明，可以描述在架构元素之间的结构关系或关联。此外，可以将关于该项目的单个架构元素的详细说明插入到所述框架中。

此外，详细说明可以与一份或多份架构说明相混合。所述文档的可手动编辑的区域在此可以不加改动地保留。

在所述方法的设计方案中，所述详细说明由所述代码生成器从所述文档或者说框架的第一位置传输到所述文档或者说框架的第二位置，并且必要时在细微的方法改动的情况下插入到或者混合到这个第二位置中。为此，应该将所述详细说明从所述第一位置中剪切或者复制。

此外，可以在所述方法上例如借助于所述代码生成器，为详细说明产生模块。由此额外地方便所述文档的编制或产生。

在执行所述方法时，自动地生成所述文档。此外也提供这一点，即伴随所述项目或产品的开发来执行所述方法。在此，所述文档可以在所述项目的产生过程中至少按时间或按阶段地例如在合适的指定的时刻或者经过合适的指定的时间间隔之后连续地更新。由此编制的或产生的文档与所述项目相匹配并且由此始终是最新的。

在所述方法中，可以为至少一个构造为模块的架构元素在所述文档内部提供一个版本化的及与模板相一致的文件。但是在此也可以为其它的架构元素如函数、结构体或类似架构元素提供所述的文档。

所述方法优选用于编制软件产品的动态文档。在提供一种所述软件产品或者对一种所述软件产品进行编程的同时，可以编制所述文档。由此始终使编程员及开发人员结构化地并且方便清楚地了解软件项目或产品的当前开发状态。