An automated loop for generating comprehensive, up-to-date system architecture documentation. This agent analyzes your codebase, identifies key architectural components, creates visual diagrams, and produces explanatory text suitable for technical stakeholders.
Generate validated system architecture documentation including component diagrams, data flow, and design rationale
Iterative documentation generation with automated review checks. Run in any supported AI coding environment.
1. Prepare Context
Ensure your codebase is accessible and provide existing documentation if available
2. Execute Kickoff Prompt
Launch with the provided kickoff prompt in your chosen AI coding environment
3. Monitor Iterations
Agent will self-pace through workflow steps, running validation checks between iterations
4. Approve Final Output
Review and approve generated documentation to trigger exit condition
Analyze codebase structure and identify core components/services
Verify component inventory against known architectural layers
Create architecture template with section headers
Docs
Automatically generates and maintains a project's CHANGELOG.md file by analyzing code changes, commits, or version control history to produce structured release notes.
Docs
Automatically identifies areas in your codebase lacking usage examples and iteratively adds them to improve documentation coverage. The agent focuses on generating practical, copy-paste-friendly examples for functions, methods, and components that currently lack adequate documentation.
Docs
Automatically synchronizes API documentation with the codebase to ensure no drift occurs between implementation and documented interfaces. This loop detects discrepancies, generates necessary updates, and applies them while respecting guardrails to maintain consistency and quality.
Confirm template includes all required documentation sections
Generate component interaction diagrams using Mermaid
Validate Mermaid diagram syntax and logical consistency
Write architectural explanations and design decisions
Review clarity and completeness of explanatory text
Incorporate data flow and dependency relationships
Verify data flow accuracy against codebase analysis
Run check_command for validation
Assess readiness for review approval
Start the "Architecture Documentation Builder" loop. Goal: Generate validated system architecture documentation including component diagrams, data flow, and design rationale Max iterations: 10 Between iterations run: review validation Exit when: Review approved Please analyze the provided codebase to generate comprehensive system architecture documentation. Create visual diagrams (Mermaid format) showing component interactions, data flows, and architectural patterns. For each major component, include a brief description of its purpose, responsibilities, and key interfaces. Organize the output into clear sections: Overview, Components, Interactions, Data Flow, Design Decisions, and Dependencies. Prioritize accuracy based on actual code structure rather than assumptions. Self-pace this loop. After each iteration, run `review validation` and evaluate the output, and only continue if the exit condition is not met (Review approved). Stop when the exit condition passes or 10 iterations are reached. Give a short status update each pass.
