Slash Command

/runbook-writer

Generates production-ready Runbook for deployment, rollback, monitoring, and incident response from required HLD path and optional LLD, API Contract, Guardrails paths.

devops

deployment

npx claudepluginhub testany-io/testany-agent-skills --plugin testany-eng

Details

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

Prompt Preview

# Runbook Writer

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

## 使用方式

提供上游文档路径：

$ARGUMENTS

## 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: 输出与验证** - ...

Command Content

Other plugins with /runbook-writer

/operationalize

166

Generates operational readiness pack with support model, runbooks, DR/BCP plans, on-call rotations, and handover documentation for a service.

arckit

/runbook

Guides runbook creation, maintenance, drills, and coverage reporting for alerts. Supports create, drill, coverage subcommands with alert name.

4 tools

universal-dev-standards

/kasi-acknowledge

Captures recent steps from session history (deploys, migrations, incidents) as a replayable Markdown runbook in .kasidit/knowledge/runbooks/. Also supports template, update, link sub-modes.

kasidit

/reliability

Performs SRE assessment and implementation: defines SLOs/SLIs/SLAs with error budgets, configures burn rate alerts, reduces toil, designs on-call rotations, creates runbooks, establishes incident processes. Outputs docs, configs, verdict. Supports focused flags.

godmode

/vt-docs

Generates project documentation including setup guides, config references, runbooks, architecture overviews with Mermaid diagrams, and API references. Supports interactive mode and updating existing docs.

sonnet

virtual-team

Stats

Parent Repo Stars10

Parent Repo Forks6

Last CommitJan 22, 2026

Actions

View Source View Plugin View on GitHub View README

Help us improve

Share bugs, ideas, or general feedback.

# Runbook Writer 启动 Runbook 撰写流程。基于 HLD/LLD 等上游文档，编写生产就绪的运维手册。 ## 使用方式提供上游文档路径： $ARGUMENTS ## 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 Writer

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

使用方式

提供上游文档路径：

$ARGUMENTS

Runbook 在研发流程中的位置

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

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

Runbook 内容范围

部署流程：前置检查、部署步骤、验证命令

回滚流程：触发条件、回滚步骤、验证方法

监控与告警：关键指标、SLO 阈值、告警配置

故障处理：常见故障、排查步骤、解决方案

值班手册：职责、联系方式、升级路径

工作流程

Phase 0: 基线收集 - 读取 PRD/HLD/LLD/API Contract/Guardrails

Phase 1: 上下文准备 - 提取部署、回滚、监控、故障处理约束

Phase 2: 派发 Writer Subagent - 独立写作（完整上下文传递）

Phase 3: Spec Compliance Review - 验证是否覆盖上游要求

Phase 4: Quality Review - 验证可执行性和完整性

Phase 5: 输出与验证 - 按模板输出最终 Runbook

必需产出

Runbook 文档（含部署、回滚、监控、故障处理全流程）

验证记录（Spec Compliance + Quality Review 通过）

核心原则

Context 隔离：Subagent 获得新鲜上下文，避免假设污染

双阶段审查：Spec compliance 先行，quality 后续

证据驱动：所有约束必须来自上游文档

可执行优先：每个步骤必须有验证命令，回滚路径必须可操作

请提供 HLD 路径（必需），以及 LLD、API Contract、Guardrails 路径（可选）。