monte-carlo-simulator/docs/README.md

Business decision framework with Monte Carlo risk analysis - instant via npx

# Documentation Directory

## 📚 Complete Documentation Structure

This directory contains all comprehensive documentation for the Monte Carlo Business Decision Framework, properly organized for different audiences and use cases.

## 📋 Documentation Files

### Core Documentation
- **[AGENT.md](AGENT.md)** - Complete technical specifications for AI agents
  - YAML schema requirements and validation rules
  - Working simulation patterns and examples
  - Agent workflow optimization and best practices

- **[TECHNICAL.md](TECHNICAL.md)** - Deep framework architecture and technical details
  - Core simulation engine architecture
  - Business intelligence integration
  - Advanced framework features and customization

### Architecture & Organization  
- **[DIRECTORY_STRUCTURE.md](DIRECTORY_STRUCTURE.md)** - Project directory architecture guide
  - Purpose and usage of each directory
  - Code integration with directory structure
  - File organization best practices

- **[TEMPLATE_USAGE.md](TEMPLATE_USAGE.md)** - Template system comprehensive guide
  - Template creation and management
  - Business intelligence metadata integration
  - Template validation and testing

### User Guides
- **[QUICK_REFERENCE.md](QUICK_REFERENCE.md)** - Command reference and quick start
  - All CLI commands with examples
  - Parameter options and usage patterns
  - Common workflow shortcuts

- **[YAML_SCHEMA_GUIDE.md](YAML_SCHEMA_GUIDE.md)** - Complete YAML validation reference
  - Schema structure and requirements
  - Validation rules and error handling
  - Configuration examples and patterns

- **[parameter-files.md](parameter-files.md)** - Parameter system documentation
  - Parameter file formats and usage
  - Scenario configuration management
  - Custom parameter examples

### Interactive Features
- **[INTERACTIVE_STUDIO.md](INTERACTIVE_STUDIO.md)** - Interactive simulation system specification
  - Real-time parameter adjustment
  - Live results visualization
  - Session management and workflows

## 🎯 Documentation Usage by Audience

### For AI Agents
Primary: **[AGENT.md](AGENT.md)**  
Supporting: YAML_SCHEMA_GUIDE.md, TEMPLATE_USAGE.md

### For Framework Developers  
Primary: **[TECHNICAL.md](TECHNICAL.md)**  
Supporting: DIRECTORY_STRUCTURE.md, INTERACTIVE_STUDIO.md

### For Business Users
Primary: **[QUICK_REFERENCE.md](QUICK_REFERENCE.md)**  
Supporting: parameter-files.md, INTERACTIVE_STUDIO.md

### For System Administrators
Primary: **[DIRECTORY_STRUCTURE.md](DIRECTORY_STRUCTURE.md)**  
Supporting: TEMPLATE_USAGE.md, TECHNICAL.md

## 📁 Related Documentation

### Project Root
- **[../README.md](../README.md)** - Main project overview and getting started
- **[../CLAUDE.md](../CLAUDE.md)** - Claude Code collaboration guidelines  
- **[../ACTIVE_WORK.md](../ACTIVE_WORK.md)** - Current development priorities

### Other Directories
- **[../designs/](../designs/)** - Feature design documents and specifications
- **[../archive/](../archive/)** - Completed work and development insights
- **[../examples/](../examples/)** - Working simulation examples and patterns

## 🔄 Documentation Maintenance

This documentation structure supports:
- **Clear separation of concerns** - Each file has specific audience and purpose
- **Comprehensive coverage** - All aspects of the framework documented
- **Easy navigation** - Logical organization and cross-references
- **Professional presentation** - Clean, organized structure for all users

---

*All documentation is kept up-to-date with the latest framework capabilities and maintained as part of the development process.*