adpa-enterprise-framework-automation

Version:

Modular, standards-compliant Node.js/TypeScript automation framework for enterprise requirements, project, and data management. Provides CLI and API for BABOK v3, PMBOK 7th Edition, and DMBOK 2.0 (in progress). Production-ready Express.js API with TypeSpe

github.com/mdresch/requirements-gathering-agent

mdresch/requirements-gathering-agent

533 lines (501 loc) • 20.4 kB

Markdown

# ADPA CLI Visual Workflows ## Interactive Menu Navigation Map ``` 🚀 ADPA Interactive CLI │ ├── 1. 🚀 Quick Start │ ├── 1. New Project Setup ──────────► Environment Setup Wizard │ ├── 2. Generate Core Documents ───► Core Analysis Generation │ ├── 3. Project Charter Wizard ────► Interactive Charter Creation │ ├── 4. Stakeholder Analysis ──────► Stakeholder Management │ ├── 5. Risk Assessment ───────────► Risk & Compliance Module │ ├── 6. Environment Setup ─────────► Configuration Wizard │ ├── 7. View Templates ────────────► Template Browser │ └── 8. Back to Main Menu ─────────► Main Menu │ ├── 2. 📝 Document Generation │ ├── 1. Browse by Category ────────► Category Selection │ │ ├── PMBOK Templates (25) ─────► Project Management Docs │ │ ├── BABOK Templates (18) ─────► Business Analysis Docs │ │ ├── DMBOK Templates (22) ─────► Data Management Docs │ │ ├── Strategic Planning (12) ──► Strategic Documents │ │ ├── Technical Design (15) ────► Technical Documentation │ │ └── Quality Assurance (10) ───► QA Documentation │ ├── 2. Search Templates ──────────► Template Search Interface │ ├── 3. Generate Single Document ──► Single Doc Generation │ ├── 4. Generate Category ─────────► Batch Category Generation │ ├── 5. Generate All Documents ────► Complete Documentation Set │ ├── 6. Custom Generation ─────────► Custom Generation Options │ │ ├── Interactive Selection ────► Multi-Template Selection │ │ ├── Batch Generation ─────────► Bulk Operations │ │ ├── Custom Context ───────────► Context-Aware Generation │ │ └── Template Validation ──────► Pre-Generation Validation │ └── 7. Recent Documents ──────────► Document History │ ├── 3. 🤖 AI Configuration │ ├── 1. Configure Google AI ───────► Google AI Setup │ ├── 2. Configure OpenAI ──────────► OpenAI Setup │ ├── 3. Configure Azure OpenAI ────► Azure OpenAI Setup │ ├── 4. Test AI Connection ────────► Connection Validation │ └── 5. Provider Status ───────────► Provider Monitoring │ ├── 4. 📊 Project Management │ ├── 1. Project Analysis ──────────► Workspace Analysis │ ├── 2. Stakeholder Management ────► Stakeholder Tools │ │ ├── Stakeholder Analysis ─────► Comprehensive Analysis │ │ ├── Stakeholder Register ─────► Register Generation │ │ ├── Engagement Plan ──────────► Engagement Planning │ │ └── Complete Automation ──────► Full Stakeholder Suite │ ├── 3. Risk & Compliance ─────────► Risk Assessment Tools │ │ ├── Software Development ─────► Software Risk Assessment │ │ ├── Infrastructure ───────────► Infrastructure Risk Assessment │ │ ├── Custom Assessment ────────► Interactive Risk Assessment │ │ └── PMBOK-Only Assessment ────► PMBOK-Focused Assessment │ ├── 4. Business Analysis ─────────► Business Analysis Tools │ └── 5. Project Status ────────────► Status Monitoring │ ├── 5. 🔗 Integrations │ ├── 1. Confluence Integration ────► Confluence Management │ │ ├── Initialize Configuration ─► Confluence Setup │ │ ├── Test Connection ──────────► Connection Testing │ │ ├── Publish Documents ────────► Document Publishing │ │ └── Integration Status ───────► Status Monitoring │ ├── 2. SharePoint Integration ────► SharePoint Management │ │ ├── Initialize Configuration ─► SharePoint Setup │ │ ├── Test Connection ──────────► Connection Testing │ │ ├── Publish Documents ────────► Document Publishing │ │ └── Integration Status ───────► Status Monitoring │ ├── 3. Version Control ───────────► Git Integration │ │ ├── Initialize Repository ────► Git Setup │ │ ├── Repository Status ────────► Git Status │ │ ├── Commit Changes ───────────► Git Commit │ │ └── Push to Remote ───────────► Git Push │ ├── 4. Adobe Creative Suite ──────► Adobe Integration │ └── 5. Integration Status ────────► Overall Integration Status │ ├── 6. 📈 Analytics & Feedback │ ├── 1. Document Analytics ────────► Generation Analytics │ ├── 2. Feedback Reports ──────────► Feedback Analysis │ ├── 3. Quality Metrics ───────────► Quality Assessment │ ├── 4. Performance Insights ──────► Performance Monitoring │ └── 5. Export Reports ────────────► Data Export │ ├── 7. ⚙️ System Configuration │ ├── 1. Environment Setup ─────────► Environment Configuration │ ├── 2. Template Management ───────► Template Administration │ ├── 3. Output Configuration ──────► Output Settings │ ├── 4. Validation Settings ───────► Validation Configuration │ └── 5. System Diagnostics ────────► System Health Check │ ├── 8. 🔍 Workspace Analysis ─────────► Current Workspace Analysis │ ├── 9. ❓ Help & Documentation │ ├── 1. Getting Started Guide ─────► Onboarding Guide │ ├── 2. Command Reference ─────────► CLI Command Reference │ ├── 3. Template Guide ────────────► Template Documentation │ ├── 4. Troubleshooting ───────────► Problem Resolution │ └── 5. About ADPA ────────────────► System Information │ └── 0. 🚪 Exit ───────────────────────► Application Exit ``` ## Command Line Workflow Patterns ### 1. New Project Setup Flow ``` Start │ ├─► adpa setup --provider google-ai │ │ │ ├─► Environment Configuration │ ├─► API Key Setup │ └─► Provider Validation │ ├─► mkdir my-project && cd my-project │ ├─► adpa vcs init │ │ │ └─► Git Repository Initialization │ ├─► adpa generate-core-analysis │ │ │ ├─► Project Charter │ ├─► Stakeholder Register │ ├─► Risk Management Plan │ └─► Business Case │ ├─► adpa validate │ │ │ ├─► PMBOK Compliance Check │ ├─► Template Validation │ └─► Content Quality Assessment │ └─► adpa vcs commit --message "Initial documentation" │ └─► Version Control Commit ``` ### 2. Enterprise Documentation Flow ``` Enterprise Setup │ ├─► adpa setup --provider azure-openai --enhanced │ │ │ ├─► Enterprise AI Provider Setup │ ├─► Advanced Configuration │ └─► Security Settings │ ├─► adpa generate-all --output ./enterprise-docs --retries 3 │ │ │ ├─► PMBOK Documents (25) │ ├─► BABOK Documents (18) │ ├─► DMBOK Documents (22) │ ├─► Strategic Documents (12) │ ├─► Technical Documents (15) │ └─► Quality Documents (10) │ ├─► adpa validate --output ./enterprise-docs --pmbok --babok --dmbok │ │ │ ├─► Multi-Standard Validation │ ├─► Compliance Checking │ └─► Quality Metrics │ ├─► adpa confluence init && adpa confluence oauth2 login │ │ │ └─► Confluence Integration Setup │ ├─► adpa confluence publish --documents-path ./enterprise-docs │ │ │ └─► Enterprise Documentation Publishing │ └─► adpa vcs init && adpa vcs commit && adpa vcs push │ └─► Version Control & Backup ``` ### 3. Stakeholder Analysis Flow ``` Stakeholder Analysis │ ├─► Interactive Path │ │ │ ├─► adpa interactive │ ├─► Main Menu → Project Management → Stakeholder Management │ ├─► Select "Complete Automation" │ └─► Provide Project Context │ └─► Command Line Path │ ├─► adpa stakeholder analysis --context "Enterprise implementation" │ │ │ ├─► Stakeholder Identification │ ├─► Influence/Interest Analysis │ ├─► Communication Preferences │ └─► Engagement Strategies │ ├─► adpa stakeholder register │ │ │ ├─► Stakeholder Contact Information │ ├─► Roles and Responsibilities │ └─► Decision Authority │ ├─► adpa stakeholder engagement-plan │ │ │ ├─► Engagement Strategies │ ├─► Communication Plan │ └─► Feedback Mechanisms │ └─► adpa validate --category stakeholder-management │ └─► Stakeholder Document Validation ``` ### 4. Risk Assessment Flow ``` Risk Assessment │ ├─► Interactive Custom Assessment │ │ │ ├─► adpa interactive │ ├─► Main Menu → Project Management → Risk & Compliance │ ├─► Select "Custom Risk Assessment" │ ├─► Enter Project Details │ │ ├─► Project Name │ │ ├─► Project Type (Software/Infrastructure/Data/Business/Other) │ │ ├─► Project Description │ │ └─► Assessment Type (Integrated/PMBOK-Only) │ └─► Execute Assessment │ └─► Command Line Assessment │ ├─► adpa risk-compliance --project "E-commerce Platform" │ --type SOFTWARE_DEVELOPMENT │ --description "Customer-facing platform" │ │ │ ├─► Risk Identification │ ├─► Risk Analysis │ ├─► Risk Evaluation │ └─► Risk Treatment Planning │ ├─► adpa validate --category risk-management │ │ │ └─► Risk Document Validation │ ├─► adpa generate risk-register │ │ │ └─► Detailed Risk Register │ └─► adpa feedback export --category risk --format pdf │ └─► Risk Analysis Export ``` ## Integration Workflow Diagrams ### Confluence Integration Flow ``` Confluence Setup │ ├─► adpa confluence init │ │ │ ├─► Base URL Configuration │ ├─► Space Configuration │ └─► Authentication Setup │ ├─► adpa confluence oauth2 login │ │ │ ├─► OAuth2 Flow Initiation │ ├─► Browser Authentication │ ├─► Token Exchange │ └─► Token Storage │ ├─► adpa confluence test │ │ │ ├─► Connection Validation │ ├─► Permission Verification │ └─► API Endpoint Testing │ ├─► adpa confluence publish │ │ │ ├─► Document Processing │ ├─► Markdown to Confluence Conversion │ ├─► Page Creation/Update │ ├─► Attachment Handling │ └─► Link Management │ └─► adpa confluence status │ ├─► Integration Health Check ├─► Token Validity └─► Recent Activity Summary ``` ### SharePoint Integration Flow ``` SharePoint Setup │ ├─► adpa sharepoint init │ │ │ ├─► Site URL Configuration │ ├─► Library Configuration │ └─► Authentication Setup │ ├─► adpa sharepoint oauth2 login │ │ │ ├─► Microsoft Graph OAuth2 │ ├─► Tenant Authentication │ ├─► Scope Authorization │ └─► Token Management │ ├─► adpa sharepoint test │ │ │ ├─► Graph API Testing │ ├─► Site Access Verification │ └─► Upload Permission Check │ ├─► adpa sharepoint publish │ │ │ ├─► Document Upload │ ├─► Metadata Assignment │ ├─► Folder Organization │ └─► Version Management │ └─► adpa sharepoint status │ ├─► Connection Status ├─► Upload Statistics └─► Error Reporting ``` ## AI Provider Configuration Flows ### Google AI Setup Flow ``` Google AI Configuration │ ├─► API Key Acquisition │ │ │ ├─► Visit Google AI Studio │ ├─► Create/Select Project │ ├─► Generate API Key │ └─► Copy API Key │ ├─► ADPA Configuration │ │ │ ├─► adpa setup --provider google-ai │ ├─► Enter API Key │ ├─► Select Model (gemini-1.5-flash) │ └─► Validate Configuration │ ├─► Environment Setup │ │ │ ├─► export GOOGLE_AI_API_KEY=your_key │ ├─► export GOOGLE_AI_MODEL=gemini-1.5-flash │ └─► export CURRENT_PROVIDER=google-ai │ └─► Validation │ ├─► adpa validate --ai-connection ├─► Test Generation └─► Performance Verification ``` ### Azure OpenAI Setup Flow ``` Azure OpenAI Configuration │ ├─► Azure Resource Setup │ │ │ ├─► Create Azure OpenAI Resource │ ├─► Deploy Model (GPT-4) │ ├─► Get Endpoint URL │ └─► Get API Key │ ├─► ADPA Configuration │ │ │ ├─► adpa setup --provider azure-openai │ ├─► Enter Endpoint URL │ ├─► Enter API Key │ ├─► Enter Deployment Name │ └─► Configure Entra ID (Optional) │ ├─► Environment Setup │ │ │ ├─► export AZURE_OPENAI_ENDPOINT=your_endpoint │ ├─► export AZURE_OPENAI_API_KEY=your_key │ ├─► export DEPLOYMENT_NAME=gpt-4 │ ├─► export USE_ENTRA_ID=false │ └─► export CURRENT_PROVIDER=azure-openai │ └─► Validation │ ├─► adpa validate --ai-connection ├─► Enterprise Security Check └─► Performance Benchmarking ``` ## Error Recovery Workflows ### Interactive Error Recovery ``` Error Detected │ ├─► Validation Error │ │ │ ├─► Display Error Message │ ├─► Show Correction Suggestions │ ├─► Offer Recovery Options │ │ ├─► Retry with Corrections │ │ ├─► Go Back to Previous Step │ │ ├─► Show Help Information │ │ └─► Exit to Main Menu │ └─► Execute Selected Recovery Action │ ├─► Connection Error │ │ │ ├─► Display Connection Issue │ ├─► Suggest Alternative Providers │ ├─► Offer Retry Options │ │ ├─► Retry Current Provider │ │ ├─► Switch to Backup Provider │ │ ├─► Reconfigure Provider │ │ └─► Check Network Settings │ └─► Execute Recovery Strategy │ └─► Configuration Error │ ├─► Identify Configuration Issue ├─► Guide Through Reconfiguration ├─► Provide Step-by-Step Instructions └─► Validate New Configuration ``` ### Command Line Error Recovery ``` Command Failure │ ├─► Automatic Retry Logic │ │ │ ├─► Check Retry Count │ ├─► Apply Backoff Strategy │ ├─► Retry Operation │ └─► Report Final Status │ ├─► Provider Fallback │ │ │ ├─► Detect Provider Failure │ ├─► Switch to Backup Provider │ ├─► Retry Operation │ └─► Update Configuration │ └─► Manual Recovery │ ├─► Display Error Details ├─► Suggest Recovery Commands ├─► Provide Diagnostic Information └─► Guide User Through Resolution ``` ## Performance Optimization Workflows ### Caching Strategy ``` Template Caching │ ├─► Cache Initialization │ │ │ ├─► adpa configure --cache-templates true │ ├─► Create Cache Directory │ └─► Set Cache Policies │ ├─► Cache Population │ │ │ ├─► adpa templates preload --category pmbok │ ├─► Load Frequently Used Templates │ └─► Optimize Cache Structure │ ├─► Cache Utilization │ │ │ ├─► Check Cache Before Generation │ ├─► Use Cached Templates │ └─► Update Cache Statistics │ └─► Cache Maintenance │ ├─► Monitor Cache Performance ├─► Clean Expired Entries └─► adpa clean --cache (when needed) ``` ### Parallel Processing ``` Parallel Generation │ ├─► Job Queue Setup │ │ │ ├─► Analyze Generation Tasks │ ├─► Determine Optimal Concurrency │ └─► Initialize Worker Pool │ ├─► Task Distribution │ │ │ ├─► Split Generation Tasks │ ├─► Assign to Workers │ └─► Monitor Progress │ ├─► Parallel Execution │ │ │ ├─► adpa generate-category pmbok --parallel --max-concurrent 5 │ ├─► Execute Tasks Concurrently │ └─► Collect Results │ └─► Result Aggregation │ ├─► Combine Generated Documents ├─► Validate Complete Set └─► Report Generation Statistics ``` This visual workflow documentation provides clear navigation paths and process flows for all major ADPA CLI operations, making it easier for users to understand and follow the various workflows available in the system.