DevOps 文档成熟度的 4 个级别

DevOps 和 DevSecOps 需要敏捷的文档实践，以便在迭代软件交付周期中按时交付高质量的文档。这与 DevOps 的过程类似，都涉及到自动化和更敏捷的内容处理方式。如果文档编制才刚刚进入您组织的 DevOps 讨论范围，那么现在是时候让您的文档实践赶上 DevOps 的步伐了。

以下是 DevOps 文档成熟度的四个级别：

级别 1：临时性和孤立性

在 DevOps 文档成熟度的第一级（最不成熟），文档工作与 DevOps 工作不一致。 DevOps 开发遵循其路径，而文档团队遵循单独的路径，这通常会导致文档滞后于开发。 由于文档而延迟产品发布在竞争激烈的云世界中是不可接受的。

人员配置

这个级别的人员配置没有偏离旧的做事方式。 技术作家仍然在一个与开发团队分离的集中式团队中工作。 技术写作组和开发团队之间存在差距的原因有很多，包括：

• 导致团队分裂和孤岛的企业政治
• 团队将技术文档视为检查点，而不是创造项目成功的资产
• 事后才招聘技术作家
• 技术作家的优先级与开发团队的实际情况不符

这个阶段人员配置挑战的另一个标志是“完成的定义”。 在这种情况下，刚接触敏捷体验的技术作家可能会发现，通过迭代开发的应用程序具有持续集成/持续开发 (CI/CD) 工具链和流程，工作具有挑战性。

文档工具和流程

此阶段的技术作家使用他们习惯的传统办公工具，例如办公套件和版面设计程序。 这些工具不敏捷，需要版本控制，并且内容管理要求无法有效地与 DevOps 工具链集成或支持开发速度。 在这个级别，技术作家仍然遵循旧的模板和流程。

结果

此级别的文档交付成果可能不是最新的，甚至缺乏技术准确性。 当开发团队以 DevOps 的速度前进，而他们的技术作家支持遵循旧的非敏捷流程（使用专有工具和交付格式）时，很难迭代文档并跟上应用程序的变化。

级别 2：试验和试点

DevOps 文档成熟度的第二级（试验阶段）是 DevOps 领导者和技术作家开始采取行动来实施更敏捷的文档实践和工具的阶段。

理想情况下，试验是试点项目的一部分，并得到那些从改进文档交付及其与 DevOps 实践的集成中获益最多的利益相关者的支持。

人员配置

试验阶段的人员配置可以采取以下三种形式之一：

1. 一位具有前瞻性的技术作家在自己的时间内试验更敏捷的工具，并将他们的发现带到工作中，因为他们想要一种更好的方式来完成工作。 该作者向其领导层提出了更敏捷的文档流程的想法。
2. DevOps 负责人或工程师正在试验 Hugo 和 Jekyll 等工具，并将该工具集成到 CI/CD 管道中。 DevOps 团队将该工具教给技术作家。
3. 该团队引入了在 DevOps 文档工具方面具有专业知识的第三方承包商或顾问，以及文档工具在 CI/CD 工具链和 DevOps 生命周期中的位置的知识。

文档工具和实践

Hugo 和 Jekyll 是此阶段出现的工具之一。 该阶段还看到了内容策略和技术写作的新方法。

结果

成功的试验阶段的结果应该是“落地并扩展”，并建立其他项目团队可以投入实践的 DevOps 文档实践。

此阶段的试验还包括对内容策略和发布流程的根本性更改，试点项目之外的技术作家可以学习和采用这些更改。

基于试点的成功，技术作家招聘实践的变化是这个阶段的另一个潜在结果。 通过为内部作家提供有关 DevOps 和新实施的文档工具的培训，让他们参与进来至关重要。

新的文档工具和流程是这个阶段的关键成果。 您还需要通过演示文稿、状态报告和内部案例研究将此结果销售给您的领导层、利益相关者和其他团队。

级别 3：部分自动化和扩展

DevOps 文档成熟度的第三级（部分自动化和扩展）是“落地并扩展”结果的下一步。 在这个阶段，其他 DevOps 团队采用从试点项目中获得的 DevOps 文档工具、实践和经验教训。

人员配置

技术作家和 DevOps 团队在这个级别开始更紧密的合作。 在这个级别招聘新的技术作家侧重于具有 DevOps 环境经验的作家。

工具和文档实践

在这个阶段，技术作家开始从他们的旧工具和流程迁移，并采用更敏捷的文档工具，例如：

• docToolchain
• Docbook
• Hugo
• Jekyll

技术作家还致力于在这个级别调整他们的旧实践。

结果

DevOps 文档工具和实践从试点项目扩展到成为标准实践。 随着新团队使用新的文档工具和流程上线，持续学习在这个级别至关重要。

级别 4：完全采用

DevOps 文档成熟度的最高级别（完全采用和自动化）是工具、实践和流程到位以支持文档作为顶级项目优先级的位置。 达到这种成熟度级别需要试验、迭代和协作。

人员配置

完全自动化使 DevOps 团队和技术作家之间的合作最为密切。 这个阶段的一个标志是您的技术作家牢固地嵌入到项目团队的工作流程中。 分配工程师来维护 DevOps 工具链的大型企业承担了文档工具的维护职责。

文档工具和实践

在这个成熟度级别的技术作家在 markdown 语言和自动化工具上实现了标准化。

结果

这个阶段的结果是一套完整的工具和实践，支持在线文档发布的自动化。 技术作家可以根据需要发布和重新发布文档，以支持迭代开发过程。

持续学习是这个阶段的另一个成果。 技术作家和工具链维护者寻求改进自动化和帮助文档实践的方法。

最后的想法

DevOps 文档需要经历类似您实现 DevOps 或 DevSecOps 成熟度的过程。 我希望在整个行业中达到这样一个地步：采用更敏捷的文档实践和工具成为组织整体 DevOps 旅程的一部分。 还有很多工作要做。 提升您的 DevOps 文档成熟度应该成为您整体 DevOps 成熟度的一部分，甚至成为 DevOps 到 DevSecOps 转型 的一部分。