The Workflow Documentation Template
Copy this template and fill it out for each of your workflows. Save it in your preferred format: Notion, Google Docs, a comment in the workflow itself (Make and n8n both allow notes on modules), or a text file.
=== WORKFLOW: [Name] ===
PURPOSE:
[One sentence describing what this workflow does and why it exists]
TRIGGER:
[What starts it, how often, any conditions]
KEY STEPS:
- [Step 1, in plain English]
- [Step 2, in plain English]
- [Step 3, in plain English]
DATA SOURCES & DESTINATIONS:
Input from: [APIs, databases, webhooks, hardcoded values]
Output to: [Email, databases, APIs, files]
AI STEPS:
Model: [e.g., Claude 3.5 Sonnet]
Prompt: [Copy the exact prompt, or link to it]
Expected output: [What should the AI produce?]
KNOWN EDGE CASES:
- [Edge case 1 and how we handle it]
- [Edge case 2 and how we handle it]
LAST UPDATED:
[Date] by [your name] — [one sentence describing the change]