adpa-enterprise-framework-automation/docs/README.md

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

# ADPA Documentation

Welcome to the ADPA (Advanced Document Processing & Automation) Framework documentation.

## 📚 Documentation Index

### CLI Documentation
- **[CLI Usage Documentation](CLI-USAGE-DOCUMENTATION.md)** - Complete interactive CLI usage guide with menu navigation and integration workflows
- **[CLI Execution Guide](CLI-EXECUTION-GUIDE.md)** - Comprehensive guide for using the ADPA CLI with detailed examples and workflows
- **[CLI Quick Reference](CLI-QUICK-REFERENCE.md)** - Essential commands, options, and quick examples for daily use

### Framework Documentation
- **[Framework Overview](../README.md)** - Main project overview and features
- **[Installation Guide](../README.md#installation)** - Installation instructions for different environments
- **[Configuration Guide](../README.md#configuration)** - Environment setup and AI provider configuration

### API Documentation
- **[API Specifications](../api-specs/)** - TypeSpec-generated OpenAPI specifications
- **[REST API Usage](../README.md#api-usage)** - API usage examples and integration patterns

### Integration Guides
- **[Confluence Integration](CLI-EXECUTION-GUIDE.md#confluence-integration)** - Setup and usage of Confluence integration
- **[SharePoint Integration](CLI-EXECUTION-GUIDE.md#sharepoint-integration)** - Setup and usage of SharePoint integration
- **[Version Control Integration](CLI-EXECUTION-GUIDE.md#version-control-system-vcs)** - Git integration and workflow automation

### Standards Compliance
- **[BABOK v3 Support](../README.md#babok-v3-business-analysis)** - Business Analysis Body of Knowledge implementation
- **[PMBOK 7th Edition Support](../README.md#pmbok-7th-edition-project-management)** - Project Management Body of Knowledge implementation
- **[DMBOK 2.0 Support](../README.md#dmbok-20-data-management)** - Data Management Body of Knowledge implementation

### Security and Authentication
- **[Authentication Design Summary](AUTHENTICATION-DESIGN-SUMMARY.md)** - Overview of enterprise authentication design for ADPA
- **[Authentication Design Specification](AUTHENTICATION-DESIGN-SPECIFICATION.md)** - Comprehensive technical design specification
- **[Authentication Implementation Strategy](AUTHENTICATION-IMPLEMENTATION-STRATEGY.md)** - Detailed implementation roadmap and strategy
- **[Entra ID Configuration Guide](ENTRA-ID-CONFIGURATION-GUIDE.md)** - Step-by-step Microsoft Entra ID setup instructions
- **[Security Compliance Checklist](AUTHENTICATION-SECURITY-COMPLIANCE-CHECKLIST.md)** - Comprehensive security and compliance validation framework

### Development
- **[Contributing Guide](../README.md#contributing)** - How to contribute to the project
- **[Development Setup](../README.md#development-setup)** - Setting up the development environment
- **[Testing Guide](../README.md#testing)** - Running tests and test strategies

## 🚀 Quick Start

### For End Users
1. **[Install ADPA](../README.md#installation)** - Get ADPA installed on your system
2. **[CLI Usage Documentation](CLI-USAGE-DOCUMENTATION.md)** - Interactive menu navigation and complete usage guide
3. **[CLI Quick Reference](CLI-QUICK-REFERENCE.md)** - Start with essential commands
4. **[CLI Execution Guide](CLI-EXECUTION-GUIDE.md)** - Detailed usage examples

### For Developers
1. **[Development Setup](../README.md#development-setup)** - Set up development environment
2. **[Contributing Guide](../README.md#contributing)** - Contribution guidelines
3. **[API Specifications](../api-specs/)** - API development reference

### For Enterprise Users
1. **[Enterprise Features](../README.md#enterprise-features)** - Enterprise-specific capabilities
2. **[Integration Guides](CLI-EXECUTION-GUIDE.md#integration-commands)** - Confluence, SharePoint, and VCS integration
3. **[Standards Compliance](CLI-EXECUTION-GUIDE.md#validation)** - PMBOK validation and compliance
4. **[Authentication Design](AUTHENTICATION-DESIGN-SUMMARY.md)** - Enterprise authentication and security design

## 📖 Document Categories

ADPA supports generating documents in the following categories:

| Category | Framework | Description |
|----------|-----------|-------------|
| **BABOK** | Business Analysis Body of Knowledge v3 | Business analysis planning, elicitation, requirements analysis |
| **PMBOK** | Project Management Body of Knowledge 7th Ed | Project charters, management plans, risk registers |
| **DMBOK** | Data Management Body of Knowledge 2.0 | Data governance, quality management, architecture |
| **Basic Docs** | General | Project summaries, user personas, core values |
| **Planning** | Project Management | Activity lists, schedules, resource estimates |
| **Quality Assurance** | Software Development | Test plans, bug reports, acceptance criteria |
| **Risk Management** | Project Management | Risk registers, management plans |
| **Stakeholder Management** | Project Management | Stakeholder analysis, engagement plans |
| **Technical Analysis** | Software Development | Tech stack analysis, compliance considerations |
| **Technical Design** | Software Development | Architecture, database design, API documentation |

## 🔧 Common Use Cases

### Project Managers
- Generate complete PMBOK-compliant project documentation
- Create project charters, management plans, and risk registers
- Validate documents against industry standards

### Business Analysts
- Generate BABOK v3 compliant business analysis documentation
- Create requirements specifications and stakeholder analysis
- Document business processes and workflows

### Data Managers
- Generate DMBOK 2.0 compliant data management documentation
- Create data governance frameworks and quality management plans
- Document data architecture and metadata management

### Technical Teams
- Generate technical design documentation
- Create API documentation and system architecture
- Document deployment and integration patterns

## 🆘 Getting Help

- **Interactive Help**: Use the [CLI Usage Documentation](CLI-USAGE-DOCUMENTATION.md) for menu navigation and workflows
- **Quick Issues**: Check the [CLI Quick Reference](CLI-QUICK-REFERENCE.md#troubleshooting)
- **Detailed Help**: See the [CLI Execution Guide](CLI-EXECUTION-GUIDE.md#troubleshooting)
- **Command Help**: Use `adpa --help` or `adpa <command> --help`
- **Community Support**: [GitHub Discussions](https://github.com/mdresch/requirements-gathering-agent/discussions)
- **Bug Reports**: [GitHub Issues](https://github.com/mdresch/requirements-gathering-agent/issues)

---

*Last updated: December 2024*