Trigger
Document whether the workflow starts from a schedule, webhook, app event, manual run, or another workflow.
n8n workflow documentation guide
How to document n8n workflows for clients.
A client handoff is not a node dump. It should tell the next owner what starts the automation, what can break, which credentials matter, what is safe to edit, and how to prove the workflow still works.
The client handoff structure
Use the same order every time so your client or support team can find the failure point without reading every node.
- Business summary. One paragraph explaining the workflow outcome, owner, trigger, and expected result.
- Systems touched. Every app, account, inbox, sheet, CRM, webhook, API, and credential the workflow relies on.
- Workflow map. A client-readable path from trigger to final action, including important branches.
- Owner-safe edits. The values a non-technical owner can change without editing workflow logic.
- Break-fix checklist. The first checks for expired credentials, bad inputs, API downtime, changed fields, and recent human edits.
- Acceptance evidence. The final test case, date, expected output, and who approved the handoff.
What to write in each section
Inputs
Name the fields the workflow expects. Call out optional fields, required fields, and values that commonly arrive malformed.
Credentials
Do not paste secrets into the doc. List the credential names, owners, renewal risk, and where access must be confirmed.
Outputs
Explain what should happen when the workflow succeeds: created record, sent email, Slack message, invoice, lead update, or file.
Example phrasing: This workflow starts when a website form sends a lead payload to n8n. It checks required fields, writes the lead to the CRM, sends an internal review email, and marks the handoff successful when the CRM record URL is returned.
Safe edits and change logs
Most client breakage starts after a small edit. Give the owner a short list of values they can safely change, then make every riskier change leave a trail.
- Safe to edit: email recipients, notification wording, sheet tab names, business hours, thresholds, labels, and static text values.
- Test before editing: node order, webhook URLs, conditional branches, credential names, field mappings, filters, and API request bodies.
- Change log: date, person, reason, edited field, risk level, test case, and rollback note.