documentation-audit
Проверка точности документации относительно кодовой базы
也可从以下获取: 2389-research
Расхождение документации вызывает путаницу и ошибки. Этот навык систематически проверяет утверждения в markdown-документации относительно фактической кодовой базы, используя двухпроходный подход с расширением паттернов для обнаружения подобных проблем.
下载技能 ZIP
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
开启并开始使用
测试它
正在使用“documentation-audit”。 Audit the documentation files in docs/ for accuracy
预期结果:
- Documentation Audit Report - Generated: 2026-01-10
- Executive Summary: 12 documents scanned, ~180 claims verified
- Verified TRUE: 145 claims (81%)
- Verified FALSE: 31 claims (17%) requiring fixes
- False Claim - CONFIGURATION.md:135 - 'claude-sonnet-4-5' should be 'claude-3-5-sonnet-latest'
- Pattern Found: 9 dead script references across 4 files
- Human Review Queue: 4 behavioral claims need verification
安全审计
低风险Prompt-based skill using Plan agent for documentation verification. Operates through read-only filesystem operations and claim extraction without executing code or making network calls. No malicious patterns detected.
风险因素
📁 文件系统访问 (3)
⚙️ 外部命令 (2)
质量评分
你能构建什么
Проверка перед выпуском
Проверьте точность всей документации перед развертыванием или выпуском релизов
Проверка после рефакторинга
Обнаружьте расхождение документации после рефакторинга или переименования файлов и сервисов
Аудит документации
Систематически сканируйте документацию на наличие устаревших ссылок и ложных утверждений
试试这些提示
Audit these documentation files for accuracy: [list files]
Run a complete documentation audit of this project. Focus on user-facing docs only.
Check if documentation matches reality after our recent refactor. Look for dead script references, renamed services, and outdated config defaults.
I found a dead script reference. Search all docs for similar patterns and verify each one.
最佳实践
- Используйте параллельные агенты для извлечения для максимальной эффективности при работе с несколькими документами
- Всегда выполняйте расширение паттернов во втором проходе — это обнаруживает на 10-20% больше проблем
- Записывайте доказательства (файл:строка) для каждого вердикта для поддержки предложенных исправлений
避免
- Пропуск расширения паттернов во втором проходе значительно снижает обнаружение проблем
- Доверие документации, которая «выглядит правильно», без проверки приводит к скрытому расхождению
- Аудит дизайн-документов или планов вместо пользовательской документации тратит усилия впустую
常见问题
Какие типы утверждений этот навык может проверять автоматически?
Изменяет ли этот навык мои файлы документации?
Что такое расширение паттернов во втором проходе?
Сколько времени занимает полный аудит?
Можно ли интегрировать это в CI/CD пайплайны?
Чем это отличается от линтеров или статического анализа?
开发者详情
许可证
MIT
引用
main
文件结构