DevOps 下的文档及其版本管理之实战

1 前言

在上一篇《 DevOps 下的文档及其版本管理之设计篇》中简要介绍了文档及其版本管理的设计思路，该篇将讲述其实际操作部分的内容。上篇文章中讲到文档信息保存在两个地方，一个是工作项，另一个是文档资源库，其中工作项指在软件生命周期中用户在天梯平台上创建的从需求、开发、测试、发布到运维等任务卡片信息。

2 工作项

根据软件的全生命周期，用户在天梯平台上可以创建如下类型的工作项：版本、迭代、需求、任务，其中需求包括用户故事、缺陷和技术故事，任务包括研发任务、测试任务、Bug、设计任务和实施任务。用户可以根据自己的需求在天梯上创建不同的工作项，同时上传不同类型的文档，天梯平台支持单个和多个文档上传。

用户新建工作项时，填写创建工作项所需的字段信息，包括工作项名称、负责人、完成时间等。用户可以在天梯平台配置每个工作项所拥有的字段，该操作给用户提供了极大的便利。创建工作项的同时，用户可以选择上传与该工作项相关联的文档，并选择文档类型和文档保存目录，其中文档类型是用户在工作项下配置的对应文档类型，保存目录是文档资源库的目录。

工作项创建成功后会显示上传文档的信息，同时，该文档会自动保存到文档资源库中。文档保存到工作项后，用户可以点击文件名进行下载，文档名保持不变。若想取消文档关联到工作项，可以点击文档后的叉号，删除成功后文档信息就消失了。工作项上的文档删除只是取消了文档与工作项的关联关系，文档并没有实际删除，文档资源库内还可以显示，只是没有了关联到工作项的关联关系，若要彻底删除文档，需要在文档资源库进行删除，这样工作项和文档资源库内都不会显示该文档了。

3 文档资源库

第2节中已介绍当在卡片工作项上传文档后，文档都会保存到文档资源库中，这是卡片工作项与文档资源库进行关联，同时在文档资源库上传文件也可以与卡片工作项进行关联，即在文档资源库上传文件时，选择卡片上的具体工作项，上传成功后文档的信息就会显示在卡片工作项上。在文档资源库上传文件可以关联所有类型的工作项。

3.1 上传文件

在文档资源库上传新文件时，选择上传的文档，并填写文档的类型、文档关联的工作项以及文档保存的目录，如下图所示：

文档上传成功后，文档资源库新目录1下显示该文档，如下图所示：

同时，工作项“文档SQL库表改造”下也会显示该文档的信息，这样文档资源库中的文档就与卡片工作项建立了关联关系。

3.2 文档版本升级

若对文档资源库中已有文档进行修改，文档的版本会自动加1，原有文档会自动变为历史版本，并进入历史版本信息表，用户可以查看文档的所有历史版本。比如，将“资源库改造1.0.docx”修改为“资源库改造2.0.docx”，修改如下图所示：

文档修改成功后，查看历史版本信息，修改前的文档“资源库改造1.0.docx”变成历史版本保存在了“全部历史版本”列表中，如下图所示：

同时，标题为“文档库修改”的研发任务工作项内的文档也修改为最新上传的“资源库改造2.0.docx”。

3.3 文档信息修改

文档信息包括文档的类型、文档关联的工作项卡片、文档的保存目录，修改这些信息时，文档的信息会相应跟着变化，比如修改工作项为标题是“用户角色提取”的研发任务，如下图所示：

3.4 文档下载

在文档资源库可以进行文档的下载，其中下载包括文档的当前版本和历史版本，若文档具有历史版本，打开历史版本后会显示该文档的所有历史版本，若没有历史版本，打开后不会显示任何文档信息，如下图所示：

3.5 文档删除

文档资源库支持文档的删除操作，文档删除后该文档会从文档资源库中消失。比如删除“需求文档.docx”，该文档在资源库删除成功后，若其关联了工作项，工作项下也会删除该文档的关联关系，即“需求文档.docx”关联的工作项下也没有该文档的信息了。

4 结语

文档及其版本管理功能让用户将文档与卡片工作项即Dev Ops下的研发、测试、需求等过程结合起来，方便用户在研发、测试、需求等阶段保存不同的文档，同时支持对文档的版本管理，用户可以随意对文档进行修改，所有的修改都以历史版本的形式为用户展示，用户可以根据需要下载所需的文档信息版本，极大地为用户管理Dev Ops下的文档提供了便利和灵活性。

-----------------------------------