Documentation

Documentation skills help you generate clean, structured documentation and diagrams for APIs, flows, and repositories — all directly from the UI. These capabilities are especially useful for external documentation, stakeholder presentations, and developer onboarding.

They are optimized to be user-facing, focusing on clarity, completeness, and usability. Instead of writing docs manually, you can generate them in seconds based on real implementation.

Key Capabilities

• Flow & Endpoint Documentation: Automatically generate summaries for flows, connectors, and configurations.
• Visual Diagrams: Produce flowcharts and domain diagrams for better understanding and presentation.
• Mapping Tables: Reverse-engineer transformation logic into editable tables.
• Multiple Input Options: Works with repositories or uploaded Mule projects.

1. Document Generator

Generates structured documentation for selected flows, including step-by-step descriptions, sequence diagrams, test coverage, and error handling insights.

• Flow-Centric Output: Produces a complete technical write-up of how each flow operates, based on its internal configuration and logic.
• Visual + Textual: Includes a flow diagram alongside detailed step-by-step logic and metadata about connectors, endpoints, and error scopes.
• Ideal for Handoffs: Great for client-facing reports, onboarding material, or engineering reviews.

Supported Input Modes:

• With Repository: Connect to a Git-based repo and branch to pull flows for documentation.
• Upload from Computer: Upload a local MuleSoft project to access and document its flows.

Additional Features:

• Flow Picker: Select one or more flows to include in the generated documentation.
• Error Scope Coverage: Documents all configured error handlers with descriptions.
• Test Visibility: Indicates if unit tests exist for each flow and outlines them briefly.

This capability helps teams auto-generate polished technical docs in seconds, reducing manual effort and ensuring consistency across deliverables.

2. Diagram Generator

Creates visual diagrams that represent MuleSoft flows either as sequence diagrams or flow diagrams — helping teams quickly understand flow architecture and interactions.

• Auto-Generated Visuals: Produces diagrams based on real code, providing instant visual clarity of complex flow logic.
• Two Diagram Types: Choose between UML-style Sequence Diagrams (showing component interaction across time) or Flow Diagrams (depicting logical structure).
• Flow-Level Selection: Diagrams are generated per selected flow to ensure accuracy and specificity.

Supported Input Modes:

• With Repository: Connect to a Git repo and select the flow(s) from a given branch.
• Upload from Computer: Import a local MuleSoft project to access and diagram its flows.

Additional Features:

• Diagram Type Picker: Choose the type of diagram you want to generate (sequence or flow).
• Flow Selector: Select individual flows for which diagrams should be generated.

This capability is ideal for documentation, reviews, or simplifying complex architectures for both technical and non-technical audiences.

3. Domain Diagram Generator

Generates high-level diagrams across multiple APIs to visualize interconnections, domain boundaries, and service segmentation.

• Multi-Repo Support: Select up to 8 repositories to be analyzed together for cross-repo architectural insights.
• High-Level View: Helps identify service interactions, dependencies, and grouping at the domain level.
• Great for Architects: Useful for planning, reviewing, or documenting enterprise-wide integration landscapes.

Supported Input Modes:

• With Repository: Choose a branch and select up to 8 repositories to analyze and generate a combined domain diagram.

Use this capability to capture and communicate big-picture architecture across multiple APIs and services in a single, unified view.

4. Mapping Table Generator

Converts a given DataWeave (DWL) script into a structured mapping table to aid documentation, audits, or transformation clarity.

• One-Step Process: Simply paste your DataWeave code to generate the mapping.
• No Repo Context Required: This capability operates independently of repository input.
• Great for Analysts & Reviewers: Helpful for understanding field-level transformations without digging into code.

This capability simplifies the process of documenting complex mappings by producing a human-readable table directly from your DataWeave script.