Resource
Markdown Output Prompt — Lock the Document Structure
The contract that stops AI documents from restructuring themselves: a pinned section skeleton, forced tables, and strict consistency rules.
Deployment Runbook Prompt
Turn a deploy into a runbook anyone can execute — ordered steps, preconditions, verification at each gate, and the rollback hook, instead of tribal knowledge.
Overview
A deploy that lives in one engineer's head is a single point of failure. This prompt produces a deployment runbook: the ordered steps, the precondition checks before each, the verification that each step succeeded before moving on, and the rollback hook at every gate. The result is a document a teammate can run without you on the call.
How to use this resource
-
Describe the release scope
Note what's being deployed, the environments involved, and the deploy mechanism. The runbook turns these into ordered steps a teammate can run without you.
-
Open this resource in Markdown Output Builder
Load the prompt into Markdown Output Builder and fill in the deploy. It returns the runbook as clean Markdown you can drop straight into your docs or ticket.
-
Walk through the generated runbook
Read the pre-deploy checks, the ordered deploy steps, and the post-deploy verification, confirming each production step carries a verification and an on-failure path.
-
Fill the gaps before you launch
Add any precondition, backup, or rollback hook the runbook is missing, then keep it alongside the release so anyone on the team can execute it.
Why This Works
- Per-step verification stops a broken deploy from continuing on a bad assumption
- Written preconditions catch the missing backup or approval before it bites
- A runbook removes the single-person dependency from shipping
Best for
- Manual or semi-automated deploys
- Teams where only one person knows how to ship
- Releases that need an auditable execution trail
Not for
- Designing rollback triggers specifically — use the Rollback Plan Prompt
- Fully automated CI/CD where the pipeline is the runbook
Use cases
- Documenting a deploy so anyone on the team can run it
- Turning a manual deploy into a repeatable checklist
- Onboarding a new engineer onto the release process
FAQ
How do I turn a deploy that lives in one engineer's head into a runbook
The prompt produces a runbook where every step carries PRECONDITIONS, ACTION, VERIFICATION, and ON FAILURE, structured Pre-deploy checks, then ordered Deploy steps, then Post-deploy verification, then Sign-off. Markdown Output Builder returns it as clean Markdown; you run the prompt in your own assistant and still fill any gap before executing, since it's a draft to review, not a guaranteed-complete procedure.
What does each runbook step include so a teammate can run it alone
A RULE requires that no step assume context the executor doesn't have written down, and every step that changes production must carry a VERIFICATION and a failure path. So each numbered step states its preconditions, the exact unambiguous action, how to confirm it succeeded before continuing, and the ON FAILURE action such as a rollback hook or stop-and-escalate.
Should I use this or the rollback plan prompt for designing rollback triggers
Use the Rollback Plan Prompt for that. This runbook includes a rollback hook at each gate as the ON FAILURE path, but the notFor says designing the specific rollback triggers is out of scope, as is fully automated CI/CD where the pipeline is the runbook. Here the focus is the ordered, verifiable deploy a teammate can execute without you present.
More resources from Markdown Output Builder
Resource
README Prompt Template
Overview, Installation, Usage, Examples, Configuration — the README skeleton with required, runnable code examples.
Resource
API Documentation Prompt
Overview, Authentication, Endpoints, Error Handling, Rate Limits — endpoint docs in an identical structure, with parameter tables and runnable examples forced.
Resources that pair well
Resource
Executive Summary Prompt
Summary, Why It Matters, What Happens Next — the executive summary contract for readers who will never open the source.
Resource
Force JSON Output from AI
Stop getting 'Sure, here is the JSON…' — the output-contract pattern that forces models to return only parseable JSON: schema, example, and a strict rule block.
Resource
Fix Invalid JSON from AI
The JSON won't parse and you can't see why. Deterministic cause-sniffing — trailing commas, single quotes, unclosed brackets — and the repair prompt that fixes it.
Related tools
Tool
Markdown Output Builder
Build prompts that produce documents in a fixed structure — headings, sections, and tables.
Guides for this resource
Guide
Write a Rollback Plan With AI Before You Ship
AI deployment plans end at "roll back if needed" — no trigger, no undo steps, no flag on what can't be reversed. Here's how to write a rollback plan before you ship: a measurable trigger, the reverse of every step, the parts you can't undo, and who makes the call.
Guide
How to Write a Deployment Runbook With AI
"Bump the tag and restart — ask Priya if it breaks" is not a runbook, and Priya is on a plane. Here's how to turn what you actually do into a deployment runbook someone else can execute: preconditions, ordered steps, a verification at every gate, a failure path that isn't hope.
Guide
How to Plan a Zero-Downtime Deployment With AI
"We do rolling deploys, so we have zero downtime" is true about the mechanism and often false about the change. Here is how to plan a zero-downtime deployment with AI: work out whether the old and new versions can actually run at once, across the database, the queue, and the traffic switch, before you ship.