docs-as-definition-of-done

Documentation synchronization requires updating public API, CLI flags, and config shapes in the same commit as code changes. This approach enforces docs updates before commit, preventing stale or misleading documentation surfaces.

A documentation definition of done requires that all affected doc artifacts reflect code modifications before a task is declared complete. It aligns tests, code, and docs to present a coherent narrative for reviewers and AI agents.

Docs need updating whenever a task modifies behavior, interfaces, CLI surface, or config shape. Synchronizing docs in the same commit reduces misinformation risk for readers and AI agents loading context from the documentation.

Yes, the documentation sync workflow applies to any task modifying behavior, interfaces, or documentation surface areas across public APIs, CLI flags, and config shapes. It requires no external dependencies to enforce these doc updates.

Preventing stale documentation requires enforcing coordinated updates to tests, code, and docs within the same logical task. This ensures affected doc artifacts are updated before commit, aligning the code review narrative.