Detect and correct documentation staleness in XML doc comments and README files.
npx skills add https://github.com/michaelalber/ai-toolkit --skill doc-sync-michaelalber
Please help me install this Agent Skill. Skill: doc-sync Source: https://github.com/michaelalber/ai-toolkit/tree/main/skills/doc-sync Command: npx skills add https://github.com/michaelalber/ai-toolkit --skill doc-sync-michaelalber
This Skill combats documentation decay, ensuring that your code's documentation remains accurate and synchronized with code changes, preventing misleading information.
Run the doc-sync skill to scan the 'src/Services' directory for documentation staleness.
High-intent search queries and answers about installing and using this skill.
To detect documentation staleness, you can scan your codebase to systematically compare XML doc comments against current source code and git history, identifying API signature drift and generating accurate updates.
Updating a README to reflect the current project state involves systematic synchronization, comparing project overviews and usage examples against the actual source code to correct outdated information and ensure accuracy.
Generating missing XML documentation for new code members requires analyzing the source code to detect undocumented members, then creating accurate XML doc comments based on the analyzed code signatures and logic.
Yes, you can audit documentation accuracy by scanning a specific directory like 'src/Services', systematically comparing the contained source code against existing XML comments and README files to find drift.
Documentation decay happens after refactoring an API because code implementations change without corresponding updates to XML doc comments or README files, causing misleading information and API signature drift.
Using git history for documentation synchronization relies on accurate commit tracking, meaning uncommitted local changes or heavily branched histories may limit the effectiveness of systematic source code comparisons for staleness detection.
naporin0624Detect secrets and credentials in git repositories using Gitleaks.
anishi1222Review README, API specifications, and code comments for documentation quality.
Jaydpatel01Enforce code correctness, readability, and safety with linters and type checkers.
mouayadakelGenerate README files, JSDoc comments, and API specifications for software features.
