documentation-sync

The Documentation Sync Skill is designed to maintain alignment between codebases and their corresponding documentation. As software evolves, discrepancies between actual code and documented information can emerge, leading to confusion, bugs, and onboarding challenges. This skill addresses these issues by detecting inconsistencies, validating code examples, generating diagrams, and updating documentation automatically. It ensures that developers and stakeholders can rely on accurate, up-to-date documentation without manual intervention, reducing errors and improving overall software quality.

Key features include detecting code/documentation drift by comparing API signatures, configuration options, and code examples; validating embedded examples to ensure they execute correctly; generating architecture and system diagrams using AST analysis; automatically updating README files with current API information; and analyzing documentation coverage to identify gaps and outdated sections. Outputs include detailed drift reports, validation reports, rendered diagrams, updated documentation with changelogs, and coverage metrics with improvement suggestions. These capabilities enable teams to maintain high-quality documentation that reflects the current state of the codebase.

This skill is ideal for development teams, technical writers, and project maintainers who need to ensure accurate documentation across releases, pull requests, and refactoring efforts. It is particularly useful when onboarding new team members, auditing documentation quality, or creating architecture diagrams. By automating repetitive verification and update tasks, it saves time and increases confidence in the documentation's reliability, making it a valuable tool for any project that requires precise, consistent, and actionable technical documentation.