{ "schema_version": 2, "kind": "shortening-method", "format": "agent-skill", "id": "runbook-brief", "name": "Runbook brief", "category": "Technical", "summary": "Shorten an operational procedure while retaining its gates and stop conditions.", "use_cases": [ "On-call procedures", "Operational checklists" ], "word_count": 150, "url": "https://sho.rten.it/methods/runbook-brief/", "instructions_url": "https://sho.rten.it/methods/runbook-brief/SKILL.md", "skill_url": "https://sho.rten.it/methods/runbook-brief/SKILL.md", "json_url": "https://sho.rten.it/methods/runbook-brief/llms.txt", "plain_text_url": "https://sho.rten.it/methods/runbook-brief/prompt.txt", "license": "MIT", "sources_url": "https://sho.rten.it/sources/#runbook-brief", "skill_name": "runbook-brief", "skill_description": "Shorten an operational procedure while retaining its gates and stop conditions. Use for On-call procedures, Operational checklists.", "agents_md_url": "https://sho.rten.it/methods/runbook-brief/AGENTS.md", "sources": [], "instructions": "Condense a supplied runbook into a procedure that an authorized operator can follow. Keep operational safeguards; the shortest text is not useful if it changes when a step is allowed.\n\nStart with the trigger and required access or prerequisites. Keep checks in their original dependency order. Preserve exact commands, thresholds, time windows, expected signals, stop conditions, escalation paths, and rollback instructions. Put warnings immediately before the affected step. Distinguish verification from action and mandatory steps from optional diagnostics.\n\nRemove repeated background and commentary about routine observations. Combine steps only when doing so cannot conceal a decision gate. Do not guess a missing command, assume a check passed, or replace a conditional action with an unconditional instruction.\n\nOutput a brief scope line and numbered steps, with explicit if/then branches where required. Include supplied completion criteria. This is a rewrite only; do not execute the runbook, contact anyone, or claim service recovery.", "example": { "context": "Image queue recovery procedure", "before": "Use this procedure only when the EU image queue has more than 500 jobs waiting for at least 10 minutes. You must have the operator role. First check that object storage health is green. If storage is not green, stop and page the storage on-call; do not restart the workers. If storage is green, run queuectl restart image-eu --batch 1. Wait for five minutes, then check queue depth and failed-job count. Finish only if queue depth is below 100 and the failed-job count has not increased. Otherwise stop and page the image on-call. Do not run the restart a second time.", "after": "Trigger: EU image queue >500 jobs for ≥10 minutes. Requires operator role.\n1. Check object storage health. If not green, stop; page storage on-call. Do not restart workers.\n2. If green, run queuectl restart image-eu --batch 1.\n3. Wait 5 minutes. Check queue depth and failed-job count.\n4. Finish only if depth <100 and failures have not increased. Otherwise stop; page image on-call. Do not restart again.", "must_preserve": [ "EU image queue >500 jobs for at least 10 minutes; operator role", "Storage health gate; nongreen stop and storage escalation without restart", "Exact queuectl restart image-eu --batch 1 command only if green", "Wait five minutes; check depth and failed jobs", "Complete only below 100 and no increased failures", "Otherwise stop and page image on-call; never second restart" ], "kind": "illustrative", "omitted": [ "Procedural framing such as \"Use this procedure\" and \"First\"." ] } }