doc-validate

A command for checking the quality and completeness of project documentation. It can inspect formatting, links, terminology, navigation, contradictions, and missing sections.

In plain words
What is it for?
Running focused checks before a commit or a full review before release, including broken links, unused pages, glossary terms, and documentation gaps.
Why use it?
It finds documentation problems that are easy to miss when reviewing pages one at a time.

Command

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add commands/dapi/claude-code-marketplace/doc-validate
Clone the repo
git clone --depth 1 https://github.com/dapi/claude-code-marketplace
Per session 10 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 583 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00010 $0.00583
Opus 5 $0.00005 $0.00292
Sonnet 5 $0.00002 $0.00117
Haiku 4.5 $0.00001 $0.00058

Measured 2d ago against content hash 9a0da5827cea, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

doc-validate scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

doc-validate/commands/doc-validate.md · 60 lines

What it actually says

Documentation Validation

Запусти Ruby скрипт для валидации документации проекта.

Алгоритм

  1. Найди скрипт:

    SKILL_DIR=$(dirname "$(find ~/.claude -name "doc_validate.rb" -type f 2>/dev/null | head -1)")
    
  2. Спроси пользователя какую проверку запустить:

Команда Описание Когда использовать
lint Форматирование, битые ссылки, naming Быстрая проверка перед коммитом
links Граф связей, orphans, dead-ends Проверка навигации
terms Терминология, глоссарий, синонимы После добавления новых терминов
viewpoints BABOK артефакты, state diagrams Проверка полноты моделирования
contradictions Конфликты значений, противоречия Поиск несоответствий
gaps Полнота покрытия, missing sections Анализ пробелов
review Полный аудит (все проверки + оценка) Перед релизом
  1. Выполни выбранную команду:

    ruby "$SKILL_DIR/doc_validate.rb" <command> --project="$(pwd)"
    
  2. Для интерактивного режима добавь --interactive:

    ruby "$SKILL_DIR/doc_validate.rb" <command> --interactive --project="$(pwd)"
    

Режимы

  • Default: Показывает все проблемы
  • Interactive (--interactive): Для каждой проблемы предлагает действия:
    • [f]ix — автоисправление (если доступно)
    • [s]kip — пропустить
    • [i]gnore — добавить в .docignore
    • [e]dit — открыть в редакторе
    • [x]plain — подробнее
  • Batch (--batch): Для CI/CD, exit codes: 0=ok, 1=warnings, 2=critical

Быстрые команды

Если пользователь сразу указал что проверять:

  • /doc-validate lint → сразу запустить lint
  • /doc-validate review → сразу запустить полный аудит
  • /doc-validate links --mermaid → граф с Mermaid диаграммой

Конфигурация

Проверь наличие .docvalidate.yml в корне проекта. Если нет — предложи создать из шаблона.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 60 lines · 10 tokens per session scan A 9a0da5827cea

Subscribe to this mod's changes

doc-validate is a command published in the GitHub repository dapi/claude-code-marketplace (16 stars, last pushed 4mo ago), licensed MIT. It adds 10 tokens to every session and 583 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.