BMAD-METHOD/bmad/bmm/workflows/document-project/templates/index-template.md

{{project_name}} Documentation Index

Type: {{repository_type}}{{#if is_multi_part}} with {{parts_count}} parts{{/if}} Primary Language: {{primary_language}} Architecture: {{architecture_type}} Last Updated: {{date}}

Project Overview

{{project_description}}

{{#if is_multi_part}}

Project Structure

This project consists of {{parts_count}} parts:

{{#each project_parts}}

{{part_name}} ({{part_id}})

• Type: {{project_type}}
• Location: {{root_path}}
• Tech Stack: {{tech_stack_summary}}
• Entry Point: {{entry_point}} {{/each}}

Cross-Part Integration

{{integration_summary}}

{{/if}}

Quick Reference

{{#if is_single_part}}

• Tech Stack: {{tech_stack_summary}}
• Entry Point: {{entry_point}}
• Architecture Pattern: {{architecture_pattern}}
• Database: {{database}}
• Deployment: {{deployment_platform}} {{else}} {{#each project_parts}}

{{part_name}} Quick Ref

• Stack: {{tech_stack_summary}}
• Entry: {{entry_point}}
• Pattern: {{architecture_pattern}} {{/each}} {{/if}}

Generated Documentation

Core Documentation

• Project Overview - Executive summary and high-level architecture
• Source Tree Analysis - Annotated directory structure

{{#if is_single_part}}

• Architecture - Detailed technical architecture
• Component Inventory - Catalog of major components{{#if has_ui_components}} and UI elements{{/if}}
• Development Guide - Local setup and development workflow {{#if has_api_docs}}- API Contracts - API endpoints and schemas{{/if}} {{#if has_data_models}}- Data Models - Database schema and models{{/if}} {{else}}

Part-Specific Documentation

{{#each project_parts}}

{{part_name}} ({{part_id}})

• Architecture - Technical architecture for {{part_name}} {{#if has_components}}- Components - Component catalog{{/if}}
• Development Guide - Setup and dev workflow {{#if has_api}}- API Contracts - API documentation{{/if}} {{#if has_data}}- Data Models - Data architecture{{/if}} {{/each}}

Integration

• Integration Architecture - How parts communicate
• Project Parts Metadata - Machine-readable structure {{/if}}

Optional Documentation

{{#if has_deployment_guide}}- Deployment Guide - Deployment process and infrastructure{{/if}} {{#if has_contribution_guide}}- Contribution Guide - Contributing guidelines and standards{{/if}}

Existing Documentation

{{#if has_existing_docs}} {{#each existing_docs}}

• {{title}} - {{description}} {{/each}} {{else}} No existing documentation files were found in the project. {{/if}}

Getting Started

{{#if is_single_part}}

Prerequisites

{{prerequisites}}

Setup

{{setup_commands}}

Run Locally

{{run_commands}}

Run Tests

{{test_commands}}

{{else}} {{#each project_parts}}

{{part_name}} Setup

Prerequisites: {{prerequisites}}

Install & Run:

cd {{root_path}}
{{setup_command}}
{{run_command}}

{{/each}} {{/if}}

For AI-Assisted Development

This documentation was generated specifically to enable AI agents to understand and extend this codebase.

When Planning New Features:

UI-only features: {{#if is_multi_part}}→ Reference: architecture-{{ui_part_id}}.md, component-inventory-{{ui_part_id}}.md{{else}}→ Reference: architecture.md, component-inventory.md{{/if}}

API/Backend features: {{#if is_multi_part}}→ Reference: architecture-{{api_part_id}}.md, api-contracts-{{api_part_id}}.md, data-models-{{api_part_id}}.md{{else}}→ Reference: architecture.md{{#if has_api_docs}}, api-contracts.md{{/if}}{{#if has_data_models}}, data-models.md{{/if}}{{/if}}

Full-stack features: → Reference: All architecture docs{{#if is_multi_part}} + integration-architecture.md{{/if}}

Deployment changes: {{#if has_deployment_guide}}→ Reference: deployment-guide.md{{else}}→ Review CI/CD configs in project{{/if}}

---

Documentation generated by BMAD Method document-project workflow