Deployment Checklist

Before any automation goes live in production:

Technical

  • All test cases passed in staging
  • Peer review approved
  • PMO review approved
  • Production credentials configured (separate from staging)
  • Error alerting connected to Discord #monitoring
  • Execution logging enabled — minimum 30-day retention
  • Webhook signatures validated (if applicable)
  • Rate limit handling implemented and tested

Documentation

  • GitHub README complete and accurate for production
  • Notion Delivery Tracker updated → status: Live
  • Environment variables documented in .env.example
  • Any manual steps documented clearly

Post-Deploy

  • Run one live test in production with real data
  • Watch #monitoring for immediate errors
  • Notify PMO: “Deployed and confirmed live — [automation name]“

Documentation Standards

Good documentation means any dev partner can maintain any automation — not just the one who built it.

GitHub README — Required for Every Automation

  • What it does (2–3 plain English sentences)
  • Trigger + all steps (numbered, tool for each step)
  • All systems involved and how they connect
  • All environment variables required
  • How to run tests
  • Known limitations or edge cases
  • Deployment instructions

Notion Client Workspace

  • Solution design document
  • Any deviations from original design and the reason
  • Post-mortem notes for any P1/P2 incidents

Client-Facing Documentation (for handover)

  • Plain English — zero technical jargon
  • Covers: what it does, what triggers it, what the output looks like, who to contact if something looks wrong
  • Stored in Google Drive → Clients / [Client Name] / Documentation