What happens if my documentation is extremely old?

If the skill determines that more than 50% of the documentation needs a total rewrite, it will intelligently suggest using the /docs-write skill instead for a fresh start.

Does it support updating Mermaid or architecture diagrams?

Yes, the skill includes a specific option to identify and sync architecture diagrams with the current codebase structure.

Does this skill overwrite my entire README?

No, the skill is designed to update documents in-place, preserving your existing structure and high-quality content while only modifying outdated or incorrect sections.

Can it detect which files are actually outdated?

Yes, it uses git logs and file timestamps to compare the last update of your documentation against the most recent changes in your source code.

Documentation Auto-Sync

Name: Documentation Auto-Sync
Author: jjeremycai

byjjeremycai

0•

コンテンツ管理

Synchronizes existing project documentation with the current codebase to ensure READMEs and guides remain accurate and up-to-date.

The Documentation Auto-Sync skill automates the maintenance of technical docs by comparing existing Markdown files against actual codebase changes. Using the @writer agent, it identifies stale information, deprecated features, and missing documentation for new code additions. It offers granular control over the update process, allowing users to choose between a full synchronization, a focus on new features, or a simple accuracy check for examples and commands, ensuring that your documentation never falls behind your development velocity.

主な機能

01Configurable update modes including Full Sync and Accuracy Check

02Git-based staleness detection using commit history

03Architecture diagram synchronization with current code structure

04Automated codebase-to-docs gap analysis

05In-place updates that preserve existing structure and formatting

060 GitHub stars

ユースケース

01Fixing outdated installation commands and code examples in technical guides

02Updating a README.md to reflect major API changes or new feature releases

03Synchronizing architecture diagrams with recent backend structural changes

主な機能

01Configurable update modes including Full Sync and Accuracy Check

02Git-based staleness detection using commit history

03Architecture diagram synchronization with current code structure

04Automated codebase-to-docs gap analysis

05In-place updates that preserve existing structure and formatting

060 GitHub stars

ユースケース

01Fixing outdated installation commands and code examples in technical guides

02Updating a README.md to reflect major API changes or new feature releases

03Synchronizing architecture diagrams with recent backend structural changes