概述
保持文档准确：将 API 文档与在线规范对照，审计运行手册新鲜度，并在文档误导用户之前修复漂移。本工作流属于文档知识领域，目标是eliminate documentation drift so every public api and runbook matches the current system behavior.以下步骤将指导你完成关键操作，并在每一步设置可验证的中间状态，确保最终结果可复现、可审计、可回滚。
步骤详解
-
Check API doc drift。 Diff the generated API spec against the documented examples and flag any endpoint, parameter, or status code that changed.预期状态：A drift report lists every mismatch with the current spec.
-
Audit runbook freshness。 List runbooks by last-updated date and flag any that reference retired alerts or removed commands.预期状态：Stale runbooks are identified and assigned for update.
-
Fix and verify。 Update the drifted sections, regenerate examples from the live spec, and confirm the docs build passes.预期状态：Docs match the live system and the build is green.
每一步都包含明确的动作与预期状态。执行时请记录实际输出，与预期状态逐一对照。若某一步未达预期，应停下排查而非继续推进，避免问题向后传递放大。
验证与后续
验证方法：eliminate documentation drift so every public api and runbook matches the current system behavior.完成后，将本次执行的命令、输出与参数归档，并更新团队运行手册。若用于生产环境，请先在预发环境完整演练一次，并确认团队熟悉回滚路径与应急联系人。本工作流难度级别为进阶（intermediate），预计耗时约25分钟。该流程已通过结构化校验，步骤与决策点均与英文版本严格一致，可在本地按工作流步骤复现并核对结果。
代码示例
redocly lint openapi.yaml --skip-rule security-defined