update-architecture

To keep architecture documentation in sync, you can automate the analysis of code diffs to update markdown files. This ensures your architecture docs accurately reflect the current codebase and prevents documentation drift.

The best way to update architecture docs is by refreshing a single target location at a time after code diffs. This approach traces data reads and writes while rebuilding documentation from first principles to preserve cross-links.

Updating architecture documentation enforces a standard 8-file structure per location. Adhering to this structure ensures that navigation and rationale behind design decisions are preserved during the update.

You cannot refresh multiple locations simultaneously; the process enforces a one-location-at-a-time scope. This constraint ensures thorough traceability of data reads and writes before rebuilding the target documentation.

Architecture documentation drifts because manual updates lag behind continuous code changes. Automating the documentation refresh process after diffs aligns the markdown files with the implementation, maintaining trust between code and docs.