Overview

Workflows Studio uses AI to automatically generate documentation and change logs for your workflow applications. This saves time and ensures your documentation stays current with every release.

Key capabilities:

• Automatic documentation generation when you publish an application
• Change log generation that compares versions and highlights differences
• Support for different application types (Standard, Utility, List Views)
• Option to add your own business context to enhance AI output
• Complete audit trail of all generation activities

---

Generating Documentation

Automatic Generation on Publish

When you publish an application, documentation is generated automatically:

1. Click Publish to publish your application
2. A success message confirms the publish
3. Documentation generation starts in the background
4. A status indicator shows progress (In Progress → Completed)
5. The documentation is saved to the published version

You don't need to take any extra steps—the system handles this for you.

Manual Regeneration

You can regenerate documentation anytime from the Documentation tab:

1. Open your application in Workflows Studio
2. Go to the Documentation tab
3. Click Document via AI
4. Wait for generation to complete

Note: Documentation requires at least one published version. The AI analyzes the active published version.

What Gets Documented

The AI documents these aspects of your application:

• Overview — Purpose and description
• Forms — Fields, validations, and sections
• Workflow Logic — Process flow, decisions, and branches
• Integrations — Connected systems and APIs
• Permissions — Access controls and roles

Documentation Strategies

The system selects the right approach based on your application type:

---

Generating Change Logs

When publishing a new version, you can generate release notes that detail all changes.

How It Works

1. Make changes to your draft application
2. Before publishing, click Generate Change Log
3. Optionally add context explaining why changes were made
4. Review the generated change log
5. Publish your application

What Gets Compared

The system compares your draft against the active version:

Adding Business Context

You can provide context about why changes were made:

Example: "Updated approval workflow to include finance review 
for requests over $5,000 per new company policy."

The AI incorporates this into a "Change Motivation" section, making your change logs more meaningful for stakeholders.

---

Combining AI and Manual Content

You can enhance AI-generated documentation with your own content:

1. Wait for AI generation to complete
2. Switch to Edit mode in the Documentation tab
3. Add your own sections or details
4. Save the combined documentation

Note: Regenerating documentation replaces existing content. Save manual additions elsewhere before regenerating.

---

Best Practices

For documentation:

• Review auto-generated docs after publishing
• Add business context and examples the AI might miss
• Regenerate manually if you need to capture significant updates

For change logs:

• Always add context explaining why changes were made
• Review to verify all significant changes are captured
• Archive important logs for compliance needs