documenting-code

To keep documentation in sync with code changes, this Skill automates updating READMEs, API docs, and guides based on recent commits. It enforces project style, adds changelog notes, and runs docs-check tooling to verify completeness.

Updating API docs for new endpoints is handled by scanning recent code changes and automatically refreshing API references and README usage examples. This ensures interfaces and behaviors reflect the current codebase without manual editing.

Validating that docs match current interfaces is done through built-in consistency checks. The Skill flags mismatches between documentation and actual code behaviors, then applies policy-driven updates to eliminate drift.

Yes, this documentation sync approach is designed for codebases with frequent changes and multi-file documentation. It applies policy-driven updates across all relevant files to maintain consistency regardless of change volume.

Documentation drifts out of date after code updates when changes are committed without refreshing corresponding docs. This Skill prevents drift by enforcing changelog notes and verifying completeness using defined docs-check tooling.

Yes, you can enforce project style guidelines during documentation updates. The Skill validates that all refreshed READMEs, API docs, and contribution guidelines meet defined style policies before changes are finalized.