Wiki

Scale Your Enterprise

User Tools

Site Tools

Trace: • ai_document_generation • Bizweaver API • Configuring Links
bizweaver:ai_document_generation

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
bizweaver:ai_document_generation [2025/12/05 11:21]
afernandes 		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 65: Line 57:
  
 **4.1 Step-by-Step Process** **4.1 Step-by-Step Process**
-Click the Documentation button in the workflow designer toolbar. 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
  
 +**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 107: Line 82:
   * "Processing with AI..." message   * "Processing with AI..." message
  
 +{{ :bw2:bw-ai-doc-figure3.png |}}
  
  
- +//Figure 3: Documentation Generation Progress Dialog//
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
-Figure 3: Documentation Generation Progress Dialog +
- +
-  +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
  
  
Line 158: Line 97:
  
  
 +{{ :bw2:bw-ai-doc-figure4.png |}}
  
  
 +//Figure 4: Successful Documentation Generation Confirmation//
  
 +**4.2 What Gets Generated**
  
- 
- 
- 
- 
- 
- 
- 
-Figure 4: Successful Documentation Generation Confirmation 
- 
-**4.2 What Gets Generated** 
 The AI analyzes your workflow and creates a structured document containing: The AI analyzes your workflow and creates a structured document containing:
  
Line 180: Line 112:
  
 **Purpose Statement** **Purpose Statement**
 +
 A clear explanation of what the workflow accomplishes and why it exists. A clear explanation of what the workflow accomplishes and why it exists.
  
 **Step-by-Step Description** **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
Line 191: Line 125:
    
  
 +{{ :bw2:bw-ai-doc-figure5.png |}}
  
  
- +//Figure 5: Sample Generated Documentation in Microsoft Word//
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
-Figure 5: Sample Generated Documentation in Microsoft Word+
  
  
Line 224: Line 139:
 **Step 1: Click the Documentation Button** **Step 1: Click the Documentation Button**
  
 +{{ :bw2:bw-ai-doc-step5-1.png |}}
  
  
Line 240: Line 155:
   * Share with team members   * Share with team members
  
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
-  
-   
    
- 
  
  
Line 262: Line 161:
  
 **Changes** **Changes**
 +
 When you modify a workflow that has existing documentation, Bizweaver automatically detects that the documentation is outdated. When you modify a workflow that has existing documentation, Bizweaver automatically detects that the documentation is outdated.
 +
 **6.1 Outdated Documentation Indicator** **6.1 Outdated Documentation Indicator**
  
Line 315: Line 216:
    
  
 +{{ :bw2:bw-ai-doc-step6-2-1.png |}}
 +{{ :bw2:bw-ai-doc-step6-2-2.png |}}
  
  
Line 320: 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**
  
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
-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. 
-  
-**7. Best Practices** 
  
 **7.1 When to Generate Documentation** **7.1 When to Generate Documentation**
  
-    * Immediately after creating a new workflow+  * Immediately after creating a new workflow
   *  Before deploying to production   *  Before deploying to production
   *  After significant workflow modifications   *  After significant workflow modifications
Line 398: Line 252:
 **7.2 When to Regenerate Documentation** **7.2 When to Regenerate Documentation**
  
-    * Whenever the "Document is out of date" warning appears + 
-  *   After adding or removing workflow steps +  * Whenever the "Document is out of date" warning appears 
-  *   When changing workflow logic or conditions +  * After adding or removing workflow steps 
-  *   After updating variables or parameters +  * When changing workflow logic or conditions 
-  *   Before major releases or deployments+  * After updating variables or parameters 
 +  * Before major releases or deployments 
  
 **7.3 Documentation Maintenance Tips** **7.3 Documentation Maintenance Tips**
 +
   * Regular Updates: Make documentation regeneration part of your workflow development process   * 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   * Review Generated Content: Always review AI-generated documentation to ensure it accurately reflects your intentions
Line 410: Line 267:
   * Share with Stakeholders: Use generated documentation for training, knowledge transfer, and compliance   * Share with Stakeholders: Use generated documentation for training, knowledge transfer, and compliance
   * Archive Important Versions: Save copies of documentation for major releases or milestones   * Archive Important Versions: Save copies of documentation for major releases or milestones
 +
  
  
Line 419: Line 277:
  
 **8. Summary** **8. Summary**
 +
  
 The AI Document Generation feature in Bizweaver 2025R2 provides: The AI Document Generation feature in Bizweaver 2025R2 provides:
 +
     * Automatic creation of comprehensive workflow documentation     * Automatic creation of comprehensive workflow documentation
   *  Intelligent tracking of documentation status   *  Intelligent tracking of documentation status
Line 427: Line 287:
   *  Professional formatting in Microsoft Word format   *  Professional formatting in Microsoft Word format
   *  Centralized storage for easy access and sharing   *  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.1764951719.txt.gz · Last modified: 2025/12/05 11:21 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