UNPKG

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

648 lines (461 loc) 17.1 kB
# Business Analyst Workflow Guide **Requirements Gathering Agent - Enhanced BA Support** **Version:** 1.0 **Date:** 2025-01-27 **Author:** Requirements Gathering Agent Team --- ## Overview This guide provides Business Analysts with comprehensive workflows for leveraging the Requirements Gathering Agent's enhanced capabilities for detailed requirements gathering automation and strategic planning outputs. --- ## Table of Contents 1. [Getting Started](#getting-started) 2. [Requirements Elicitation Workflows](#requirements-elicitation-workflows) 3. [Advanced Requirements Analysis](#advanced-requirements-analysis) 4. [Quality Assurance Processes](#quality-assurance-processes) 5. [Strategic Planning Support](#strategic-planning-support) 6. [Integration with Existing Tools](#integration-with-existing-tools) 7. [Best Practices](#best-practices) 8. [Troubleshooting](#troubleshooting) --- ## Getting Started ### Prerequisites - Requirements Gathering Agent installed and configured - AI provider configured (Google AI, Azure OpenAI, or GitHub Copilot) - Basic understanding of BABOK v3 principles ### Initial Setup ```bash # Verify installation rga --version # Check configuration rga status # Analyze current workspace rga analyze # Generate initial project context rga generate project-charter ``` --- ## Requirements Elicitation Workflows ### 1. Stakeholder Interview Preparation **Objective:** Generate comprehensive interview questions tailored to specific stakeholder roles. **Workflow:** ```bash # Generate interview questions for Product Owner rga ba interview-questions "Product Owner" --verbose # Generate questions for Technical Lead rga ba interview-questions "Technical Lead" --output-dir interviews # Generate questions for End User rga ba interview-questions "End User" --format markdown ``` **Output:** Structured interview guide with: - Pre-interview preparation checklist - Role-specific questions organized by category - Follow-up question strategies - Post-interview action items ### 2. Workshop Facilitation Planning **Objective:** Create detailed workshop plans for requirements gathering sessions. **Workflow:** ```bash # Create requirements gathering workshop plan rga ba workshop-plan "Requirements Gathering" --duration 6 --verbose # Create user story workshop plan rga ba workshop-plan "User Story Workshop" --duration 4 # Create process mapping workshop plan rga ba workshop-plan "Process Mapping" --duration 8 ``` **Output:** Comprehensive workshop plan with: - Detailed agenda with timing - Facilitation techniques and activities - Materials and preparation requirements - Risk management and contingency plans ### 3. Meeting Notes Processing **Objective:** Extract structured requirements from meeting notes and transcripts. **Workflow:** ```bash # Extract requirements from meeting notes rga ba extract-requirements meeting-notes.md --elicitation-type interview # Process workshop notes rga ba extract-requirements workshop-notes.txt --elicitation-type workshop # Generate follow-up actions rga ba extract-requirements stakeholder-feedback.md --verbose ``` **Output:** Structured requirements extraction with: - Categorized functional and non-functional requirements - Identified stakeholders and decisions - Action items and follow-up requirements - Open questions and risks ### 4. Survey Generation **Objective:** Create comprehensive surveys for distributed requirements gathering. **Workflow:** ```bash # Generate user requirements survey rga ba survey-questions "End Users" --objectives "Feature Prioritization,Usability Requirements" # Create stakeholder satisfaction survey rga ba survey-questions "Project Stakeholders" --objectives "Process Feedback,Communication Effectiveness" ``` --- ## Advanced Requirements Analysis ### 1. Process Modeling **Objective:** Generate detailed process models from requirements. **Workflow:** ```bash # Generate BPMN process model rga ba process-model requirements.md --model-type BPMN --verbose # Create flowchart model rga ba process-model functional-requirements.md --model-type Flowchart # Generate value stream map rga ba process-model business-processes.md --model-type ValueStream # Create swimlane diagram rga ba process-model workflow-requirements.md --model-type Swimlane ``` **Output:** Detailed process models with: - Process flow definitions and steps - Actor roles and responsibilities - Data flows and business rules - Performance metrics and optimization opportunities ### 2. Use Case Modeling **Objective:** Create comprehensive use case models from functional requirements. **Workflow:** ```bash # Generate use case model rga ba use-case-model functional-requirements.md --verbose # Create use case model with specific context rga ba use-case-model user-stories.md --output-dir analysis ``` **Output:** Complete use case model with: - Actor identification and goals - Detailed use case scenarios - Alternative and exception flows - Traceability to requirements ### 3. Business Rules Extraction **Objective:** Extract and catalog business rules from requirements. **Workflow:** ```bash # Extract business rules rga ba business-rules requirements-document.md --verbose # Process multiple requirement sources rga ba business-rules combined-requirements.md --output-dir rules ``` **Output:** Business rules catalog with: - Categorized and prioritized rules - Rule relationships and dependencies - Implementation guidance - Testing criteria ### 4. Impact Analysis **Objective:** Analyze the impact of requirement changes. **Workflow:** ```bash # Perform impact analysis for new requirement rga ba impact-analysis "Add multi-factor authentication" --verbose # Analyze change impact with context rga ba impact-analysis "Integrate with external API" --output-dir analysis ``` **Output:** Comprehensive impact analysis with: - Affected areas and components - Risk assessment and mitigation - Effort estimation - Implementation recommendations ### 5. Gap Analysis **Objective:** Analyze gaps between current and future state. **Workflow:** ```bash # Generate gap analysis rga ba gap-analysis --current-state current-processes.md --future-state target-state.md # Comprehensive gap analysis with roadmap rga ba gap-analysis --verbose --output-dir gap-analysis ``` --- ## Quality Assurance Processes ### 1. Requirements Quality Assessment **Objective:** Assess requirements quality against industry standards. **Workflow:** ```bash # Assess requirements quality using BABOK v3 rga ba quality-assessment requirements.md --standards "BABOK v3" --verbose # Quality assessment with custom standards rga ba quality-assessment functional-requirements.md --standards "IEEE 830" ``` **Output:** Quality assessment report with: - Quality dimension scoring - Detailed findings and recommendations - Improvement action plan - Compliance assessment ### 2. Document Consistency Validation **Objective:** Validate consistency across multiple documents. **Workflow:** ```bash # Check consistency across documents rga ba consistency-check requirements.md design.md test-plan.md --verbose # Validate specific document set rga ba consistency-check *.md --output-dir validation ``` **Output:** Consistency validation report with: - Cross-document consistency analysis - Inconsistency identification and resolution - Terminology and process alignment - Recommendations for improvement ### 3. Completeness Verification **Objective:** Verify document completeness against templates. **Workflow:** ```bash # Verify completeness against BABOK template rga ba completeness-check requirements.md --template babok-requirements-template.md # Check completeness with custom template rga ba completeness-check business-case.md --template business-case-template.md --verbose ``` ### 4. Traceability Validation **Objective:** Validate requirements traceability matrix. **Workflow:** ```bash # Validate traceability matrix rga ba traceability-check traceability-matrix.md --verbose # Comprehensive traceability validation rga ba traceability-check rtm.md --output-dir validation ``` ### 5. Quality Metrics Generation **Objective:** Generate quality metrics and KPIs. **Workflow:** ```bash # Generate quality metrics report rga ba quality-metrics --verbose # Generate metrics with specific timeframe rga ba quality-metrics --timeframe "last-quarter" --output-dir metrics ``` --- ## Strategic Planning Support ### 1. Business Case Development **Objective:** Create comprehensive business cases with financial analysis. **Workflow:** ```bash # Generate business case rga generate business-case --verbose # Create strategic business case rga generate strategic-business-case --output-dir strategic ``` ### 2. Stakeholder Analysis and Engagement **Objective:** Develop stakeholder management strategies. **Workflow:** ```bash # Generate stakeholder register rga generate stakeholder-register --verbose # Create stakeholder analysis rga generate stakeholder-analysis # Develop engagement plan rga generate stakeholder-engagement-plan ``` ### 3. Mission, Vision, and Values **Objective:** Develop strategic statements and organizational alignment. **Workflow:** ```bash # Generate mission, vision, and core values rga generate mission-vision-core-values --verbose # Create project purpose statement rga generate project-purpose ``` --- ## Integration with Existing Tools ### 1. Confluence Integration **Objective:** Publish BA deliverables to Confluence. **Setup:** ```bash # Initialize Confluence integration rga confluence init # Test connection rga confluence test # Publish documents rga confluence publish --space "BA" --parent "Requirements" ``` ### 2. SharePoint Integration **Objective:** Sync documents with SharePoint. **Setup:** ```bash # Initialize SharePoint integration rga sharepoint init # Publish to SharePoint rga sharepoint publish --site "ProjectSite" --library "Documents" ``` ### 3. Version Control Integration **Objective:** Manage document versions with Git. **Setup:** ```bash # Initialize version control rga vcs init # Commit changes rga vcs commit "Updated requirements documentation" # Push to repository rga vcs push ``` --- ## Best Practices ### 1. Requirements Elicitation **Best Practices:** - Always prepare stakeholder-specific interview questions - Use multiple elicitation techniques for comprehensive coverage - Document and validate requirements immediately after sessions - Follow up with stakeholders for clarification and confirmation **Example Workflow:** ```bash # 1. Prepare for stakeholder interview rga ba interview-questions "Business User" --verbose # 2. Conduct interview and take notes # 3. Extract requirements from notes rga ba extract-requirements interview-notes.md # 4. Validate with stakeholder # 5. Update requirements documentation ``` ### 2. Requirements Analysis **Best Practices:** - Use appropriate modeling techniques for different requirement types - Maintain traceability throughout the analysis process - Validate models with stakeholders and subject matter experts - Document assumptions and constraints clearly **Example Workflow:** ```bash # 1. Generate process model rga ba process-model requirements.md --model-type BPMN # 2. Create use case model rga ba use-case-model functional-requirements.md # 3. Extract business rules rga ba business-rules requirements.md # 4. Validate consistency rga ba consistency-check *.md ``` ### 3. Quality Assurance **Best Practices:** - Implement regular quality checkpoints - Use automated quality assessment tools - Maintain consistency across all documents - Track quality metrics over time **Example Workflow:** ```bash # 1. Assess requirements quality rga ba quality-assessment requirements.md --standards "BABOK v3" # 2. Check document consistency rga ba consistency-check requirements.md design.md # 3. Verify completeness rga ba completeness-check requirements.md --template template.md # 4. Generate quality metrics rga ba quality-metrics --verbose ``` ### 4. Continuous Improvement **Best Practices:** - Regularly review and update processes - Collect feedback from stakeholders - Monitor quality metrics and trends - Implement lessons learned --- ## Troubleshooting ### Common Issues and Solutions #### 1. AI Provider Configuration Issues ```bash # Check AI provider status rga status # Reconfigure provider rga setup ``` #### 2. Document Generation Failures ```bash # Verify project context rga analyze # Check output directory permissions ls -la generated-documents/ # Regenerate with verbose output rga ba interview-questions "Role" --verbose ``` #### 3. Quality Assessment Issues ```bash # Verify file format and content file requirements.md # Check file encoding file -i requirements.md # Use verbose mode for debugging rga ba quality-assessment requirements.md --verbose ``` #### 4. Integration Problems ```bash # Test Confluence connection rga confluence test # Check SharePoint permissions rga sharepoint status # Verify Git configuration rga vcs status ``` ### Getting Help - Use `--help` flag with any command for detailed usage information - Use `--verbose` flag for detailed output and debugging - Check the project documentation for additional guidance - Report issues on the project repository --- ## Advanced Workflows ### 1. Complete Requirements Lifecycle **Objective:** End-to-end requirements management workflow. ```bash # Phase 1: Planning and Preparation rga generate project-charter rga generate stakeholder-register rga ba interview-questions "Product Owner" # Phase 2: Elicitation rga ba workshop-plan "Requirements Gathering" # Conduct workshops and interviews rga ba extract-requirements workshop-notes.md # Phase 3: Analysis and Modeling rga ba process-model requirements.md --model-type BPMN rga ba use-case-model functional-requirements.md rga ba business-rules requirements.md # Phase 4: Quality Assurance rga ba quality-assessment requirements.md rga ba consistency-check *.md rga ba traceability-check rtm.md # Phase 5: Documentation and Communication rga generate requirements-documentation rga confluence publish --space "Project" # Phase 6: Monitoring and Control rga ba quality-metrics rga ba impact-analysis "New Requirement" ``` ### 2. Agile Requirements Management **Objective:** Support for agile development methodologies. ```bash # Sprint Planning Support rga generate user-stories rga generate acceptance-criteria rga ba workshop-plan "Sprint Planning" # Backlog Refinement rga ba business-rules user-stories.md rga ba impact-analysis "Epic: User Management" # Sprint Review and Retrospective rga ba quality-metrics --timeframe "current-sprint" rga ba extract-requirements retrospective-notes.md ``` ### 3. Enterprise Architecture Alignment **Objective:** Align requirements with enterprise architecture. ```bash # Business Architecture rga generate business-case rga ba process-model business-requirements.md --model-type ValueStream # Information Architecture rga generate data-model-suggestions rga ba business-rules data-requirements.md # Technology Architecture rga generate tech-stack-analysis rga ba impact-analysis "Technology Migration" ``` --- ## Conclusion The Requirements Gathering Agent provides comprehensive support for Business Analyst workflows, from initial requirements elicitation through quality assurance and strategic planning. By following the workflows and best practices outlined in this guide, Business Analysts can significantly improve their productivity and the quality of their deliverables. **Key Benefits:** - **Automation:** Reduce manual effort in document creation and analysis - **Quality:** Ensure consistent, high-quality deliverables - **Efficiency:** Streamline workflows and reduce cycle times - **Compliance:** Maintain alignment with industry standards and best practices - **Collaboration:** Improve stakeholder engagement and communication **Next Steps:** 1. Implement the workflows that best fit your current processes 2. Customize templates and standards for your organization 3. Train team members on the new capabilities 4. Monitor quality metrics and continuously improve 5. Provide feedback to help enhance the platform --- **Document Status:** Complete **Review Required:** Yes **Stakeholders:** Business Analyst Community, Product Management, Development Team **Next Review Date:** 2025-03-27