Skip to content
Back to skills

Docs Audit

ASecurity

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

  • 2 stars
  • 0 votes
  • 0 copies
  • 0 views
  • Added September 11, 2026
documentationnodeapi

Works with

  • api

Security analysis

A100/100

Scanned September 11, 2026

npx -y skills add Vitammiin/agent-vorcl-flow --skill docs-audit --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Docs Audit?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Docs Audit
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/vitammiin-docs-audit/badge)](https://www.skillsdirectory.com/skills/vitammiin-docs-audit)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

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

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

Найди дрейф доков относительно кода (**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`. В конце — сводка дрейфа по документам (чисто/дрейф/сильно устарел).

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…