From sdlc-audit
Audit documentation: drift between docs and code, ADR coverage gaps, README quality, missing API docs.
How this command is triggered — by the user, by Claude, or both
Slash command
/sdlc-audit:audit-docs [--depth=quick|standard|deep] [--scope=path/to/dir]The summary Claude sees in its command listing — used to decide when to auto-load this command
# /audit:docs - Documentation Audit Поиск drift между документацией и реальным кодом. ## Что проверяется 1. **README quality** - есть ли, актуален ли, покрывает ли setup/run/test 2. **ADR coverage** - архитектурные решения задокументированы в ADR? 3. **API documentation** - endpoints / functions описаны? 4. **Inline docstrings** - публичные API без docstrings? 5. **Code examples drift** - примеры в docs реально работают? 6. **Outdated info** - упоминания старых версий, удалённых features 7. **Setup instructions accuracy** - реально ли можно поднять проект по docs 8. **Conventions documen...
Поиск drift между документацией и реальным кодом.
docs/specs/<feature>/brief.md?Используй subagent docs-auditor который применяет skill docs-audit.
Прочитай:
README.md (если есть)CONTRIBUTING.md, CHANGELOG.mddocs/, wiki/, documentation/ если естьМинимальные требования:
Если чего-то нет - finding.
Это пересекается с audit:architecture, но фокус другой - не "правильны ли решения", а "задокументированы ли решения".
Список значимых решений в коде vs ADR:
Прочитать docs которые упоминают конкретный код:
class FooBar - проверить что класс существует с этим именем/api/v1/foo - проверить что он реально определёнBAR_BAZ - проверить что она используетсяСоздай docs/audit/<TS>/docs/drift-report.md.
Если в README есть Quick Start или Setup:
В deep mode - попытаться выполнить инструкции в read-only режиме (если можно без побочных эффектов). Если не можно - не пытаться.
Записать в docs/audit/<TS>/docs/findings.json.
| Severity | Когда применять |
|---|---|
| HIGH | Setup инструкции в README не работают. Major architectural decisions без ADR. |
| MEDIUM | API endpoints без docs. Outdated examples. Missing CONTRIBUTING для public projects. |
| LOW | Typos, formatting issues, docstrings missing для internal helpers. |
Note: docs findings обычно не превышают HIGH - это редко блокирует production, но влияет на onboarding и maintenance.
docs/audit/<TS>/docs/npx claudepluginhub shakhovskiya-create/shakhoff-claude-marketplace --plugin sdlc-audit