document-release

You can automate keeping documentation in sync with shipped features by analyzing git diffs after releases, detecting drift between code and docs, and automatically updating affected files like README.md and CHANGELOG.md.

Documentation drift occurs when project docs no longer reflect the current codebase. Diff analysis detects this drift by comparing git changes after a release against the existing content in files like ARCHITECTURE.md and TODOS.md to identify outdated information.

Yes, you can automatically update a CHANGELOG.md and README.md based on git commits by running an inventory scan to locate core docs, analyzing the commit diffs, and applying automated updates to reflect the latest shipped features.

Yes, this automated documentation update approach works without external dependencies, as it independently inventories core docs, performs diff analysis, generates updates, and commits changes with a standardized message directly within your repository.

The best way to automate version control for project documentation is to use a tool that inventories your docs, analyzes code diffs, applies updates to stale files, and automatically commits the changes with a standardized message after every release.

You should avoid using automated diff analysis for documentation updates when a repository lacks core docs like README.md or ARCHITECTURE.md, as the process specifically relies on inventorying and updating these established files to ensure docs reflect current code.