doc-code-sync

Community

Maintain document-code consistency with detailed reporting.

Authorstanah
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill ensures the integrity between project documentation and source code, detecting discrepancies in 6 categories for accurate reporting.

Core Features & Use Cases

  • Integrity Checks: Identifies missing references, undocumented code, stale examples, configuration drift, API drift, and version drift.
  • Detailed Reporting: Provides a comprehensive report highlighting the discrepancies with categorization and severity levels.
  • Use Case: Ideal for developers and documentation writers who want to ensure their project's documentation and codebase are in sync, minimizing errors and confusion.

Quick Start

Run the doc-code-sync skill to initiate a sync check between your code and documentation.

Dependency Matrix

Required Modules

pythontypescriptsolidity-parsersolcnodegorustcargonumpypandas

Components

scriptsreferencesassets

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: doc-code-sync
Download link: https://github.com/stanah/dotagents/archive/main.zip#doc-code-sync

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 620,000+ vetted skills library on demand.