doc-sync
4
总安装量
4
周安装量
#50539
全站排名
安装命令
npx skills add https://github.com/acedergren/agentic-tools --skill doc-sync
Agent 安装分布
amp
4
gemini-cli
4
claude-code
4
github-copilot
4
codex
4
kimi-cli
4
Skill 文档
Documentation Sync Audit
Audit all project documentation against the actual codebase and report (or fix) any drift.
Steps
-
Identify documentation files: Find all
.mdfiles indocs/, project root, and.claude/reference/that describe architecture, security, testing, or roadmap. -
Audit architecture docs against the codebase:
- Check main entry point â does the plugin/middleware chain match the documented order?
- Check routes directory â are all route modules listed?
- Check shared packages â are all exports documented?
- Check monorepo layout â does the documented tree match actual directory structure?
-
Audit security docs:
- Check security plugins/middleware â are all documented?
- Check for new security-related commits since last doc update
- Verify permission counts match actual definitions
-
Audit test docs:
- Count actual test files
- Run test suite to get current pass counts
- Compare documented test counts to actual counts
-
Audit roadmap/changelog:
- Check git log for commits not reflected in any documented phase
- Verify completed phases are marked done
-
Audit CLAUDE.md / agent instructions:
- Check naming conventions match actual code patterns
- Verify documented file paths still exist
- Confirm anti-patterns section is current
-
Report findings:
| Doc | Section | Issue | Severity | |-----|---------|-------|----------| -
Fix drift (if
$ARGUMENTScontains “fix”):- Make targeted edits to fix each drift item
- Commit with
docs: sync documentation with codebase [doc-sync]
If $ARGUMENTS is empty or “audit”, only report â don’t edit.
Arguments
$ARGUMENTS:audit(default, report only) orfix(report and fix drift)
When to Run
- Before creating a pull request (
/doc-sync audit) - After completing a development phase (
/doc-sync fix) - After any structural changes (new plugins, routes, migrations)