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

Content Management

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

About

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.

Key Features

Configurable update modes including Full Sync and Accuracy Check
Git-based staleness detection using commit history
Architecture diagram synchronization with current code structure
Automated codebase-to-docs gap analysis
In-place updates that preserve existing structure and formatting
0 GitHub stars

Use Cases

Fixing outdated installation commands and code examples in technical guides
Updating a README.md to reflect major API changes or new feature releases
Synchronizing architecture diagrams with recent backend structural changes

About

Key Features

Configurable update modes including Full Sync and Accuracy Check
Git-based staleness detection using commit history
Architecture diagram synchronization with current code structure
Automated codebase-to-docs gap analysis
In-place updates that preserve existing structure and formatting
0 GitHub stars

Use Cases

Fixing outdated installation commands and code examples in technical guides
Updating a README.md to reflect major API changes or new feature releases
Synchronizing architecture diagrams with recent backend structural changes