daffy0208__ai-dev-standards/DOCS/INDEX.md

Documentation Index

Complete guide to all documentation in the ai-dev-standards framework.

Getting Started

• Quick Start - Get up and running in 5 minutes
• Bootstrap Guide - Setting up new projects
• Cheat Sheet - Quick reference for common tasks
• System Overview - Understanding the framework architecture

Core Documentation

CLI Tools

• CLI Quick Start - Command-line interface basics
• CLI Reference - Complete CLI command reference

Integration & Deployment

• Integration Guide - Integrating with existing projects
• Existing Projects - Adding to established codebases
• Deployment - Deploying your applications
• CI/CD Setup - Continuous integration configuration

Development

• MCP Development Roadmap - MCP server development plan

System Documentation

Maintenance & Operations

• Auto-Sync Guide - Automatic synchronization system
• Audit System - Quality and trust validation
• Resource Guide - Resource management and discovery

Reference Documentation

By Category

📚 API Documentation

• API Reference - Complete API documentation (planned)

💡 Concepts

• Concepts - Framework concepts and theory (planned)

📖 Guides

• Step-by-Step Guides - Practical tutorials (planned)

Skills & Tools

Skills Documentation

Navigate to /SKILLS/ directory to explore 59 specialized AI agent skills:

• Each skill has a SKILL.md (detailed specification)
• Each skill has a README.md (user-friendly guide)
• Use the Skill Registry for a complete list

New Skills:

• dark-matter-analyzer - Repository coherence and organizational health analysis

MCP Servers

Navigate to /MCP-SERVERS/ directory for MCP tool documentation:

• accessibility-checker-mcp
• component-generator-mcp
• dark-matter-analyzer-mcp - NEW! Repository analysis
• embedding-generator-mcp
• feature-prioritizer-mcp
• screenshot-testing-mcp
• vector-database-mcp

Standards & Patterns

Architecture Patterns

Located in /STANDARDS/architecture-patterns/:

• Authentication Patterns
• Database Design Patterns
• Error Tracking
• Event-Driven Architecture
• Logging Strategy
• Microservices Pattern
• Monitoring and Alerting
• RAG Pattern
• Real-Time Systems
• Serverless Pattern

Best Practices

Located in /STANDARDS/best-practices/:

• Database Best Practices
• Security Best Practices
• Testing Best Practices

Templates

Located in /TEMPLATES/:

• Cursor Rules Templates (5 variants)
• CI/CD Templates
• Config File Templates
• Deployment Templates
• Project Starter Templates
• Testing Templates

Playbooks

Located in /PLAYBOOKS/:

• ADHD Getting Unstuck
• Backup and Restore
• Database Migration
• Deployment Checklist
• Incident Response
• Rollback Procedure
• Validation-First Development

Additional Resources

Root Level Documentation

• README - Project overview and introduction
• CONTRIBUTING - How to contribute
• CHANGELOG - Version history
• BUILD FOCUS - Current development priorities
• Dark Matter Specification - Repository analysis framework

Meta Documentation

Located in /META/:

• Skill Registry (skill-registry.json)
• Tool Registry (registry.json)
• Relationship Mapping (relationship-mapping.json)

Legacy Documentation

Historical documentation moved to /DOCS-LEGACY/ for reference purposes.

Contributing to Documentation

When adding new documentation:

1. Follow the existing structure and naming conventions
2. Use kebab-case for filenames (e.g., my-new-guide.md)
3. Update this index when adding new docs
4. Link related documents together
5. Include a "Last Updated" date at the bottom

Documentation Status Legend

• ✅ Complete - Fully documented and up to date
• 🔄 In Progress - Currently being written or updated
• 📋 Planned - Scheduled for future documentation

---

Last Updated: 2025-10-23 Total Documentation Files: 18 active, 20+ legacy Skills: 59 | MCPs: 49 | Skill-to-Tool Ratio: 1.2:1