Audit and maintain documentation files in the current project. This command checks for stale content, outdated references, redundancy, and suggests improvements.
Audits and maintains documentation files for freshness, broken links, and redundancy.
/plugin marketplace add evolv3-ai/vibe-skills/plugin install evolv3-ai-vibe-skills@evolv3-ai/vibe-skillsAudit and maintain documentation files in the current project. This command checks for stale content, outdated references, redundancy, and suggests improvements.
/update-docs [scope]
Scope options:
all (default) - Full audit of all documentationquick - Check dates and versions onlyarchive - Focus on archiving old contentScan for documentation in priority order:
Priority 1 (Core):
- CLAUDE.md (project instructions)
- README.md (public-facing)
- SESSION.md (session state)
Priority 2 (Project docs):
- docs/*.md (architecture, API, database, etc.)
- CHANGELOG.md, CONTRIBUTING.md, LICENSE
Priority 3 (Root files):
- *.md in project root
- *.txt in project root
Priority 4 (Planning/working):
- planning/*.md
- archive/*.md (check if should be deleted)
For each documentation file, check:
Date Freshness:
git log -1 --format="%ci" <file>Version References:
hono@4.10.1, v4.1.14)npm view <pkg> versionBroken Links:
[text](./path/to/file.md)Redundancy:
Staleness Indicators:
Organization & Maintainability:
Warning signs to flag:
Healthy patterns (don't flag these):
Orphaned Files:
Present findings organized by severity:
## Documentation Audit Report
### Critical (Action Required)
- [ ] CLAUDE.md: "Last Updated" says 2024-09-15, last git change 2025-12-01
- [ ] README.md: References `hono@3.5.1`, current is `4.10.1`
- [ ] Broken link: docs/API.md references `./auth.md` (file missing)
### Warnings
- [ ] SESSION.md: Completed phases not compressed (5 detailed phases could be summaries)
- [ ] docs/old-architecture.md: Not referenced anywhere (orphaned?)
- [ ] CHANGELOG.md: No entry for recent commits
### Suggestions
- [ ] planning/research-log.md: Contains 3 TODO items
- [ ] docs/DATABASE.md and docs/SCHEMA.md have 60% overlap
For each category, offer to fix:
Auto-fixable (proceed without asking):
Requires Confirmation:
archive/ directoryRequires Explicit Approval (ask before each):
When archiving content:
# Create archive directory if needed
mkdir -p archive/docs
# Move with date prefix
mv docs/old-file.md archive/docs/2025-12-old-file.md
# Or for session logs
mv SESSION.md archive/session-logs/2025-12-02-session.md
SESSION.md Compression:
Transform completed phases from:
## Phase 3: Auth API
**Started**: 2025-11-01
**Completed**: 2025-11-05
### Tasks
- [x] JWT verification
- [x] Session middleware
- [x] Login endpoint
- [x] Logout endpoint
### Notes
Detailed implementation notes...
To:
## Phase 3: Auth API ✅
**Completed**: 2025-11-05 | **Checkpoint**: abc1234
**Summary**: JWT + session middleware + login/logout endpoints
After completing audit:
## Documentation Update Complete
**Files Audited**: 12
**Issues Found**: 7
**Auto-Fixed**: 4
**Archived**: 2
**Skipped**: 1 (user declined)
### Changes Made:
- Updated "Last Updated" in CLAUDE.md, README.md
- Updated package versions in docs/SETUP.md
- Archived planning/old-research.md → archive/planning/
- Compressed 3 completed phases in SESSION.md
### Remaining Issues:
- [ ] docs/API.md: Broken link to auth.md (needs manual fix)
- [ ] Consider deleting: archive/2024-notes.md (365 days old)
### Next Steps:
1. Review changes: `git diff`
2. Fix remaining issues manually
3. Commit: `git add -A && git commit -m "docs: Update and clean documentation"`
Run Regularly:
Trust But Verify:
Project-Specific Patterns:
/update-docsUpdate implementation documentation including specs, status, and best practices
/update-docsUpdate and maintain project documentation for local code changes using multi-agent workflow with tech-writer agents. Covers docs/, READMEs, JSDoc, and API documentation.