doc-sync

Detect documentation and codebase drift through parallel audit and automated fixes.

175|26|Updated Aug 14, 2025
One-click install
npx skills add https://github.com/jmagly/aiwg --skill doc-sync-jmagly
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/jmagly/aiwg/tree/main/agentic/code/frameworks/sdlc-complete/skills/doc-sync
Command: npx skills add https://github.com/jmagly/aiwg --skill doc-sync-jmagly

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the common issue of documentation becoming outdated and inconsistent with the actual codebase, leading to confusion and errors.

Core Features & Use Cases

  • Automated Drift Detection: Identifies discrepancies between documentation and code.
  • Configurable Sync Direction: Supports code-to-docs, docs-to-code, or full bidirectional synchronization.
  • Automated Fixes: Attempts to automatically correct identified inconsistencies.
  • Use Case: Ensure your API documentation accurately reflects the latest code changes by running a "sync documentation" command.

Quick Start

Run a dry run to check for documentation and code mismatches.

Frequently Asked Questions about doc-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I detect documentation drift in my codebase?

Documentation drift is detected by running an automated audit that compares your codebase against your docs to identify discrepancies. The Skill orchestrates domain-specific auditors to report on inconsistencies and attempts automated fixes.

Can I automatically fix outdated API documentation to match code changes?

Yes, you can automatically fix outdated API documentation by running a synchronization command. The tool attempts to correct identified inconsistencies automatically, while providing a report on remaining discrepancies that require human intervention.

Does documentation synchronization support updating code from docs instead of just docs from code?

Documentation synchronization supports configurable sync directions, allowing you to update code from docs, docs from code, or perform full bidirectional synchronization. The tool detects the desired sync direction and scope from natural language context.

What is the best way to audit code and documentation inconsistencies before applying changes?

The best way to audit inconsistencies before applying changes is to run a dry run. This checks for documentation and code mismatches and generates a report classifying which discrepancies are auto-fixable and which require human review.

How does automated documentation sync handle complex code changes that require human review?

Automated documentation sync handles complex changes by providing a detailed report separating auto-fixable inconsistencies from those requiring human intervention. It orchestrates domain-specific auditors to ensure complex discrepancies are flagged for manual correction.

When should I avoid using automated documentation synchronization?

You should avoid relying solely on automated documentation synchronization when dealing with complex logic changes that require contextual understanding. The tool explicitly reports which inconsistencies require human review, ensuring critical discrepancies are not blindly auto-fixed.