documente

To generate project documentation with ADRs and C4 diagrams, run a template-driven command that creates a complete docs set including directory structure, architecture decisions, troubleshooting, and starter guides for your codebase.

You can update existing documentation surgically using git diff changes. This workflow analyzes recent codebase modifications and applies targeted upgrades to architecture diagrams and API examples without rewriting the entire documentation set.

This documentation generation workflow supports FastAPI projects by producing local README files, curl-ready API example snippets, and optional OpenAPI generation when the project stack supports it.

The best way to create new Architecture Decision Records is using a template-driven approach that automatically produces new ADR files with the next available sequential numbering for consistent architecture traceability.

You need to regenerate C4 architecture diagrams and troubleshooting notes after several development iterations to ensure onboarding materials match the latest codebase changes and maintain accurate system context.

Template-driven file creation for API-focused documentation is limited to software teams needing repeatable workflows for FastAPI-style backends, applying surgical git-diff updates rather than full rewrites for ongoing maintenance.