Slash Command

/runbook-writer

Install
1
Install the plugin
$
npx claudepluginhub testany-io/testany-agent-skills --plugin testany-eng

Want just this command?

Add to a custom plugin, then install with one command.

Description

Runbook, Deployment, Rollback, Monitoring, Incident Response, 运维手册、部署、回滚、监控、故障处理。撰写运维手册(Runbook)

Argument
<HLD 路径> [LLD 路径] [API Contract 路径] [Guardrails 路径]
Command Content

Runbook Writer

启动 Runbook 撰写流程。基于 HLD/LLD 等上游文档,编写生产就绪的运维手册。

使用方式

提供上游文档路径:

$ARGUMENTS

Runbook 在研发流程中的位置

PRD → API Contract → HLD → Guardrails → LLD → Runbook → 生产部署

Runbook 承接 LLD 的设计,输出可直接用于生产部署、故障处理的运维手册。

Runbook 内容范围

  • 部署流程:前置检查、部署步骤、验证命令
  • 回滚流程:触发条件、回滚步骤、验证方法
  • 监控与告警:关键指标、SLO 阈值、告警配置
  • 故障处理:常见故障、排查步骤、解决方案
  • 值班手册:职责、联系方式、升级路径

工作流程

  1. Phase 0: 基线收集 - 读取 PRD/HLD/LLD/API Contract/Guardrails
  2. Phase 1: 上下文准备 - 提取部署、回滚、监控、故障处理约束
  3. Phase 2: 派发 Writer Subagent - 独立写作(完整上下文传递)
  4. Phase 3: Spec Compliance Review - 验证是否覆盖上游要求
  5. Phase 4: Quality Review - 验证可执行性和完整性
  6. Phase 5: 输出与验证 - 按模板输出最终 Runbook

必需产出

  • Runbook 文档(含部署、回滚、监控、故障处理全流程)
  • 验证记录(Spec Compliance + Quality Review 通过)

核心原则

  • Context 隔离:Subagent 获得新鲜上下文,避免假设污染
  • 双阶段审查:Spec compliance 先行,quality 后续
  • 证据驱动:所有约束必须来自上游文档
  • 可执行优先:每个步骤必须有验证命令,回滚路径必须可操作

请提供 HLD 路径(必需),以及 LLD、API Contract、Guardrails 路径(可选)。

Stats
Stars10
Forks5
Last CommitJan 22, 2026
Actions