一种适配于软件的用户文档生成方法及系统与流程

本发明涉及数据处理技术领域，特别涉及一种适配于软件的用户文档生成方法及系统。

背景技术：

程序和文档均作为软件的交付物，共同体现了软件所实现的功能。程序是软件的主体，文档是软件的附属物，不是所有的用户都需要文档，但文档对某些用户是至关重要的。文档是软件不可或缺的一部分，因此文档开发流程的规范、质量的提升是非常重要的。一些维护类的文档，可以减少软件产品后期的运维成本；一些操作类的文档，可以减少软件产品的培训成本。

在当今的信息化时代，随着软件复杂度的逐步增加，需要交付的文档种类和内容也越来越多。而现有文档仅在软件完成后进行编写，会造成文档开发效率低，不能体现产品功能亮点等。因此如何提高文档开发效率以及文档质量，是本领域技术人员需要解决的技术问题。

技术实现要素：

本发明的目的是提供一种适配于软件的用户文档生成方法及系统，将用户文档生成进行归类分解，融入到软件开发的流程中，每个阶段都实现迭代模式，提高文档开发效率以及文档质量。

为解决上述技术问题，本发明提供一种适配于软件的用户文档生成方法，所述方法包括：

根据集成产品开发流程将文档开发操作分解为各预定阶段；其中，所述预定阶段包括计划阶段，开发阶段以及交付阶段；

当文档处于计划阶段时，根据输入的软件任务内容确定项目输出计划文档初稿，并将所述计划文档初稿发送给计划审核终端以使对应审核人员进行评审，并在评审通过后输出计划文档定稿；

当文档处于开发阶段时，接收各个开发人员发送的所负责任务的进度文档初稿，将所述进度文档初稿发送给开发审核终端以使对应审核人员对接收到的所述进度文档初稿进行评审，在评审通过后进行测试，并在测试通过后输出进度文档定稿；其中，根据所述计划文档定稿确定各个开发人员的任务；

当文档处于交付阶段时，汇总所述进度文档定稿得到交付文档，将所述交付文档发送给交付审核终端以使对应审核人员对所述交付文档进行评审，在评审通过后进行测试，并在测试通过后输出归档文档定稿。

可选的，在测试通过后输出归档文档定稿，包括：

在测试通过后将所述归档文档定稿保存到指定目录，并为所述指定目录分配特定的读取权限。

可选的，所述预定阶段还包括更新文档阶段；当文档处于更新文档阶段时，收集选定客户的反馈文档，并根据所述反馈文档对所述归档文档定稿进行评审，在评审通过后进行测试，并在测试通过后输出更新归档文档定稿。

可选的，对接收到的所述进度文档初稿进行评审，包括：

对接收到的所述进度文档初稿进行至少两次评审，直到所有问题均通过评审。

可选的，在测试通过后输出进度文档定稿，包括：

对测试通过后的文档进行回归测试，并在回归测试通过后输出进度文档定稿。

本发明还提供一种适配于软件的用户文档生成系统，所述系统包括：

阶段分解阶段，用于根据集成产品开发流程将文档开发操作分解为预定阶段；其中，所述预定阶段包括计划阶段，开发阶段以及交付阶段；

计划阶段模块，用于当文档处于计划阶段时，根据输入的软件任务内容确定项目输出计划文档初稿，并将所述计划文档初稿发送给计划审核终端以使对应审核人员进行评审，并在评审通过后输出计划文档定稿；

开发阶段模块，用于当文档处于开发阶段时，接收各个开发人员发送的所负责任务的进度文档初稿，将所述进度文档初稿发送给开发审核终端以使对应审核人员对接收到的所述进度文档初稿进行评审，在评审通过后进行测试，并在测试通过后输出进度文档定稿；其中，根据所述计划文档定稿确定各个开发人员的任务；

交付阶段模块，用于当文档处于交付阶段时，汇总所述进度文档定稿得到交付文档，将所述交付文档发送给交付审核终端以使对应审核人员对所述交付文档进行评审，在评审通过后进行测试，并在测试通过后输出归档文档定稿。

可选的，所述交付阶段模块包括：

存储单元，用于在测试通过后将所述归档文档定稿保存到指定目录，并为所述指定目录分配特定的读取权限。

可选的，该方法还包括：

更新文档阶段模块，用于当文档处于更新文档阶段时，收集选定客户的反馈文档，并根据所述反馈文档对所述归档文档定稿进行评审，在评审通过后进行测试，并在测试通过后输出更新归档文档定稿。

可选的，所述开发阶段模块包括：

评审单元，用于对接收到的所述进度文档初稿进行至少两次评审，直到所有问题均通过评审。

可选的，所述开发阶段模块包括：

回归测试单元，用于对测试通过后的文档进行回归测试，并在回归测试通过后输出进度文档定稿。

本发明所提供的一种适配于软件的用户文档生成方法，包括：根据集成产品开发流程将文档开发操作分解为各预定阶段；当文档处于计划阶段时，完成根据输入的软件任务内容确定项目输出计划文档初稿并对其进行评审输出计划文档定稿；当文档处于开发阶段时，完成对各个开发人员的进度文档初稿进行评审、测试，实现迭代模式获取进度文档定稿；当文档处于交付阶段时，完成汇总进度文档定稿得到交付文档并对其进行评审，测试，并在测试通过后输出归档文档定稿。即将用户文档生成进行归类分解，融入到软件开发的流程中，每个阶段都实现迭代模式，使得文档人员有计划有目的的在产品的每个阶段输出对应的文档，且经过评审和测试，保证文档的质量。本发明所提供的一种适配于软件的用户文档生成系统，具有上述有益效果，在此不再赘述。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据提供的附图获得其他的附图。

图1为本发明实施例所提供的适配于软件的用户文档生成方法的流程图；

图2为本发明实施例所提供的一种具体的适配于软件的用户文档生成流程示意图；

图3为本发明实施例所提供的适配于软件的用户文档生成系统的结构框图。

具体实施方式

本发明的核心是提供一种适配于软件的用户文档生成方法及系统，将用户文档生成进行归类分解，融入到软件开发的流程中，每个阶段都实现迭代模式，提高文档开发效率以及文档质量。

为使本发明实施例的目的、技术方案和优点更加清楚，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

在当今的信息化时代，随着软件复杂度的逐步增加，需要交付的文档种类和内容也越来越多，因此合理的开发流程，能够提高文档开发的效率；关键动作的制定，能够提升文档开发的质量。而高效高质量的交付文档，可以减少不必要的维护成本、沟通成本等，也能够最大化的体现软件产品的功能亮点等信息。具体请参考图1，图1为本发明实施例所提供的适配于软件的用户文档生成方法的流程图；该方法可以包括：

s100、根据集成产品开发流程将文档开发操作分解为各预定阶段；其中，预定阶段包括计划阶段，开发阶段以及交付阶段。

具体的，文档和程序一样重要，因此也需要计划、计划评审、开发、评审、测试、交付这么一整套完整的管理流程以便提高文档开发效率以及文档质量。该步骤的主要目的是结合目前流行的集成产品开发ipd产品开发流程，将用户文档(后续简称为文档)开发动作分解(即文档开发操作)，融入ipd流程中。

本实施例并不限定预定阶段的数量，其可以是根据用户分解的详细情况进行确定。一般情况下大致可以包括计划阶段，开发阶段以及交付阶段。当然用户还可以在此基础上进行细化。

s110、当文档处于计划阶段时，根据输入的软件任务内容确定项目输出计划文档初稿，并将计划文档初稿发送给计划审核终端以使对应审核人员进行评审，并在评审通过后输出计划文档定稿。

具体的，在本阶段可以包括任务书开发阶段，即根据输入的软件任务内容确定项目输出计划文档初稿。例如文档人员可以根据软件任务内容参与和文档相关的内容讨论、确定。还可以包括任务书审核阶段，即将计划文档初稿发送给计划审核终端以使对应审核人员进行评审。例如文档人员可以参与软件项目计划的评审等动作，即需要根据任务书和项目计划输出文档交付清单和计划，并发送相关负责人评审，并在评审通过后输出计划文档定稿。

进一步，本实施例并不限定评审的具体次数。可以是经过一个人评审通过即可，也可以是为了提高评审可靠性，可以进行多次评审。即可以进行n轮评审，直至所有问题均通过。进一步为了提高评审效率可以将需要评审的内容进行模块划分，各模块负责人评审各模块的内容。实现计划阶段的迭代从而提高效率。

s120、当文档处于开发阶段时，接收各个开发人员发送的所负责任务的进度文档初稿，将进度文档初稿发送给开发审核终端以使对应审核人员对接收到的进度文档初稿进行评审，在评审通过后进行测试，并在测试通过后输出进度文档定稿；其中，根据计划文档定稿确定各个开发人员的任务。

其中，各个开发人员所负责的任务可以是根据计划文档定稿确定。

具体的，本实施例将开发阶段按照开发的进度与各个开发人员相挂钩，且对每个开发人员的进度文档初稿都需要进行评审和测试，从而实现在开发过程中的迭代处理流程，提高效率。即根据开发人员和测试人员的进度，输出部分文档，将文档的编写、评审、测试融合到迭代流程里。

这里的迭代可以理解为两个层次，首先是每个开发人员都可以对其负责的项目任务进行进度文档初稿的撰写(实现对整个软件的划分迭代)。其次测试人员和开发人员还可以进一步将各自对应的内容再次进行更小单元的划分(实现各部分人员内部的迭代过程)。

进一步，本实施例并不限定评审的具体次数。可以是经过一个人评审通过即可，也可以是为了提高评审可靠性，可以进行多次评审。即可以进行n轮评审，直至所有问题均通过，才能进入测试阶段。这里的测试可以是测试团队统一分配测试任务，进行细化测试。进一步为了提高测试效果，对测试通过后的文档进行回归测试，并在回归测试通过后输出进度文档定稿。

s130、当文档处于交付阶段时，汇总进度文档定稿得到交付文档，将交付文档发送给交付审核终端以使对应审核人员对交付文档进行评审，在评审通过后进行测试，并在测试通过后输出归档文档定稿。

具体的，该步骤即输出软件产品相关的所有文档，将文档的编写、评审、测试融合到迭代流程里。最终将总的文档再次进行评审、测试。进一步，本实施例并不限定评审的具体次数。可以是经过一个人评审通过即可，也可以是为了提高评审可靠性，可以进行多次评审。即可以进行n轮评审，直至所有问题均通过，才能进入测试阶段。这里的测试可以是测试团队统一分配测试任务，进行细化测试。进一步为了提高测试效果，对测试通过后的文档进行回归测试，并在回归测试通过后输出归档文档定稿。

其中，在测试通过后输出归档文档定稿可以包括：在测试通过后将归档文档定稿保存到指定目录，并为指定目录分配特定的读取权限。即将前期输出的文档作为交付件进行正式交付、归档到指定目录，分配特定的读取权限。本实施例并不对交付格式进行限定，交付件的格式需要在前期和项目组负责人达成一致，按讨论结果交付。且需控制文档权限，每本文档对应的使用角色是不一样的，必须严格把控。

其中，本实施例并不限定计划审核终端、开发审核终端以及交付审核终端的数量。例如上述各类终端可以与相应的审核人员(审核人员可以包括评审人员和测试人员)进行对应(例如一对一，或者一对多)。

基于上述技术方案，本方法实施例提供的适配于软件的用户文档生成方法，将软件产品相关的交付文档进行归类分解，融入到软件开发流程中。在产品的开发过程中，每类文档的编写、评审、测试实行迭代模式，使得文档人员有计划有目的的在产品的每个阶段输出对应的文档，且经过评审和测试，保证文档的质量。

基于上述实施例，为了保证文档在软件产品的整个生命周期内的可靠性，本实施例中预定阶段还包括更新文档阶段；当文档处于更新文档阶段时，收集选定客户的反馈文档，并根据反馈文档对归档文档定稿进行评审，在评审通过后进行测试，并在测试通过后输出更新归档文档定稿。

其中，本实施例并不对选定客户进行限定，可以广义的理解为发送反馈意见的客户都为选定客户。

具体的，即针对后期的一些特定客户现场测试、各角色使用文档后反馈的一些建议意见等有价值的信息，更新维护文档，同时对文档进行评审、测试、交付、归档。进一步还可以在软件产品的生命周期内，定期维护更新归档文档定稿。

即上述过程中文档的质量可以通过评审n+测试(即n是大于0的整数，表示评审的次数不限，可以进行n轮评审，直至所有问题均通过，才能进入测试阶段，其中，可以由测试团队统一分配测试任务)，以及每个阶段的所有输出的文档及各个版本均需进行评审和测试来保证。可以通过各模块负责人评审各模块的内容来提高评审效率。

请参考图2，给出了一种具体的分解例子，通过该过程来对上述实施例进行说明：

在tr1阶段，即任务书开发阶段，文档人员可以参与和文档相关的内容讨论、确定。

在tr2阶段，即项目计划输出阶段，文档人员可以参与计划的评审等动作。

在tr3阶段，文档人员需要根据任务书和项目计划输出文档交付清单和计划，并发送相关负责人评审、定稿。

在tr4阶段，根据开发人员和测试人员的进度，输出部分文档，将文档的编写、评审、测试融合到迭代流程里。

在tr5阶段，输出产品相关的所有文档，将文档的编写、评审、测试融合到迭代流程里。

在tr6阶段，将前期输出的文档作为交付件进行正式交付、归档到指定目录，分配特定的读取权限。

在ga阶段(即交付阶段)，针对后期的一些特定客户现场测试、各角色使用文档后反馈的一些建议意见等，更新维护文档，同时对文档进行评审、测试、交付、归档。并在在产品的生命周期内，定期维护更新文档。

下面对本发明实施例提供的适配于软件的用户文档生成系统进行介绍，下文描述的适配于软件的用户文档生成系统与上文描述的适配于软件的用户文档生成方法可相互对应参照。

请参考图3，图3为本发明实施例所提供的适配于软件的用户文档生成系统的结构框图；该系统可以包括：

阶段分解阶段100，用于根据集成产品开发流程将文档开发操作分解为预定阶段；其中，预定阶段包括计划阶段，开发阶段以及交付阶段；

计划阶段模块200，用于当文档处于计划阶段时，根据输入的软件任务内容确定项目输出计划文档初稿，并将计划文档初稿发送给计划审核终端以使对应审核人员进行评审，并在评审通过后输出计划文档定稿；

开发阶段模块300，用于当文档处于开发阶段时，接收各个开发人员发送的所负责任务的进度文档初稿，将进度文档初稿发送给开发审核终端以使对应审核人员对接收到的进度文档初稿进行评审，在评审通过后进行测试，并在测试通过后输出进度文档定稿；其中，根据计划文档定稿确定各个开发人员的任务；

交付阶段模块400，用于当文档处于交付阶段时，汇总进度文档定稿得到交付文档，将交付文档发送给交付审核终端以使对应审核人员对交付文档进行评审，在评审通过后进行测试，并在测试通过后输出归档文档定稿。

基于上述实施例，交付阶段模块400可以包括：

存储单元，用于在测试通过后将归档文档定稿保存到指定目录，并为指定目录分配特定的读取权限。

基于上述任意实施例，该系统还可以包括：

更新文档阶段模块，用于当文档处于更新文档阶段时，收集选定客户的反馈文档，并根据反馈文档对归档文档定稿进行评审，在评审通过后进行测试，并在测试通过后输出更新归档文档定稿。

基于上述任意实施例，开发阶段模块300可以包括：

评审单元，用于对接收到的进度文档初稿进行至少两次评审，直到所有问题均通过评审。

基于上述任意实施例，开发阶段模块300可以包括：

回归测试单元，用于对测试通过后的文档进行回归测试，并在回归测试通过后输出进度文档定稿。

说明书中各个实施例采用递进的方式描述，每个实施例重点说明的都是与其他实施例的不同之处，各个实施例之间相同相似部分互相参见即可。对于实施例公开的装置而言，由于其与实施例公开的方法相对应，所以描述的比较简单，相关之处参见方法部分说明即可。

专业人员还可以进一步意识到，结合本文中所公开的实施例描述的各示例的单元及算法步骤，能够以电子硬件、计算机软件或者二者的结合来实现，为了清楚地说明硬件和软件的可互换性，在上述说明中已经按照功能一般性地描述了各示例的组成及步骤。这些功能究竟以硬件还是软件方式来执行，取决于技术方案的特定应用和设计约束条件。专业技术人员可以对每个特定的应用来使用不同方法来实现所描述的功能，但是这种实现不应认为超出本发明的范围。

结合本文中所公开的实施例描述的方法或算法的步骤可以直接用硬件、处理器执行的软件模块，或者二者的结合来实施。软件模块可以置于随机存储器(ram)、内存、只读存储器(rom)、电可编程rom、电可擦除可编程rom、寄存器、硬盘、可移动磁盘、cd-rom、或技术领域内所公知的任意其它形式的存储介质中。

以上对本发明所提供的一种适配于软件的用户文档生成方法及系统进行了详细介绍。本文中应用了具体个例对本发明的原理及实施方式进行了阐述，以上实施例的说明只是用于帮助理解本发明的方法及其核心思想。应当指出，对于本技术领域的普通技术人员来说，在不脱离本发明原理的前提下，还可以对本发明进行若干改进和修饰，这些改进和修饰也落入本发明权利要求的保护范围内。