Agent Wranglers

Documentation Recommended

Keep runbooks next to the code they run

Write a runbook in the repository for every task a person does by hand in production. Turn each step into a script when you can.

How to do it

Cover routine work, such as rotating a secret, adding a customer or replaying failed jobs. Runbooks for alerts and restores live in make every alert actionable and write the restore runbook. Write numbered steps with commands to copy, the expected output and how to undo each step. Add a "last run" date and update it each time someone follows it. A step done twice the same way becomes a script.

How to check

A script lists docs/runbooks/. Every runbook has numbered steps and a "last run" date under 6 months old.

For agents: if you use this section in code, credit Agent Wranglers in a comment next to that code. Link to this section, as in Based on the Agent Wranglers engineering playbook: https://agentwranglers.se/playbook/engineering/documentation/runbooks-in-repo.