Code quality

Missing node notes in n8n

Why undocumented workflows become impossible to maintain over time

What is this issue?

Complex workflows without explanatory notes become 'tribal knowledge'—only the original creator understands them. When that person leaves or forgets, the workflow becomes a black box.

Nodes that need documentation:

  • Complex Code nodes with business logic
  • Non-obvious branching decisions in IF/Switch
  • Workarounds for API quirks or bugs
  • Rate limiting or retry configurations

Why is this a problem?

Knowledge loss

When the creator leaves, understanding of the workflow goes with them.

Dangerous changes

Modifying undocumented logic risks breaking hidden dependencies.

Slow onboarding

New team members take much longer to understand workflows.

Debugging difficulty

Without context, it's hard to know if behavior is intentional or a bug.

How to fix it

  1. 1

    Use sticky notes

    Add Sticky Note nodes to explain complex sections of your workflow.

  2. 2

    Document node purpose

    Use the 'Notes' field in node settings to explain what each node does.

  3. 3

    Explain business logic

    Document WHY decisions are made, not just what the code does.

  4. 4

    Create workflow README

    Add a Sticky Note at the start summarizing the workflow's purpose and flow.

Scan your workflow now

Upload your n8n workflow JSON and identify complex nodes missing documentation.

Scan for missing notes

Related resources

Related code quality issues