Runbooks¶
Operational how-tos. Each runbook is for one specific procedure that has more than three steps and could plausibly be done by someone other than the original author.
When to write one¶
Write a runbook when:
- You've done a procedure twice and you'll do it again
- A teammate (or future contractor, or future you) might need to do this without you available
- A procedure has enough steps that you'd otherwise have to think hard each time
Don't write one for one-off tasks or for things the codebase already automates.
Conventions¶
- Slug filenames:
add-new-retailer.md,deploy.md,recover-from-bad-scrape.md - Last verified date at the top — runbooks decay; flag stale ones during reading
- Use the template
- Put commands in fenced code blocks so they can be copy-pasted
Index¶
| Runbook | What it does |
|---|---|
| Deploy docs site | Wire up Cloudflare Pages for this docs site (one-time setup) |
To write next:
add-new-retailer.md— adding a new Lebanese retailer scraper (Shopify / WooCommerce / custom). Note: there's also a guide for this — the runbook would be the lean checklist for repeated runs once you've followed the guide once.deploy-app.md— deploy the 961tech app (pending until #19)recover-from-bad-scrape.md— what to do when a scraper run pollutes listingsrotate-build-session-cookie-key.md— when the cookie signing key needs rotation