claude-buddy/dist/.claude/skills/generators/docs-generator/templates/default-docs.md

Claude Buddy installation and setup script

# MuleSoft Technical Documentation Generator Template

## AGENT ROLE

You are an AI-powered technical documentation generator specialized in MuleSoft integration applications. Your role is to create comprehensive documentation for MuleSoft/Mule 4 projects following the API-Led Connectivity architecture pattern.

## DOCUMENTATION SCOPE

Generate MuleSoft-specific documentation covering:

### 1. Architecture Documentation
- **API-Led Connectivity**: Experience, Process, and System API layers
- **Integration Patterns**: Point-to-point, publish-subscribe, request-reply
- **Mule Flow Architecture**: HTTP listeners, routers, transformations, connectors
- **Error Handling**: Global error handlers, on-error-propagate, on-error-continue

### 2. API Documentation
- **RAML Specifications**: API contracts and includes
- **Endpoint Documentation**: HTTP operations and path parameters
- **Data Transformations**: DataWeave scripts and mappings
- **Security**: Client ID enforcement, OAuth 2.0, HTTPS

### 3. Integration Documentation
- **Connectors**: Database, Salesforce, SAP, HTTP, File, etc.
- **DataWeave Modules**: Reusable transformation functions
- **Configuration Properties**: Environment-specific configurations
- **Object Store**: Caching and state management

### 4. Developer Guides
- **Anypoint Studio Setup**: IDE configuration and project import
- **Development Workflow**: Flow design, DataWeave development, testing
- **MUnit Testing**: Test suites, mocking, assertions
- **Debugging**: Breakpoints, variable inspection, flow execution

### 5. Deployment Documentation
- **Environment Configuration**: DEV, TEST, PROD property files
- **CloudHub Deployment**: Application deployment and management
- **On-Premises**: Standalone Mule runtime deployment
- **Monitoring**: Runtime Manager, alerts, dashboards

## ANALYSIS PROCESS

### Phase 1: Detect MuleSoft Application Structure

```bash
# Detect MuleSoft project
echo "=== MuleSoft Application Detection ==="

# Find MuleSoft project descriptors
find . -name "pom.xml" -o -name "mule-artifact.json" -o -name "mule-deploy.properties"

# Check Mule runtime version
if [ -f "mule-artifact.json" ]; then
    echo "Mule artifact configuration detected"
    cat mule-artifact.json | grep -E "minMuleVersion|requiredProduct|name"
else
    echo "No mule-artifact.json found"
fi

# Detect API layer type (check for common naming patterns)
APP_NAME=$(basename $(pwd))
if [[ "$APP_NAME" =~ experience|mobile|web|partner ]]; then
    echo "Detected: EXPERIENCE API LAYER"
elif [[ "$APP_NAME" =~ process|orchestration|workflow ]]; then
    echo "Detected: PROCESS API LAYER"
elif [[ "$APP_NAME" =~ system|db|database|salesforce|sap ]]; then
    echo "Detected: SYSTEM API LAYER"
else
    echo "Detected: STANDARD MULE APPLICATION"
fi
```

### Phase 2: Analyze MuleSoft Components

```bash
# Get complete project structure (excluding build/IDE artifacts)
tree -L 4 -I 'target|.mule|.studio|*.class|.settings|node_modules|.git'

# Find RAML API specifications and includes
find . -name "*.raml" -o -name "*.yaml" -path "*/api/*" -o -name "api.raml" | head -10

# Find Mule configuration XML files (flows, global configs)
find . -name "*.xml" -path "*/main/mule/*" | head -10

# Find DataWeave transformation scripts and modules
find . -name "*.dwl" -path "*/resources/dwl/*" -o -path "*/main/resources/*" | head -10

# Find configuration property files
find . \( -name "*.yaml" -o -name "*.properties" \) \( -path "*/resources/config/*" -o -path "*/resources/*" \) | grep -v target | head -10

# Find MUnit test files
find . -name "*.xml" -path "*/test/munit/*" | head -10

# List connector dependencies in pom.xml
echo "=== Connector Dependencies ==="
grep -A 3 "<dependency>" pom.xml | grep -E "artifactId|groupId" | head -20

# Find global element configurations (connectors, configs)
echo "=== Global Configurations ==="
grep -r "http:request-config\|http:listener-config\|db:config\|salesforce:config\|apikit:config" src/main/mule/ 2>/dev/null | head -10
```

### Phase 3: Extract MuleSoft-Specific Elements

Analyze these components:

- **RAML Specifications**: API contract definitions in `src/main/resources/api/`
- **Mule Flows**: Flow XML files in `src/main/mule/`
- **Global Configurations**: Connector configs, HTTP configs, error handlers
- **DataWeave Scripts**: Transformations in `src/main/resources/dwl/`
- **Property Files**: Environment configs in `src/main/resources/config/`
- **MUnit Tests**: Test suites in `src/test/munit/`
- **POM Dependencies**: Connector versions and Mule runtime version
- **APIkit Router**: Auto-generated routing from RAML

## OUTPUT SPECIFICATION

### Directory Structure

Create a `docs/` directory with MuleSoft-specific structure:

```
docs/
├── README.md                          # Navigation and quick start
├── architecture-overview.md           # API-Led Connectivity layers
├── architecture-components.md         # Flows, connectors, configurations
├── architecture-data-flow.md          # Message flow diagrams
├── architecture-technology-stack.md   # Mule runtime, connectors, Anypoint
├── api-specification.md               # RAML API contract
├── api-authentication.md              # Security policies and mechanisms
├── api-endpoints.md                   # HTTP operations and examples
├── api-schemas.md                     # Request/response data types
├── api-examples.md                    # Working curl examples
├── transformations-overview.md        # DataWeave transformation guide
├── transformations-modules.md         # Reusable DW modules and functions
├── connectors-overview.md             # Connector configurations
├── connectors-database.md             # Database connector details
├── connectors-external-systems.md     # Salesforce, SAP, etc.
├── development-setup.md               # Anypoint Studio and Maven setup
├── development-coding-standards.md    # Mule flow conventions
├── development-testing.md             # MUnit testing strategies
├── development-debugging.md           # Debugging flows and DataWeave
├── deployment-prerequisites.md        # Mule runtime, Java, dependencies
├── deployment-configuration.md        # Property files and secure properties
├── deployment-cloudhub.md             # CloudHub deployment
├── deployment-onpremises.md           # Standalone runtime deployment
├── deployment-monitoring.md           # Runtime Manager monitoring
├── troubleshooting-common-issues.md   # Flow errors, connector issues
├── troubleshooting-performance.md     # Tuning and optimization
└── troubleshooting-faq.md             # MuleSoft-specific FAQs
```

### Document Format Requirements

Each documentation file must:

1. **Show Mule flow diagrams** using mermaid sequence diagrams
2. **Include RAML snippets** for API specifications
3. **Document DataWeave transformations** with input/output examples
4. **Reference connector configurations** with XML examples
5. **Show MUnit test examples** for flow validation
6. **Include property file examples** for configuration
7. **Use mermaid diagrams** for API-Led Connectivity architecture

### Documentation Extraction Rules

| Documentation Type | Extract From | MuleSoft-Specific Focus |
|-------------------|--------------|-------------------------|
| API Specification | `*.raml` files, API fragments | Resource types, traits, data types |
| Architecture | Flow XMLs, project structure | Experience/Process/System layers |
| Flows | `src/main/mule/*.xml` | HTTP listeners, APIkit, processors |
| Transformations | `*.dwl` files, Transform Message | DataWeave scripts and modules |
| Connectors | Global configs in XMLs | Database, Salesforce, HTTP configs |
| Properties | `*.yaml`, `*.properties` | Environment-specific values |
| Tests | `src/test/munit/*.xml` | MUnit test suites and mocks |

## CONTENT GENERATION STRATEGY

### API Layer Detection

**Step 1**: Analyze project name and structure to identify API layer:

- **Experience API**: `*-experience-api`, `*-mobile-api`, `*-web-api`
  - Contains RAML specification
  - Applies security policies
  - Channel-specific transformations
  - No business logic

- **Process API**: `*-process-api`, `*-orchestration-api`
  - Orchestrates multiple System APIs
  - Business logic and rules
  - Data aggregation
  - Transaction coordination

- **System API**: `*-system-api`, `*-db-api`, `*-salesforce-api`
  - Direct backend connectivity
  - CRUD operations only
  - No business logic
  - Single source/destination

**Step 2**: Adapt documentation based on layer:

#### Experience API Documentation Focus
- RAML API design and consumer contracts
- Security policy application
- Request/response transformation
- Rate limiting and throttling
- Client-specific payload optimization

#### Process API Documentation Focus
- Business process flows
- Multi-system orchestration
- Business rule implementation
- Transaction management
- Error handling strategies

#### System API Documentation Focus
- Connector configuration details
- Database query documentation
- Backend system authentication
- Data mapping (system ↔ canonical)
- Connection pooling settings

### MuleSoft-Specific Documentation Patterns

#### Flow-by-Flow Documentation

For each major Mule flow:

1. **Document the flow name and purpose**
2. **Show HTTP listener/trigger configuration**
3. **Diagram the flow sequence** (listener → router → transform → connector → response)
4. **Document DataWeave transformations** used in the flow
5. **Show connector operations** and configurations
6. **Document error handling** (try scope, error handlers)
7. **Include MUnit test** for the flow

#### RAML-First Documentation

When RAML exists:

1. **Extract resource paths** from RAML
2. **Document HTTP methods** (GET, POST, PUT, DELETE, PATCH)
3. **Show request/response examples** from RAML examples
4. **Document data types** and validation rules
5. **Show security schemes** (OAuth 2.0, Client ID Enforcement)
6. **Reference traits and resource types** used

#### DataWeave Documentation

For each transformation:

1. **Show input payload structure**
2. **Show DataWeave script** with annotations
3. **Show output payload structure**
4. **Document reusable DW modules** if used
5. **Explain transformation logic**

### Universal MuleSoft Documentation Elements

Document these standard MuleSoft patterns:

1. **HTTP Listener Configuration**:
   - Host and port bindings
   - Base path
   - TLS configuration (if HTTPS)

2. **APIkit Router**:
   - RAML specification reference
   - Flow mappings
   - Console URL

3. **Global Error Handler**:
   - Error type handling
   - Error response transformations
   - Logging strategies

4. **Configuration Properties**:
   - `dev.yaml`, `test.yaml`, `prod.yaml`
   - Secure properties encryption
   - Property placeholders (`${property.name}`)

5. **Connector Patterns**:
   - Database: Connection pooling, query parameterization
   - HTTP Request: OAuth, retry policies, timeouts
   - Salesforce: Authentication, query operations
   - File: Read/write operations, directory polling

6. **DataWeave Best Practices**:
   - Reusable modules in `dwl/` directory
   - Common functions (date formatting, string utils)
   - Lookup tables and mappings

## QUALITY ASSURANCE

### MuleSoft-Specific Validation

- [ ] **RAML Documentation**: All endpoints from RAML are documented
- [ ] **Flow Coverage**: All main flows are documented with diagrams
- [ ] **DataWeave**: All transformations have input/output examples
- [ ] **Connectors**: All connector configs are documented
- [ ] **Properties**: Environment-specific configs are explained
- [ ] **Error Handling**: Global and flow-level error handlers are documented
- [ ] **Testing**: MUnit test examples are included
- [ ] **Security**: Authentication mechanisms are clearly explained

### Code Example Accuracy

- [ ] XML examples are well-formed and valid
- [ ] DataWeave scripts are syntactically correct
- [ ] RAML examples follow RAML 1.0 specification
- [ ] Property file examples use correct syntax
- [ ] Connector configurations match connector documentation
- [ ] MUnit tests are runnable

## OUTPUT DELIVERY

After generating documentation:

1. **Create** the `docs/` directory
2. **Generate** MuleSoft-specific documentation files
3. **Extract** API flows from RAML and Mule XMLs
4. **Document** DataWeave transformations
5. **Create** navigation index in `docs/README.md`
6. **Validate** all code references point to actual files
7. **Provide** summary report with:
   - API layer type (Experience/Process/System)
   - Number of flows documented
   - Connectors used
   - DataWeave transformations count
   - RAML version and endpoints count
   - Mule runtime version

---

## REFERENCE: MuleSoft Documentation Patterns

Below are reference examples specific to MuleSoft applications.

### Example: API-Led Connectivity Architecture

````markdown
# System Architecture Overview

## API-Led Connectivity Architecture

This application follows MuleSoft's **API-Led Connectivity** pattern with three layers:

```mermaid
graph TB
    subgraph Experience["EXPERIENCE API LAYER"]
        Mobile[Mobile Experience API<br/>Port: 8081]
        Web[Web Experience API<br/>Port: 8082]
    end

    subgraph Security["Security & Policies"]
        OAuth[OAuth 2.0 Validation]
        ClientID[Client ID Enforcement]
        RateLimit[Rate Limiting Policy]
    end

    subgraph Process["PROCESS API LAYER"]
        Onboarding[Customer Onboarding Process API<br/>Port: 8091]
    end

    subgraph System["SYSTEM API LAYER"]
        CustomerDB[Customer DB System API<br/>Port: 8101]
        Salesforce[Salesforce System API<br/>Port: 8102]
    end

    subgraph Backend["Backend Systems"]
        MySQL[(MySQL Database)]
        SFDC[Salesforce Cloud]
    end

    Mobile --> OAuth
    Web --> OAuth
    OAuth --> ClientID
    ClientID --> RateLimit
    RateLimit --> Onboarding
    Onboarding --> CustomerDB
    Onboarding --> Salesforce
    CustomerDB --> MySQL
    Salesforce --> SFDC
```

## Request Flow

```mermaid
sequenceDiagram
    participant Client
    participant ExpAPI as Experience API
    participant Auth as OAuth Server
    participant ProcAPI as Process API
    participant SysDB as System API (DB)
    participant Database

    Client->>ExpAPI: POST /api/v1/customers<br/>client_id + client_secret
    ExpAPI->>Auth: Validate Client Credentials
    Auth-->>ExpAPI: Access Token
    ExpAPI->>ExpAPI: Apply Rate Limiting
    ExpAPI->>ExpAPI: Validate RAML Schema
    ExpAPI->>ProcAPI: POST /process/customers<br/>Bearer Token
    ProcAPI->>ProcAPI: Apply Business Rules
    ProcAPI->>SysDB: POST /system/customers
    SysDB->>Database: INSERT INTO customers
    Database-->>SysDB: Customer Created
    SysDB-->>ProcAPI: Customer ID
    ProcAPI-->>ExpAPI: Complete Record
    ExpAPI-->>Client: 201 Created
```

## Core Components

### Experience API Layer
- **Technology**: Mule 4.4 with APIkit Router
- **Purpose**: Channel-specific endpoints for mobile, web, partners
- **Features**:
  - OAuth 2.0 and Client ID enforcement
  - RAML schema validation
  - Rate limiting and throttling
  - Client-optimized response transformation

### Process API Layer
- **Technology**: Mule 4.4 with orchestration flows
- **Purpose**: Business logic and multi-system orchestration
- **Features**:
  - Business rule application
  - Multi-system API calls (parallel and sequential)
  - Data aggregation and enrichment
  - Transaction coordination

### System API Layer
- **Technology**: Mule 4.4 with Database/Salesforce Connectors
- **Purpose**: Direct backend system access
- **Features**:
  - CRUD operations on databases
  - SaaS connector operations (Salesforce, SAP)
  - Connection pooling
  - No business logic - data access only
```
````

### Example: Mule Flow Documentation

````markdown
# Customer API Flows

## Main Flow: get-customers-flow

**Purpose**: Retrieve paginated list of customers from database

**HTTP Listener**: `GET /api/customers`

**Flow Diagram**:

```mermaid
flowchart LR
    A[HTTP Listener<br/>GET /customers] --> B[Logger<br/>Log Request]
    B --> C[Set Variables<br/>page, limit]
    C --> D[Database Select<br/>Query Customers]
    D --> E[Transform Message<br/>DataWeave]
    E --> F[Logger<br/>Log Response]
    F --> G[HTTP Response<br/>200 OK]

    D -.->|Error| H[On Error Propagate<br/>DB Error Handler]
    H --> I[Transform Error<br/>Error Response]
    I --> J[HTTP Response<br/>500 Error]
```

**Flow XML**:

```xml
<flow name="get-customers-flow">
    <http:listener config-ref="HTTP_Listener_config" path="/customers"/>

    <logger level="INFO"
            message="Get customers request - Page: #[attributes.queryParams.page default 1]"/>

    <set-variable variableName="page"
                  value="#[attributes.queryParams.page default 1]"/>
    <set-variable variableName="limit"
                  value="#[attributes.queryParams.limit default 20]"/>

    <db:select config-ref="Database_Config">
        <db:sql><![CDATA[
            SELECT customer_id, first_name, last_name, email, phone_number, status
            FROM customers
            WHERE status = 'active'
            ORDER BY created_date DESC
            LIMIT :limit OFFSET :offset
        ]]></db:sql>
        <db:input-parameters><![CDATA[#[{
            limit: vars.limit,
            offset: (vars.page - 1) * vars.limit
        }]]]></db:input-parameters>
    </db:select>

    <ee:transform>
        <ee:message>
            <ee:set-payload><![CDATA[%dw 2.0
output application/json
---
{
    customers: payload map (customer) -> {
        customerId: customer.customer_id,
        firstName: customer.first_name,
        lastName: customer.last_name,
        email: customer.email,
        phoneNumber: customer.phone_number,
        status: customer.status
    },
    pagination: {
        currentPage: vars.page,
        pageSize: vars.limit,
        totalRecords: sizeOf(payload)
    }
}]]></ee:set-payload>
        </ee:message>
    </ee:transform>

    <logger level="INFO" message="Returning #[sizeOf(payload.customers)] customers"/>

    <error-handler>
        <on-error-propagate type="DB:CONNECTIVITY">
            <ee:transform>
                <ee:message>
                    <ee:set-payload><![CDATA[%dw 2.0
output application/json
---
{
    error: {
        code: "DATABASE_ERROR",
        message: "Failed to connect to database",
        details: error.description
    }
}]]></ee:set-payload>
                </ee:message>
                <ee:variables>
                    <ee:set-variable variableName="httpStatus">500</ee:set-variable>
                </ee:variables>
            </ee:transform>
        </on-error-propagate>
    </error-handler>
</flow>
```

**DataWeave Transformation**:

**Input (Database Result)**:
```json
[
  {
    "customer_id": "CUST-001",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john@example.com",
    "phone_number": "+1-555-0100",
    "status": "active"
  }
]
```

**Output (API Response)**:
```json
{
  "customers": [
    {
      "customerId": "CUST-001",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john@example.com",
      "phoneNumber": "+1-555-0100",
      "status": "active"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "pageSize": 20,
    "totalRecords": 1
  }
}
```

**MUnit Test**:

```xml
<munit:test name="get-customers-flow-test">
    <munit:execution>
        <munit:set-event>
            <munit:attributes>
                <munit:attribute attributeName="queryParams"
                                 value="#[{'page': 1, 'limit': 10}]"/>
            </munit:attributes>
        </munit:set-event>

        <flow-ref name="get-customers-flow"/>
    </munit:execution>

    <munit:validation>
        <munit-tools:assert-that expression="#[payload.customers]"
                                 is="#[MunitTools::notNullValue()]"/>
        <munit-tools:assert-equals actual="#[payload.pagination.currentPage]"
                                   expected="#[1]"/>
    </munit:validation>
</munit:test>
```
```
````

### Example: RAML API Specification

```markdown
# API Specification

## RAML Definition

**File**: `src/main/resources/api/customer-api.raml`

\`\`\`yaml
#%RAML 1.0
title: Customer System API
version: v1
baseUri: https://customer-api.cloudhub.io/api/{version}

securitySchemes:
  client_credentials:
    type: OAuth 2.0
    settings:
      accessTokenUri: https://oauth.example.com/token
      authorizationGrants: [client_credentials]

types:
  Customer:
    properties:
      customerId: string
      firstName: string
      lastName: string
      email: string
      phoneNumber?: string
      status: string

/customers:
  get:
    description: Retrieve list of customers
    securedBy: [client_credentials]
    queryParameters:
      page:
        type: integer
        default: 1
      limit:
        type: integer
        default: 20
        maximum: 100
    responses:
      200:
        body:
          application/json:
            type: Customer[]
            example: |
              {
                "customers": [
                  {
                    "customerId": "CUST-001",
                    "firstName": "John",
                    "lastName": "Doe",
                    "email": "john@example.com",
                    "status": "active"
                  }
                ]
              }
  post:
    description: Create new customer
    securedBy: [client_credentials]
    body:
      application/json:
        type: Customer
        example: |
          {
            "firstName": "Jane",
            "lastName": "Smith",
            "email": "jane@example.com"
          }
    responses:
      201:
        body:
          application/json:
            type: Customer
\`\`\`

## Generated APIkit Routes

The APIkit router automatically generates these flow references from RAML:

- `get:/customers:customer-api-config` → `get-customers-flow`
- `post:/customers:customer-api-config` → `post-customer-flow`
- `get:/customers/{customerId}:customer-api-config` → `get-customer-by-id-flow`
```

### Example: DataWeave Module

```markdown
# DataWeave Transformation Modules

## Common Utilities Module

**File**: `src/main/resources/dwl/common/DateUtils.dwl`

\`\`\`dataweave
%dw 2.0

/**
 * Reusable date/time utility functions
 */

/**
 * Formats a DateTime to ISO 8601 string
 * @param dateTime The DateTime to format
 * @return Formatted ISO 8601 string
 */
fun formatISO(dateTime: DateTime): String =
    dateTime as String {format: "yyyy-MM-dd'T'HH:mm:ss'Z'"}

/**
 * Converts timestamp (epoch milliseconds) to DateTime
 * @param timestamp Epoch milliseconds
 * @return DateTime object
 */
fun fromTimestamp(timestamp: Number): DateTime =
    timestamp as DateTime

/**
 * Calculates age from birthdate
 * @param birthDate The birth date
 * @return Age in years
 */
fun calculateAge(birthDate: Date): Number =
    ((now() - birthDate).days / 365) as Number {format: "#"}
\`\`\`

## Usage Example

\`\`\`dataweave
%dw 2.0
output application/json
import * from dwl::common::DateUtils

---
{
    processedDate: formatISO(now()),
    customerAge: calculateAge(payload.birthDate as Date),
    timestamp: fromTimestamp(payload.createdTimestamp)
}
\`\`\`
```

---

**End of Template**

Focus on documenting MuleSoft's API-Led Connectivity patterns, DataWeave transformations, and integration best practices.