Flow Documenter
AI-powered flow documentation
One-click descriptions for your workflows using OpenAI or Anthropic. Magic wand button on every tab.
The Problem We Discovered
"I have dozens of flows and can't remember what each one does. The info tab is always empty. Documenting them manually takes forever and I never get around to it."
Flow documentation is a constant pain point. The info field exists, but it's always empty. Manual documentation is tedious and quickly becomes outdated as flows evolve.
Teams inherit flows from colleagues who have moved on. Complex integrations become mysterious black boxes. The intent behind decisions gets lost because nobody documented why a flow works the way it does.
Let AI Write Your Documentation
How It Works:
- Magic Wand Button: Click the wand icon on any flow tab
- AI Analysis: Examines flow structure, node types, connections, and purposes
- Two Detail Modes: Brief (1-2 sentences) or Detailed (full markdown)
- Stored in Info Field: Descriptions saved to standard flow info, visible in sidebar
- Exported with Flows: Documentation travels with your flows
Detail Levels:
- Brief Mode: Plain language summary for non-technical users
- Detailed Mode: Markdown with purpose, processing steps, and integration points
AI Provider Support
| Provider | Model | Notes |
|---|---|---|
| OpenAI | GPT-5 Nano | Fast and cost-effective |
| Anthropic | Claude Haiku 4.5 | Alternative provider |
Configuration:
- Auto Mode: Automatically selects an available provider
- API Keys: Configure via JobFlow Pro Manager or environment variables
- Server-Side: All API calls made server-side to avoid CORS issues
Quick Start
Generate a Description:
- Click the magic wand icon on any flow tab
- Choose Brief or Detailed mode
- Click Generate Description
- Review the result in the preview area
- Click Done to save to the flow's info field
- Deploy your flows to persist
Tips for Better Results:
- Give nodes meaningful names (not just default names)
- Use Detailed mode for comprehensive technical documentation
- Brief mode works well for non-technical overviews
Get Started
# Quick install cd ~/.node-red npm install @fierylab.io/fiery-contrib-plugin-flow-documenter node-red-restart
Requirements:
- Node-RED 3.0.0 or higher
- Node.js 18.0.0 or higher
- At least one AI provider API key (OpenAI or Anthropic)