CN101923464A

CN101923464A - Do-178b标准文档生成器

Info

Publication number: CN101923464A
Application number: CN2010101765394A
Authority: CN
Inventors: 王云明
Original assignee: SHANGHAI AVIATION INFORMATION TECHNOLOGY Co Ltd
Current assignee: SHANGHAI AVIATION INFORMATION TECHNOLOGY Co Ltd
Priority date: 2010-05-19
Filing date: 2010-05-19
Publication date: 2010-12-22

Abstract

DO-178B文档生成器属于软件工程自动化领域，其特征在于对多个文档的数据项进行分解和组织，以WEB页面的方式实现对这些文档的编写、修改和查询，并自动地从数据库查询数据项内容、从模板库取出文档格式、生成各类文档。该发明可以从根本上解决原来文档编写中的多重困难，能够实现文档内容的即时更新、保证不同文档内容的一致性、确保各文档内容的完整性、实现了大规模团队进行文档编写的并发工作、避免了文档的冲突、并能满足军方不同格式的要求、减少文档编写的工作量、提高文档编写的效率、节约文档编写的时间。

Description

DO-178B标准文档生成器

技术领域

本发明可以自动生成满足DO-178B标准的航空机载软件研制过程中需要编写的多类文档，属于软件工程自动化工具领域。

背景技术

DO-178B是由RTCA和EUROCAE制定并颁布的国际民用航空机载软件研制和审查的标准。国际上所有民用航空机载软件的研制都需要满足DO-178B标准。与此同时，现在国际上许多军用航空机载软件也是按照DO-178B标准来研制和审查的，如欧洲的A400M，EC 225，美国的C-130J，C-17，以及我国的XXX工程(涉密，不提供名称)等等。

依据DO-178B标准，在软件研制过程中需要编写大量的文档，而且这些文档之间有大量的内容是需要通过协调并维护其一致性的，这需要化费大量的人力和精力。尤其是软件计划过程中需要编写的《软件开发计划》、《软件验证计划》、《软件配置管理计划》、《软件质量保证计划》、《软件审查计划》、《软件需求标准》、《软件设计标准》、《软件编码标准》以及最终软件审查以前需要编写的《软件完成综述》等文档，研制单位在编写过程会有如下问题：

问题一、这些文档有许多重复的内容，例如，在《软件审查计划》和《软件完成综述》中都需要给出系统概述、软件概述、软件级别等内容，而在《软件审查计划》、《软件开发计划》、《软件验证计划》和《软件完成综述》中都会涉及到软件生命周期的定义。这些同样的内容出现在多个不同的文档，但这些内容在文档编制过程又天天在更改，很难维持这些内容在各个文档中的一致性。

问题二、除了上述重复的内容以外，不同文件之间的许多内容是密切关联的。例如，在《软件开发计划》中给出了软件开发的活动和方法，而《软件验证计划》中给出了软件验证的活动和方法。这时要求软件验证活动和方法依赖于软件开发活动和方法，二者必须是配套的、互相一致、水乳交融的。

问题三、由于上面二个原因，编写各个文档的软件开发人员、软件验证人员、软件配置管理人员、软件质量保证人员之间需要大量的协调和信息更新活动。任何一个人都要能随时看到其它人员编写的文档的最新内容，例如，验证人员在编写《软件验证计划》应该能即时地看到开发人员在《软件开发计划》中更改的内容，这对于保证二个计划的一致性，减少返工是至关重要的。虽然可以通过版本管理的工具来实现一定程度上的信息更新，但这样的信息更新不是即时的，导致协调工作的困难。

问题四、在传统的文档编写过程中，还有一个严重的问题是，多个人需要同时修改同一个文件，这样就导致了并行文档编写与文件冲突合并之间的矛盾。例如，有五个软件开发人员在同时编写或修改《软件开发计划》，怎样把每个人所做的修改很好地合并起来而不发生冲突，这是个难题。常见的版本管理工具只能解决其中的一个问题，要么实现一定程度的文档并行编写，但这样会导致大量的文档冲突；要么利用互斥机制来防止文档冲突，但这样又不能实现多个人员的并行编写文档，降低了效率。

问题五、DO-178B标准对这些文档的内容提出了严格的要求，软件研制单位在编写这一系列的文档过程中常常出现顾此失彼的现象，遗漏若干内容从而达不到DO-178B要求。

问题六、还有一个耗费时间非常巨大的“苦力活”，也就是调整各个文档的统一格式。我国军用航空机载软件的研制对每个文件都有严格的格式要求。虽然使用统一的Word和Excel模板会减轻一定的工作量，但文档内容的拷贝粘贴，不同Word和Excel版本带来的格式差异，往往让人苦不堪言。

问题七、一个比问题六更令人头痛的问题，请考虑如下情况：某单位为项目X₁按照格式要求G₁完成的一套文档的编写，并已经得到了相关单位的审查和认可。现在要做另外一个项目X₂，而这个项目要求使用格式G₂，为了重用一部分项目X₁中文档的若干内容，拷贝过来以后还要重做一次繁琐而又没有生产力的格式调整工作。

问题八、几乎每一个文档都有大量的参考文献，术语表等内容，并且文档之间存在大量的引用。每一个引用文档都需要列出其文档编号、文档名称、文档版本、文档作者、发布日期等内容，并保证这些数据的正确性。这需要大量的维护工作，而且一旦基线发生变更(如由于评审、审查等引起的变更)，这些数据需要重新检查和维护。

以上列举的种种问题，使得机载软件研制单位在软件研制之初，就需要化费大量的时间、克服大量的困难来编写这些文档。

本发明致力于从根本上解决上述各项问题。

发明内容

本发明针对以上问题，提出了一个满足DO-178B标准的文档生成器。它可以生成文档包括但不限于：《软件开发计划》、《软件验证计划》、《软件配置管理计划》、《软件质量保证计划》、《软件审查计划》、《软件需求标准》、《软件设计标准》、《软件编码标准》、《软件完成综述》等。

具体地，本发明主要包含四部分的内容：

发明一、本发明通过充分研究DO-178B标准对这些文档的内容的要求，根据长期以来编写这些文档所积累的经验，把这些文档的内容分解成一个个独立的数据项，并通过有效的方式把这些数据项组织起来，不同的人员编写不同的数据项。

通过这一点发明，可以解决如下问题：

●通过数据项的分解和组织，有效地避免了各个文档的内容的冗余，对重复的内容保证了文档内容的一致性(上述问题一)。

●由于数据项的分解和组织是由DO-178B的权威专家来完成的，这保证了数据项的完整性，从根本上避免了内容遗漏的现象(上述问题五)。

发明二、把组织好的数据项通过WEB访问的方式，来进行文档的编写、修改和查询。通过这一点发明，可以解决如下问题：

●通过WEB访问的方式对这些数据项进行编写和修改，有效地实现了文档编写人员的并行工作，并从根本上解决了文档编写冲突的问题，既实现了并行文档编写，也避免了文件冲突(上述问题四)。

●通过WEB访问的方式，还实现了文档信息的即时更新(上述问题三)，任何文档编写的人员都可以看到一秒钟以前其它文档编写人员所做的编写或修改活动。

●通过即时的信息更新，WEB访问的方式可以更好地保证各文档之间相关内容的一致性(上述问题二)。

发明三、自动生成满足DO-178标准，并符合军方规定格式的文档。通过这一点发明，可以解决如下问题：

●由于文档是自动生成的，所以它能保证满足军方对文档格式的要求(上述问题六)，不会出现丝毫的差错，节约了大量的时间；

●结合上述对数据项的分解和组织，通过自动生成文档，不会在任何文档里遗漏DO-178B标准所要求的任何内容，更好地保证了生成的文档能符合DO-178B标准的要求(上述问题五)。

●每次自动生成文档的时候，可以自动地维护每个文档的编号、名称、版本、发布日期等内容，并在被引用的地方自动插入正确的引用信息(上述问题八)

发明四、文档的生成不是使用硬代码的，而是根据给定的模板来生成的。该文档生成器可以使用不同的模板库。通过这一点，可以解决如下问题：

●在文档生成的时候，只需要选用模板库中的另外一套模板，就可以使用相同的内容生成不同格式的文档，以满足不同项目的要求(上述问题七)。

综合上述四条发明内容，本发明的意义在于彻底地解决了背景技术中列出的文档编写过程的各个问题，能够保持编写内容的实时更新、保证不同文档内容的一致性、保证了各文档内容的完整性、实现了大规模团队进行文档编写的并发、避免了文档的冲突、并能保证满足不同格式的要求、减少文档编写的工作量、提高文档编写的效率、节约文档编写的时间。

附图说明

附图中，图1，DO-178B文档生成器结构图，给出了本发明的简易工作流程图，图2，基于WEB的文档编写、修改和查询，给出了多个人员并行工作编写文档的示意图。

具体实施方式

下面按照发明的四点内容分别介绍该发明的实施方式。

发明一、数据的分解和组织

数据的分解要恰到好处，既不能颗粒太粗，导致数据的冗余(有数据的冗余就可能会产生不一致的现象)；又不能颗粒太细，导致数据项管理的不便。

为方便起见，我们假设共有n个文档需要生成，这n个文档的原子数据项集合分别记为X₁，X₂，…X_n。数据项分解的具体算法如下：

第一步：任取二个集合，记为Y和Z

第二步：如果Y∩Z≠Φ，那么去掉Y和Z，加入Y∩Z，Y-Z，Z-Y

第三步：重复第一步和第二步，直到对于任何Y≠Z，都有Y∩Z＝Φ

例：假设要生成三个文档，它们的原子数据项分别为：

{1，2，3，4，5，6}，{1，3，7}，{4，5，3，8}

对第一、第二个集合进行操作，得到：

{1，3}，{2，4，5，6}，{7}，{4，5，3，8}

对第一、第四个集合进行操作，得到：

{3}，{1}，{4，5，8}，{2，4，5，6}，{7}

对第三、第四个集合进行操作，得到：

{4，5}，{8}，{2，6}，{3}，{1}，{7}

至此，对于任意的一组集合Y≠Z，都有Y∩Z＝Φ，算法结束，{4，5}，{8}，{2，6}{3}，{1}，{7}就是我们分解后的数据项。这样，既确保了数据项不会有冗余，也使得数据项具有足够粗的颗粒以方便管理。

经过分解和组织后，每个数据项都会分配唯一的数据项标识。

发明二、基于WEB的数据项编写、修改与查询

基于WEB的B/S架构的软件已经越来越普遍。在本发明中，我们不仅采用了基于WEB页面方式的进行数据项编写、修改与查询，还实现了如下功能：

任务分配：组织了编写文档的团队(软件开发人员、软件验证人员、软件配置管理人员、软件质量保证人员、项目经理、型号总师等)后，我们可以通过一个任务管理子系统把分解和组织后的数据项分配给合适的人员去编写。由于这些数据项经过了良好的分解和组织，保证了在任务分配的时候不会出现数据冲突，而且通过基于WEB的文档编写和修改实现了并发工作。

数据项控制：当某个编写文档的人员登录系统后，文档生成系统会给他显示一个树状结构的数据项组织图。点击一个数据项，如果这个数据项是分配给他编写的，他可以做编写、修改和提交，如果该数据项不是分配给他编写的，他可以查询到别人编写的该数据项的最新信息，从而实现了即时的信息更新。图2给出了多个人并行编写文档的示意图。

发明三、文档生成

文档生成器生成文档的过程分成如下二个步骤：

第一步，数据准备。例如，对每个要生成的文档给出一个新的版本号，记录这次文档生成的日期，自动更新文档的相关属性，生成一个统一的文档引用信息库。

第二步，文档生成。对每个要生成的文档取出其模板，对于模板中使用的数据项，从数据库中查询数据，并插入到文档中相应的位置。数据项是根据其标识来查询的。

发明四、模板的定义和定制

为了方便模板中数据项的替换，并且在替换过程中保留模板的格式，我们采用RTF文件做模板。RTF文档可以很方便的转换成HTML或PDF文件。

模板的定义也是基于WEB页面的，在WEB页面内嵌入了RTF文档的编辑器。使用该编辑器定制文档的格式。

在该WEB页面中也显示了经过分解和组织后的数据项的树状结构。当模板中需要用到某数据项时，可以直接把该数据项拖入到RTF文档编辑器内。拖入后的数据项会自动变成一段包含数据项标识的宏代码。在文档生成的时候，一旦识别到这样的宏代码，就会从数据库查询相应的数据项，插入到相应的位置，并保持其原有的格式。

Claims

1.把DO-178B标准要求编写的《软件开发计划》、《软件验证计划》、《软件配置管理计划》、《软件质量保证计划》、《软件审查计划》、《软件需求标准》、《软件设计标准》、《软件编码标准》、《软件完成综述》等文档进行数据项的分解和组织，有效地消除数据冗余，保证数据的一致性和完整性。

2.把分解和组织好的数据项通过WEB访问的方式进行文档的编写、修改和查询，保证文档编写的并行工作、消除数据冲突现象、实现的文档信息的实时更新。

3.通过数据库查询获得内容，通过模板获得格式，二者结合生成带有指定格式和指定内容的文件。

4.使用RTF文件作为文档模板，在WEB页面中嵌入的RTF编辑器定义格式，在经过分解和组织后的数据项的树状列表中用鼠标拖曳的方法插入数据项。