Wiki

Scale Your Enterprise

User Tools

Site Tools

Trace: • Standard Buttons
bizweaver:ai_document_generation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision 		Previous revision
bizweaver:ai_document_generation [2025/12/05 10:54]
afernandes created 		bizweaver:ai_document_generation [2026/04/24 09:52] (current)
dtucker
Line 1: Line 1:
 +**OpenAI API Key Configuration**
 +
 +Before using the AI Document Generation feature, a valid OpenAI API key must be configured in Bizweaver. This is a one-time setup that must be completed by a system administrator.
 +
 +**To configure the OpenAI API key:**
 +
 +  * Navigate to Admin → Configuration → External Integration
 +  * Locate the OpenAI API Key field in the configuration panel
 +  * Enter your valid OpenAI API key in the designated field
 +  * Click Save to store the configuration
 +
 +<WRAP center round info>
 +You can obtain an OpenAI API key by creating an account on the OpenAI platform at platform.openai.com and generating an API key from your account dashboard. This configuration only needs to be performed once by the system administrator. **This will need to be done using a paid OpenAI account.**
 +</WRAP>
 +
 +{{ :bw2:bw-ai-doc-pre-req.png |}}
  
 **1. Overview** **1. Overview**
Line 12: Line 28:
  
   *  Time Savings: Eliminate hours of manual documentation writing   *  Time Savings: Eliminate hours of manual documentation writing
-  *   
   *  Consistency: Ensure standardized documentation across all workflows   *  Consistency: Ensure standardized documentation across all workflows
   *  Accuracy: AI analyzes actual workflow logic to create precise documentation   *  Accuracy: AI analyzes actual workflow logic to create precise documentation
Line 22: Line 37:
  
 ** Accessing the Documentation Feature** ** Accessing the Documentation Feature**
 +
 The Documentation feature is accessible from the workflow designer interface: The Documentation feature is accessible from the workflow designer interface:
   - Open your workflow in the Bizweaver Designer   - Open your workflow in the Bizweaver Designer
Line 28: Line 44:
  
  
 +{{ :bw2:bw-ai-doc-figure1.png |}}
  
  
  
- +//Figure 1: Workflow Designer Interface with Documentation Button//
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
-Figure 1: Workflow Designer Interface with Documentation Button+
  
  
Line 66: Line 58:
 **4.1 Step-by-Step Process** **4.1 Step-by-Step Process**
  
 +**Step 1: Access the Documentation Menu**
  
 +Click the Documentation button in the workflow designer toolbar.
  
  
 +{{ :bw2:bw-ai-doc-figure2.png |}}
  
- +//Figure 2: Documentation Button with Available Options//
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
-Figure 2: Documentation Button with Available Options+
  
    
Line 96: Line 71:
  
  
 +**Step 2: Select "Generate Document"**
  
 +From the dropdown menu, click "Generate Document" to initiate the AI documentation generation process.
  
 +**Step 3: Wait for Generation to Complete**
  
 +The system will display a progress dialog showing: 
 +  * Current generation status
 +  * Progress percentage
 +  * "Processing with AI..." message
  
 +{{ :bw2:bw-ai-doc-figure3.png |}}
  
  
 +//Figure 3: Documentation Generation Progress Dialog//
  
  
  
  
 +**Step 4: Confirmation**
  
 +When complete, you'll see a success message:
 +"Document generated successfully!"
 +Click OK to close the dialog. Your documentation has been created and saved.
  
  
 +{{ :bw2:bw-ai-doc-figure4.png |}}
  
  
 +//Figure 4: Successful Documentation Generation Confirmation//
  
 +**4.2 What Gets Generated**
  
 +The AI analyzes your workflow and creates a structured document containing:
  
 +**Workflow Metadata**
 +    * Workflow ID
 +  *  Workflow Name
 +  *  Generation Date and Time
  
 +**Purpose Statement**
  
 +A clear explanation of what the workflow accomplishes and why it exists.
  
 +**Step-by-Step Description**
  
- 
- 
- 
- 
- 
-Figure 3: Documentation Generation Progress Dialog 
- 
-  
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
-Figure 4: Successful Documentation Generation Confirmation 
- 
-4.2 What Gets Generated 
-The AI analyzes your workflow and creates a structured document containing: 
- 
-Workflow Metadata 
-  Workflow ID 
-  Workflow Name 
-  Generation Date and Time 
- 
-Purpose Statement 
-A clear explanation of what the workflow accomplishes and why it exists. 
- 
-Step-by-Step Description 
 Detailed breakdown of each workflow action including: Detailed breakdown of each workflow action including:
-  Action name and purpose +    * Action name and purpose 
-  Method used +  *  Method used 
-  Variables involved +  *  Variables involved 
-  Arguments and parameters +  *  Arguments and parameters 
-  Data flow between steps+  *  Data flow between steps
    
  
 +{{ :bw2:bw-ai-doc-figure5.png |}}
  
  
 +//Figure 5: Sample Generated Documentation in Microsoft Word//
  
  
- +**5. Viewing Existing Documentation**
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
-Figure 5: Sample Generated Documentation in Microsoft Word +
- +
- +
-5. Viewing Existing Documentation+
  
 Once documentation has been generated, you can view it at any time. Once documentation has been generated, you can view it at any time.
  
-5.1 Accessing Existing Documentation+**5.1 Accessing Existing Documentation**
  
 +**Step 1: Click the Documentation Button**
  
 +{{ :bw2:bw-ai-doc-step5-1.png |}}
  
  
 +**Step 2: Select "Open Existing"**
  
 +From the dropdown menu, click "Open Existing" to view the generated documentation.
  
  
 +**Step 3: Review Documentation**
  
 +The documentation opens in Microsoft Word (or your default document viewer), allowing you to:
 +  * Read the complete workflow description 
 +  * Copy sections for other documentation 
 +  * Print for offline reference
 +  * Share with team members
  
 + 
  
  
 +**6. Regenerating Documentation After Workflow** 
  
 +**Changes**
  
 +When you modify a workflow that has existing documentation, Bizweaver automatically detects that the documentation is outdated.
  
 +**6.1 Outdated Documentation Indicator**
  
- 
- 
- 
- 
- 
- 
-  
-   
-  
- 
- 
- 
-6. Regenerating Documentation After Workflow Changes 
-When you modify a workflow that has existing documentation, Bizweaver automatically detects that the documentation is outdated. 
-6.1 Outdated Documentation Indicator 
 After making workflow changes, the Documentation button displays: "Document is out of date" After making workflow changes, the Documentation button displays: "Document is out of date"
    
Line 269: Line 199:
  
  
-6.2 Options for Outdated Documentation+**6.2 Options for Outdated Documentation** 
 When documentation is out of date, you have two options: When documentation is out of date, you have two options:
  
-Option 1: Open Existing (View Outdated Documentation)+**Option 1: Open Existing (View Outdated Documentation)**
  
 Click "Open Existing" to view the previous version of the documentation. This can be useful for: Click "Open Existing" to view the previous version of the documentation. This can be useful for:
Line 279: Line 210:
   Reference purposes   Reference purposes
  
-Option 2: Regenerate Document (Recommended)+**Option 2: Regenerate Document (Recommended)** 
 Click "Regenerate Document" to create new documentation reflecting the current workflow state. Click "Regenerate Document" to create new documentation reflecting the current workflow state.
  
    
  
 +{{ :bw2:bw-ai-doc-step6-2-1.png |}}
 +{{ :bw2:bw-ai-doc-step6-2-2.png |}}
  
  
Line 289: Line 223:
  
  
 +Figure 7: Regenerate Document Option Available
  
  
 +**6.3 Regeneration Process**
  
  
 +The regeneration process is identical to initial generation:
  
 +  - Click "Regenerate Document"
 +  - Monitor Progress:
 +  - Watch the progress dialog as the AI analyzes your updated workflow
 +  - Confirm Success: Wait for the "Document generated successfully!" message and click OK
  
 +The Documentation button will now show "Document is up to date" again.
  
 +{{ :bw2:bw-ai-doc-step6-3.png |}}
  
 +**7. Best Practices**
  
  
 +**7.1 When to Generate Documentation**
  
 +  * Immediately after creating a new workflow
 +  *  Before deploying to production
 +  *  After significant workflow modifications
 +  *  When onboarding new team members
  
 +**7.2 When to Regenerate Documentation**
  
  
 +  * Whenever the "Document is out of date" warning appears
 +  * After adding or removing workflow steps
 +  * When changing workflow logic or conditions
 +  * After updating variables or parameters
 +  * Before major releases or deployments
  
  
 +**7.3 Documentation Maintenance Tips**
  
 +  * Regular Updates: Make documentation regeneration part of your workflow development process
 +  * Review Generated Content: Always review AI-generated documentation to ensure it accurately reflects your intentions
 +  * Supplement as Needed: Add manual notes or context to generated documentation when necessary
 +  * Share with Stakeholders: Use generated documentation for training, knowledge transfer, and compliance
 +  * Archive Important Versions: Save copies of documentation for major releases or milestones
  
  
Line 315: Line 276:
  
  
 +**8. Summary**
  
  
 +The AI Document Generation feature in Bizweaver 2025R2 provides:
  
 +    * Automatic creation of comprehensive workflow documentation
 +  *  Intelligent tracking of documentation status
 +  *  Clear indicators when documentation is outdated
 +  *  Simple regeneration process to keep documentation current
 +  *  Professional formatting in Microsoft Word format
 +  *  Centralized storage for easy access and sharing
  
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
-Figure 7: Regenerate Document Option Available 
- 
-6.3 Regeneration Process 
-The regeneration process is identical to initial generation: 
-1. Click "Regenerate Document" 
-2. Monitor Progress: Watch the progress dialog as the AI analyzes your updated workflow 
-3. Confirm Success: Wait for the "Document generated successfully!" message and click OK 
- 
-The Documentation button will now show "Document is up to date" again. 
-  
-7. Best Practices 
- 
-7.1 When to Generate Documentation 
-  ✅ Immediately after creating a new workflow 
-  ✅ Before deploying to production 
-  ✅ After significant workflow modifications 
-  ✅ When onboarding new team members 
- 
-7.2 When to Regenerate Documentation 
-  ✅ Whenever the "Document is out of date" warning appears 
-  ✅ After adding or removing workflow steps 
-  ✅ When changing workflow logic or conditions 
-  ✅ After updating variables or parameters 
-  ✅ Before major releases or deployments 
- 
-7.3 Documentation Maintenance Tips 
-1. Regular Updates: Make documentation regeneration part of your workflow development process 
-2. Review Generated Content: Always review AI-generated documentation to ensure it accurately reflects your intentions 
-3. Supplement as Needed: Add manual notes or context to generated documentation when necessary 
-4. Share with Stakeholders: Use generated documentation for training, knowledge transfer, and compliance 
-5. Archive Important Versions: Save copies of documentation for major releases or milestones 
- 
- 
- 
- 
- 
- 
- 
- 
-8. Summary 
- 
-The AI Document Generation feature in Bizweaver 2025R2 provides: 
-  Automatic creation of comprehensive workflow documentation 
-  Intelligent tracking of documentation status 
-  Clear indicators when documentation is outdated 
-  Simple regeneration process to keep documentation current 
-  Professional formatting in Microsoft Word format 
-  Centralized storage for easy access and sharing 
  
 By leveraging this powerful feature, you can ensure all your workflows are properly documented, making maintenance, collaboration, and compliance significantly easier. By leveraging this powerful feature, you can ensure all your workflows are properly documented, making maintenance, collaboration, and compliance significantly easier.
bizweaver/ai_document_generation.1764950061.txt.gz · Last modified: 2025/12/05 10:54 by afernandes

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial 4.0 International
CC Attribution-Noncommercial 4.0 International Valid HTML5 Valid CSS Driven by DokuWiki