test-doc-sync

Synchronize test documentation with code changes by extracting keywords from diffs.

Updated Mar 11, 2026
One-click install
npx skills add https://github.com/mdmagnuson-creator/helm-ade-toolkit --skill test-doc-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: test-doc-sync
Source: https://github.com/mdmagnuson-creator/helm-ade-toolkit/tree/main/skills/test-doc-sync
Command: npx skills add https://github.com/mdmagnuson-creator/helm-ade-toolkit --skill test-doc-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

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

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.

Frequently Asked Questions about test-doc-sync

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

FAQPage Schema
How do I keep test comments and docstrings in sync with code refactoring?

To keep test documentation in sync with code refactoring, this Skill automates extracting keywords from code diffs, performing semantic expansion, and searching test files for stale references. It automatically updates comments for minor changes and prompts for confirmation on moderate changes.

How does automated documentation synchronization handle stale references in test files?

Automated documentation synchronization handles stale references by scanning specified test and end-to-end directories for outdated keywords extracted from code diffs. It prioritizes files already modified in the current change and intelligently handles updates based on the number of matches found.

Can I use this Skill as a pre-commit hook to update test documentation?

Yes, you can use this Skill as a pre-commit hook to update test documentation. Running it before committing behavior changes ensures test comments and docstrings stay current with evolving functionality, preventing misleading documentation and reducing developer confusion.

What is the best way to automate docstring updates when renaming functions?

The best way to automate docstring updates when renaming functions is using a tool that extracts function names from code diffs and searches test directories for stale references. This Skill broadens search terms semantically to catch variations and related phrases.

What happens when a documentation sync search returns overly broad matches?

When a documentation sync search returns overly broad matches, the Skill flags these overly broad searches instead of automatically applying updates. It intelligently differentiates between minor changes, which it updates automatically, and moderate changes, which require user confirmation.