Loading…
Workflow goal
Analyze the quality of existing documentations
Variable Source Value Phase Status
Feature
Empty
Insurance Policy Documentation
Empty
Frontend Application Documentation
Empty

Feature

Insurance Policy Documentation

Frontend Application Documentation

1 Structure Analysis
Analyze documentation structure and organization
pending
Value will be available once processing is complete.
Input will be available once processing is complete.
System Prompt (raw)
You are a technical documentation expert specializing in software documentation analysis.
Your task is to analyze the structure and organization of technical documentation.

Focus on evaluating:
1. Document organization and hierarchy
2. Section logical flow
3. Information architecture
4. Navigation and discoverability
5. Consistency in formatting
6. Cross-referencing effectiveness
User Prompt (raw)
Documentation Topic: {userInput}

Analyze the structure of these documentation sources:
- Insurance Policy Documentation: {insurance_policy_documentation}
- Frontend Application Documentation: {frontend_application}

Evaluate the documentation structure:

1. **Organization Assessment**
   - Logical hierarchy
   - Section arrangement
   - Topic grouping
   - Navigation paths

2. **Content Flow**
   - Introduction to advanced progression
   - Prerequisite handling
   - Concept building
   - Example placement

3. **Information Architecture**
   - Categorization effectiveness
   - Search-ability
   - Index quality
   - Cross-references

4. **Format Consistency**
   - Heading styles
   - List formatting
   - Code block presentation
   - Terminology usage

5. **Specific Focus: $300 Deductible**
   - Coverage completeness
   - Integration with other sections
   - Example clarity
   - Business rule documentation

Provide a detailed structural analysis with specific examples.
2 Completeness Assessment
Assess documentation completeness
pending
Value will be available once processing is complete.
Input will be available once processing is complete.
System Prompt (raw)
You are a documentation completeness auditor with expertise in technical documentation standards.
Your task is to assess whether all necessary topics are adequately covered.
User Prompt (raw)
Structure Analysis: {structure_analysis}

Documentation Sources:
- Insurance Policy: {insurance_policy_documentation}
- Frontend Application: {frontend_application}

Assess documentation completeness:

1. **Core Topics Coverage**
   - Feature descriptions
   - Technical specifications
   - Business rules
   - User workflows
   - API documentation
   - Configuration guides

2. **$300 Deductible Coverage**
   - Eligibility criteria completeness
   - Premium calculation documentation
   - State-specific rules
   - Integration points
   - UI/UX requirements
   - Claims processing

3. **Supporting Information**
   - Prerequisites
   - Installation/setup
   - Troubleshooting
   - FAQs
   - Glossary
   - References

4. **Code Examples**
   - Implementation samples
   - Configuration examples
   - API usage
   - Error handling
   - Best practices

5. **Visual Elements**
   - Diagrams where needed
   - Screenshots appropriateness
   - Tables for data
   - Flow charts for processes

Rate completeness (0-100%) for each area and identify missing elements.
3 Gap Identification
Identify specific documentation gaps
pending
Value will be available once processing is complete.
Input will be available once processing is complete.
System Prompt (raw)
You are a documentation gap analysis specialist.
Your task is to identify specific gaps and missing information in the documentation.
User Prompt (raw)
Completeness Assessment: {completeness_assessment}

Structure Analysis: {structure_analysis}

Identify documentation gaps:

1. **Critical Missing Information**
   - Undocumented features
   - Missing business rules
   - Incomplete workflows
   - Absent error scenarios
   - Missing integration details

2. **$300 Deductible Gaps**
   - Missing eligibility scenarios
   - Incomplete premium calculations
   - Undocumented edge cases
   - Missing state variations
   - Incomplete migration guide

3. **Technical Gaps**
   - Missing API endpoints
   - Undocumented parameters
   - Incomplete data models
   - Missing configuration options
   - Absent performance guidelines

4. **User Documentation Gaps**
   - Missing user guides
   - Incomplete tutorials
   - Absent troubleshooting steps
   - Missing FAQ entries
   - Incomplete examples

5. **Quality Gaps**
   - Outdated information
   - Inconsistent terminology
   - Conflicting instructions
   - Ambiguous descriptions
   - Missing version information

For each gap, specify:
- Gap description
- Impact (High/Medium/Low)
- Priority for fixing
- Suggested content to add
4 Improvement Suggestions
Suggest specific documentation improvements
pending
Value will be available once processing is complete.
Input will be available once processing is complete.
System Prompt (raw)
You are a documentation improvement consultant specializing in technical documentation enhancement.
Your task is to provide actionable improvement recommendations.
User Prompt (raw)
Gap Identification: {gap_identification}

Completeness Assessment: {completeness_assessment}

Structure Analysis: {structure_analysis}

Suggest documentation improvements:

1. **Content Additions**
   - New sections to add
   - Examples to include
   - Diagrams to create
   - Tables to add
   - Code samples needed

2. **Structure Improvements**
   - Reorganization suggestions
   - Navigation enhancements
   - Cross-reference additions
   - Index improvements
   - Search optimization

3. **Clarity Enhancements**
   - Ambiguous sections to clarify
   - Technical jargon to explain
   - Complex concepts to simplify
   - Visual aids to add
   - Examples to expand

4. **$300 Deductible Improvements**
   - Comprehensive eligibility matrix
   - Premium calculation examples
   - State-by-state guide
   - Migration checklist
   - Testing scenarios

5. **Quality Improvements**
   - Consistency fixes
   - Terminology standardization
   - Format unification
   - Version tracking
   - Review process

Provide specific, actionable recommendations with examples.
5 Enhanced Documentation
Generate enhanced documentation sections
pending
Value will be available once processing is complete.
Input will be available once processing is complete.
System Prompt (raw)
You are a technical writer specializing in creating clear, comprehensive documentation.
Your task is to generate enhanced documentation that addresses identified gaps and improvements.
User Prompt (raw)
Improvement Suggestions: {improvement_suggestions}

Gap Identification: {gap_identification}

Original Documentation:
- Insurance Policy: {insurance_policy_documentation}
- Frontend Application: {frontend_application}

Generate enhanced documentation:

# Enhanced Insurance Policy Management Documentation

## 1. Executive Summary
[Provide clear overview with key features including $300 deductible]

## 2. $300 Deductible Feature - Complete Guide

### 2.1 Overview
[Comprehensive description of the new feature]

### 2.2 Eligibility Requirements
```
| Criteria | Requirement | Notes |
|----------|------------|-------|
| Minimum Coverage | $25,000 | Required for all states |
| Credit Score | ≥650 | Soft pull only |
| Claims History | <2 in 3 years | Major claims only |
| Policy Age | New or renewal | Available for both |
```

### 2.3 Premium Calculation
[Detailed calculation formula with examples]

### 2.4 State-Specific Rules
[Complete state-by-state variations]

### 2.5 Implementation Guide
```javascript
// Example implementation
const calculate300DeductiblePremium = (coverage, state, creditScore) => {
    // Implementation details
};
```

## 3. Frontend Integration

### 3.1 UI Components
[Enhanced component documentation]

### 3.2 User Workflows
[Step-by-step user journeys]

### 3.3 API Reference
[Complete API documentation]

## 4. Testing Guide
[Comprehensive testing scenarios]

## 5. Troubleshooting
[Common issues and solutions]

## 6. FAQ
[Frequently asked questions]

## 7. Glossary
[Term definitions]

Generate complete enhanced documentation addressing all identified gaps.
6 Quality Report
Create comprehensive quality assessment report
pending
Value will be available once processing is complete.
Input will be available once processing is complete.
System Prompt (raw)
You are a documentation quality assurance specialist.
Your task is to create a comprehensive quality assessment report.
User Prompt (raw)
Analysis Results:
- Structure Analysis: {structure_analysis}
- Completeness Assessment: {completeness_assessment}
- Gap Identification: {gap_identification}
- Improvement Suggestions: {improvement_suggestions}
- Enhanced Documentation: {enhanced_documentation}

Create quality assessment report:

# Documentation Quality Assessment Report

## Executive Summary
- Overall quality score
- Critical findings
- Key recommendations
- Implementation priority

## Current State Assessment

### Structure Quality
- Organization: [Score/100]
- Navigation: [Score/100]
- Consistency: [Score/100]
- Overall: [Score/100]

### Content Completeness
- Core Features: [%]
- Technical Details: [%]
- User Documentation: [%]
- $300 Deductible: [%]
- Overall: [%]

### Identified Gaps Summary
| Category | Gap Count | Critical | High | Medium | Low |
|----------|-----------|----------|------|--------|-----|
| Features | X | X | X | X | X |
| Technical | X | X | X | X | X |
| User Docs | X | X | X | X | X |

## Improvement Roadmap

### Phase 1: Critical Updates (Week 1-2)
- [List critical improvements]

### Phase 2: High Priority (Week 3-4)
- [List high priority improvements]

### Phase 3: Enhancement (Week 5-6)
- [List enhancement items]

## Quality Metrics

### Before Enhancement
- Completeness: X%
- Clarity: X/10
- Structure: X/10
- Usability: X/10

### After Enhancement
- Completeness: X%
- Clarity: X/10
- Structure: X/10
- Usability: X/10

## Recommendations

### Immediate Actions
1. [Action items]

### Process Improvements
1. [Process recommendations]

### Maintenance Plan
1. [Ongoing maintenance]

## Conclusion
[Summary and next steps]

Generate complete quality assessment report.