update-docs

To keep design docs in sync with code changes, you propagate modifications from git into requirements, basic design, and OpenAPI specs. This maintains traceability and reduces documentation drift when the design-first workflow is bypassed.

You can update only affected sections of an OpenAPI spec by performing a two-stage diff analysis on code changes. This partial update approach targets specific modified files mapped via spec-map.yml, maintaining baseline integrity without rewriting entire docs.

Tracing code modifications back to requirement IDs is best handled using a spec-map.yml file. It identifies modified files from git changes, maps them to existing specification IDs, and proposes new REQ IDs if the changes require them.

An integrity check validates documentation updates by comparing the newly written content against a unified spec baseline. This self-check mechanism occurs after delegated spec writing, ensuring the propagated code changes maintain overall design-doc alignment.

Yes, you can trace git changes to documentation without manual rewrites by mapping modified files to specification IDs. The process delegates the actual writing to a spec-writer while performing automatic integrity checks to ensure alignment.

You should avoid automated documentation sync if your code changes are not tracked by git or lack a spec-map.yml configuration. The process relies on a two-stage diff analysis and mapped specification IDs to perform partial updates and maintain traceability.