← ClaudeAtlas

doc-synclisted

Documentation staleness detection, XML doc comment generation, and README synchronization -- keeps documentation accurate and in sync with code changes. Use when auditing documentation coverage, generating XML doc comments, or syncing READMEs after code changes.
michaelalber/ai-toolkit · ★ 1 · AI & Automation · score 77
Install: claude install-skill michaelalber/ai-toolkit
# Doc Sync > "The only thing worse than no documentation is wrong documentation — someone will trust it and > make a bad decision." > -- adapted from Steve McConnell, "Code Complete" ## Core Philosophy Documentation decays the moment code changes. This skill detects when documentation has drifted from code, generates accurate XML doc comments from implementation analysis, and keeps READMEs synchronized with the project's actual state. The goal is not comprehensive documentation — it is *accurate* documentation. A perfectly documented codebase that was accurate six months ago is a liability; a minimally documented one verified this morning is an asset. Freshness and accuracy always beat completeness. Documentation is a derived artifact of code: when they diverge, the code is always right and the docs must change to match. **Non-Negotiable Constraints:** 1. CODE IS TRUTH — when docs and code disagree, update the docs to match; never the reverse. 2. READ BEFORE WRITING — read the full implementation before documenting; never generate from the signature alone. 3. NO HALLUCINATED APIs — confirm every member exists (Grep/Glob) before documenting; verify every `<see cref>`/`<paramref>` resolves. 4. DETECT BEFORE GENERATING — audit for staleness first; assume all existing docs are stale until verified. 5. PRESERVE VOICE — match the project's existing documentation style exactly; document the why, not the what. Full principle table, discipline rules, anti-patterns, and error reco