Community / AGENT SKILL

docs-audit

0 installs 2 GitHub stars

Read-only аудит дрейфа docs↔код — битые ссылки, устаревшие примеры/счётчики/версии, несинхронные языковые версии (роль docs). Use чтобы проверить, не врёт ли документация после изменений кода.

One new superpower.

Run this command in your project to choose an agent and install the skill.

npx skillycli add https://github.com/Vitammiin/agent-vorcl-flow --skill docs-auditView original source

BEFORE YOU INSTALL

Understand the trade-offs.

SECURITY REVIEW

Not yet assessed

Review the original instructions and requested permissions before installing.

No security review is available for this catalog entry yet.

SKILL QUALITY

Not yet assessed

How clearly the skill guides your agent, how complete its workflow is, and how you can check the outcome.

No quality assessment is available for this catalog entry yet.

The full skill.

Original instructions from the publisher’s SKILL.md

# Задача: аудит дрейфа документации

Найди дрейф доков относительно кода (**read-only**, см. `$technical-writing`).

1. Корпус: `README*`, `docs/**`, `ARCHITECTURE.md`, `CONTRIBUTING.md`, `CHANGELOG.md` (все `*.md`, минус `node_modules`).
2. Ссылки: относительные — существование файлов/якорей; внешние — хотя бы формат.
3. Примеры: команды — против `scripts`/бинарей (`npm run <x>` существует?); флаги/env/эндпоинты — грепом по коду; фрагменты кода — с текущими сигнатурами.
4. Счётчики и версии: «N модулей» — пересчётом файлов; версии — против `package.json`/манифеста/тегов; Node — против `engines`.
5. API-факты — против OpenAPI-спеки (спеки нет — отдельная находка, предложи `$swagger-audit`).
6. Языковой паритет (`README.md` vs `README.ru.md`): набор секций, факты/версии, идентичность кодовых блоков.

**Ничего не правь.** Формат находки: `file:line` — заявлено — в реальности (доказательство: греп/вывод) — severity (`critical>high>medium>low`; врущий quickstart = high+). По значимым — `add_task`. В конце — сводка дрейфа по документам (чисто/дрейф/сильно устарел).