| name | doc-sync |
| description | Audit recent development changes and update project documentation. Use when documentation is outdated after a sprint, when asked to update CLAUDE.md or README.md, or when creating a user testing guide after new features are added. |
| allowed-tools | Read, Write, Glob, Bash |
Documentation Sync & Testing Guide Generator
When to use this Skill
After a period of active development where CLAUDE.md, README.md, or user-facing documentation has fallen behind the codebase.
Instructions
Step 1: Audit current state
- Run
git log --oneline --since="7 days ago" to surface recent commits
- Read CLAUDE.md and README.md to identify what's currently documented
- Glob for recently modified source files to identify undocumented features
- Note all features added, modified, or removed
Step 2: Update CLAUDE.md
- Complete feature list with descriptions
- Architecture changes
- New dependencies or data sources
- Known issues and limitations
- Development notes
Step 3: Update README.md
- User-facing feature overview
- Installation and deployment instructions
- Data sources and update cadence
- Usage examples
Step 4: Update USER-TESTING.md
For each feature, document:
- Feature name
- Test objective
- Step-by-step instructions with exact selections (e.g., "Select Tract → Cook County, IL → Race/Ethnicity → Asian %")
- Expected result
- Pass/fail criteria
Additionally:
- Update existing tests based on any added features
Coverage checklist
- Core workflows (state / county / tract selection)
- New features (R/ECAP, downloads, comparisons, toggles)
- Data unavailability scenarios
- Filter state management
- Visual enhancements (tooltips, highlighting, labels)
- Download functionality (map PNG, table CSV)
- Table toggle modes
- Chart comparisons (county / state)
- Address search
- Sources & Notes
- Edge cases (rapid selections, missing data, CT boundary issues)
- Browser compatibility
- Performance benchmarks
