doc

Generate README.md and CHANGELOG.md documentation from n8n workflow.json files.

Updated Mar 16, 2026
One-click install
npx skills add https://github.com/MJ-AgentLab/mj-agentlab-marketplace --skill doc-mj-agentlab
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc
Source: https://github.com/MJ-AgentLab/mj-agentlab-marketplace/tree/main/plugins/mj-n8n/skills/mj-n8n-doc
Command: npx skills add https://github.com/MJ-AgentLab/mj-agentlab-marketplace --skill doc-mj-agentlab

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and scripts (resource) components.

What problem does it solve?

This Skill automates the creation and updating of README.md and CHANGELOG.md documentation for n8n workflows, saving significant manual effort and ensuring consistency.

Core Features & Use Cases

  • Automated Documentation: Generates comprehensive READMEs (9 sections) and initial CHANGELOG entries from workflow JSON files and templates.
  • Workflow Analysis: Parses workflow.json to extract node details, connections, credentials, and trigger types for documentation.
  • Use Case: When you create a new n8n workflow for data synchronization, invoke this skill to automatically generate its documentation, including architecture diagrams and usage instructions.

Quick Start

Use the doc skill to generate documentation for the workflow located at n8n/workflows/_base/CollectionNodes/MissingDataNotification-Schedule.

Frequently Asked Questions about doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate README documentation for n8n workflows?

You can automatically generate README documentation for n8n workflows by parsing workflow.json files to extract node details, connections, and triggers, populating 9 distinct sections including Mermaid architecture diagrams and usage instructions.

What is included in automated n8n workflow documentation?

Automated n8n workflow documentation includes a 9-section README.md with Mermaid diagrams and node descriptions, plus initial CHANGELOG.md entries, extracted directly from workflow.json files and project templates.

How do I create a CHANGELOG for my n8n workflow.json?

To create a CHANGELOG for your n8n workflow.json, you use an automated documentation generator that analyzes workflow templates and node configurations to populate initial version history entries alongside the generated README.

Can I generate Mermaid diagrams from n8n workflow connections automatically?

Yes, you can generate Mermaid diagrams from n8n workflow connections automatically by analyzing the workflow.json connection structures, which visually maps node relationships within the generated README documentation.

Does automated n8n documentation support parsing credentials and trigger types?

Yes, automated n8n documentation supports parsing credentials and trigger types, extracting these specific configurations from the workflow.json file to ensure accurate security and execution documentation within the README.

What is the best way to maintain n8n workflow READMEs during updates?

The best way to maintain n8n workflow READMEs during updates is automating documentation generation from workflow.json, ensuring consistent 9-section READMEs and initial CHANGELOG entries without manual effort when nodes change.