patterns

Reference Patterns

This directory contains common patterns and approaches for creating AI-ready documentation.

Pattern Categories

Documentation Patterns

• Context-First Pattern: Always establish system context before diving into specifics
• Progressive Disclosure Pattern: Layer information from high-level to detailed
• Decision Documentation Pattern: Capture rationale and alternatives for key decisions

Implementation Patterns

• Phase-Based Implementation: Break complex features into logical phases
• Dependency-First Pattern: Implement dependencies before dependent components
• Validation-Driven Pattern: Define success criteria before implementation

Communication Patterns

• Architecture Diagram Pattern: Use visual representations for system understanding
• Example-Driven Pattern: Include concrete examples for abstract concepts
• Cross-Reference Pattern: Link related documentation and components

Usage Guidelines

Each pattern includes:

• Description: What the pattern accomplishes
• When to Use: Appropriate scenarios for application
• Implementation: Step-by-step application guide
• Examples: Real-world usage examples
• Anti-patterns: What to avoid when using this pattern

Contributing New Patterns

When documenting new patterns:

1. Validate effectiveness with AI agents
2. Provide multiple examples
3. Document common pitfalls
4. Include measurement criteria