Automated Documentation Suite#
This directory contains automatically generated business metrics and KPI documentation.
Core Documentation#
- KPI Definitions - Comprehensive KPI calculation definitions
- Business Dashboard - Dashboard API and response structure
- API Reference - Complete metrics API documentation
- Integration Guide - Service integration patterns
- Monitoring Playbooks - KPI alert response procedures
KPI Catalog#
- KPI Catalog (Markdown) - Human-readable KPI catalog
- KPI Catalog (JSON) - Machine-readable KPI definitions
Documentation Automation#
This documentation is automatically generated and validated using:
- Generator:
docs/automation/business-metrics-docs-generator.js - Validation: Automated content quality and accuracy checks
- Updates: Regenerated on configuration changes
- Testing: All API examples validated against live endpoints
Validation Status#
| Document | Status | Last Updated | Content Quality |
|---|---|---|---|
| KPI Definitions | ✅ Valid | 2025-09-26T09:29:19.737Z | Comprehensive |
| Business Dashboard | ✅ Valid | 2025-09-26T09:29:19.737Z | Complete |
| API Reference | ✅ Valid | 2025-09-26T09:29:19.737Z | Detailed |
| Integration Guide | ✅ Valid | 2025-09-26T09:29:19.737Z | Actionable |
| Monitoring Playbooks | ✅ Valid | 2025-09-26T09:29:19.737Z | Operational |
| KPI Catalog | ✅ Valid | 2025-09-26T09:29:19.737Z | Machine-readable |
KPI Summary#
- Total KPIs: 12
- Categories: 5
- Data Sources: Analytics events, payment events, session metrics
- Update Frequency: Real-time with 5-minute batch aggregation
Integration#
All documentation is integrated with:
- Live business metrics dashboards
- Real-time KPI calculations
- Analytics event validation
- Automated alert systems
Generated automatically by business-metrics-docs-generator.js Last updated: 2025-09-26T09:29:19.737Z