documentation-guidelines

To generate consistent backend documentation, use a canonical template that aligns with repository guidelines, ensuring architecture diagrams, API endpoints, payloads, and seeding instructions remain standardized across multiple projects.

Document backend architecture and endpoints by generating a comprehensive module that includes Mermaid ERDs, flowcharts, data models, services, and payload constraints. This provides a single source of truth for both developers and AI agents.

Yes, this documentation approach supports Mermaid diagrams. The generation process explicitly ensures the inclusion of Mermaid ERDs and flowcharts to visualize backend architecture, data models, and service flows effectively.

Include database seeding instructions by adding them to the generated backend documentation module. This ensures developers and AI agents understand the specific procedures and constraints required to populate initial data.

Yes, you can document controllers, models, and services for frontend teams. The generated documentation organizes these components alongside API contracts and deployment notes, enabling consistent cross-project understanding for API consumers.