Definition
The practice of creating structured documentation for n8n automation workflows, describing trigger conditions, node configurations, data transformations, error handling, and API integrations so that team members can understand, maintain, and debug workflows without the original builder.
In Depth
n8n workflows are visual but not self-documenting. A workflow with 15 nodes, multiple branches, and HTTP Request nodes calling external APIs becomes opaque without documentation. When the original builder leaves or a workflow breaks at 2 AM, documentation is the difference between a 5-minute fix and a 2-hour investigation. Documentation template per workflow: (1) Purpose -- one sentence describing what the workflow does and why. (2) Trigger -- what starts the workflow (schedule, webhook, manual) and the frequency. (3) Data flow -- ordered list of nodes with input/output descriptions. (4) External dependencies -- APIs called, credentials used, rate limits. (5) Error handling -- what happens when a node fails, who gets notified. (6) Cost -- monthly API costs at current usage volume. Example for a search monitoring workflow: Purpose: tracks 50 keywords daily across Google and Reddit, stores results in Airtable, alerts Slack on ranking changes. Trigger: Cron schedule, 6 AM UTC daily. Data flow: Schedule Trigger -> Airtable (read keywords) -> HTTP Request (Scavio search, $0.005/query x 100 = $0.50/day) -> Code (parse rankings) -> Airtable (store results) -> IF (ranking changed) -> Slack (alert). External dependencies: Scavio API key (in credentials, $15/mo estimated), Airtable API key, Slack webhook. Error handling: on HTTP Request failure, retry 3x with 10s delay, then send error to Slack #ops channel. Documentation location: store in the workflow's Sticky Note nodes (visible in the n8n editor) and in a shared team wiki. The Sticky Note approach keeps docs next to the code. The wiki approach enables search across all workflows.
Example Usage
n8n Sticky Note documentation: 'SEARCH MONITOR v2.1 | Runs daily 6AM UTC | Queries 50 keywords on Google + Reddit via Scavio ($15/mo) | Stores in Airtable base 'SEO Tracking' | Alerts #seo-alerts Slack channel on position changes > 3 spots | Last updated: 2026-05-20 | Owner: @teamlead'
Platforms
n8n Flow Documentation is relevant across the following platforms, all accessible through Scavio's unified API:
Related Terms
n8n HTTP Request Node
The general-purpose API connector in n8n workflow automation that sends HTTP requests to any REST endpoint, enabling vis...
Agent Tool Dispatch
The mechanism by which an AI agent selects which external tool or API to call based on the user's intent, routes the req...
Budget Search API
A web search API that provides structured search results at a total monthly cost under $50 for moderate usage (5,000-10,...