Skills
.Work. You
Rest

test-doc-sync

Community

Keep tests and docs in sync.

Software Engineering#testing#documentation#refactoring#code sync#docstrings#pre-commit hook
Authormdmagnuson-creator
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill prevents outdated documentation and test comments by automatically synchronizing them with code changes, ensuring clarity and reducing developer confusion.

Core Features & Use Cases

  • Automated Keyword Extraction: Identifies changes in function names, variable names, string literals, comments, and class/type names from code diffs.
  • Semantic Expansion: Broadens search terms to catch variations and related phrases.
  • Targeted Search: Scans specified test and end-to-end directories for stale references.
  • Intelligent Handling: Automatically updates comments for minor changes, prompts for confirmation for moderate changes, and flags overly broad searches.
  • Use Case: Before committing a code refactor that renames several functions, run this skill to ensure all related test comments and docstrings are updated accordingly, preventing misleading documentation.

Quick Start

Run the test doc sync skill before committing behavior changes to ensure test comments and docstrings stay current.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 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: test-doc-sync
Download link: https://github.com/mdmagnuson-creator/helm-ade-toolkit/archive/main.zip#test-doc-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 223,000+ vetted skills library on demand.