skills.rest
stanah
stanahCOMMUNITY
Explore all skills by this author →
GitHub

doc-code-sync

Detects discrepancies between documentation and source code across six categories using AST parsing and grep patterns.

Updated Feb 4, 2026
Search Tags:#version control#code documentation#source code analysis#integrity check#sync report
One-click install
npx skills add https://github.com/stanah/dotagents --skill doc-code-sync
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-code-sync
Source: https://github.com/stanah/dotagents/tree/main/.claude/skills/doc-code-sync
Command: npx skills add https://github.com/stanah/dotagents --skill doc-code-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python, typescript, solidity-parser, solc, node, go, rust, cargo, numpy, pandas, and includes scripts (resource) and references (resource) and assets (resource) components.

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.

Frequently Asked Questions about doc-code-sync

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

FAQPage Schema
How do I check for inconsistencies between project documentation and source code?▼

To check documentation and source code inconsistencies, run a sync check that utilizes AST parsing and grep patterns to detect discrepancies across six categories, ensuring project integrity.

What types of documentation drift can an automated code sync report detect?▼

A code sync report detects missing references, undocumented code, stale examples, configuration drift, API drift, and version drift, categorizing each discrepancy with severity levels.

Does this documentation integrity check work with Python, TypeScript, and Solidity?▼

Yes, documentation integrity checks support Python, TypeScript, and Solidity, alongside Node, Go, and Rust, requiring language-specific parsers like solc, cargo, and solidy-parser for AST analysis.

How do I generate a sync report highlighting API drift and configuration drift?▼

Generate a sync report by running the check against your codebase to identify API drift and configuration drift, providing a comprehensive report highlighting discrepancies with categorization and severity levels.

Do I need AST parsing to find undocumented code in my source code?▼

Yes, AST parsing is required to accurately find undocumented code, as it analyzes the source code structure alongside grep patterns to detect discrepancies and ensure document-code consistency.

Related Skills

Explore More Software Engineering Skills→
trailofbitstrailofbits
6.5k

devcontainer-setup

Automate devcontainer creation with Claude Code and language-specific tools.

Official
Advanced
ousiassousiass

doc-drift-git

Detect documentation drift between code changes and Git diffs.

Community
Intermediate
novskidevnovskidev
2

requesting-code-review

Dispatch a subagent to perform automated code reviews on git commits.

Community
Intermediate
jikimejikime
5

jikime-tool-ast-grep

Perform AST-based code analysis, security scanning, and refactoring across 40+ languages.

Community
Advanced