doc-review

A documentation review guide for AsciiDoc and Markdown files, two common formats for writing technical documents.

In plain words
What is it for?
Use it to check, proofread, lint, or audit documentation files and directories for style compliance.
Why use it?
It finds and fixes violations of the Red Hat/IBM Style Guide while applying rules suited to each file format.

Skill for Claude CodeCodex

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 skills/validatedpatterns/docs/doc-review
Any agent
npx skills add validatedpatterns/docs --skill doc-review
Clone the repo
git clone --depth 1 https://github.com/validatedpatterns/docs

Made for: Claude Code, Codex.

Per session 123 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,800 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.00123 $0.01800
Opus 5 $0.00062 $0.00900
Sonnet 5 $0.00025 $0.00360
Haiku 4.5 $0.00012 $0.00180

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

Security

Grade A, and why

doc-review 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.

.rulesync/skills/doc-review/SKILL.md · 130 lines

How it starts

The opening of the file, as written. The whole thing — 130 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Review the documentation file(s) at $ARGUMENTS for compliance with the Red Hat/IBM Style Guide. Follow the workflow below precisely.


Step 1: Resolve targets

  • If $ARGUMENTS is empty, ask the user which file(s) or directory to review.
  • If $ARGUMENTS is a directory, recursively glob for all *.adoc, *.md, and *.markdown files.
  • If $ARGUMENTS is a file, use it directly.
  • If no matching files are found, inform the user and stop.

Step 2: Detect format and scan for likely violations (two-pass strategy)

For each file, detect the format by extension:

Extension Format
.adoc AsciiDoc
.md, .markdown Markdown

Pass 1: Quick scan and guide selection

Read the file and scan for signals that indicate which rules are likely violated. Then load only the guides that are relevant, rather than all 24. This keeps reviews efficient without sacrificing coverage.

Always load these high-impact guides first (they catch the most common issues):

Priority Guide file Topic Load when you see...
P1 guides/minimalism.md Conciseness, scannability, removing fluff Long paragraphs, "in order to", "this section describes", filler adverbs
P2 guides/passive-voice.md Prefer active voice "is/are/was/were/been + past participle", "can be", "should be"
P3 guides/avoid-these-words.md Full banned words table Any uncertain word choice
P4 guides/capitalization.md Sentence-style capitalization Title-case headings
P5 guides/titles-and-headings.md Gerunds for procedures, nouns for concepts Procedural headings that don't start with a gerund
P6 guides/contractions.md Avoid contractions Apostrophes in words (don't, won't, it's, you'll)
P7 guides/conscious-language.md Inclusive terminology whitelist, blacklist, master, slave, sanity
P8 guides/anthropomorphism.md No human traits for products "system knows", "tries to", "smart enough"

Read the full file on GitHub · 130 lines

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 · 130 lines · 123 tokens per session scan A 1d6072b222d6

Subscribe to this mod's changes

doc-review is a skill published in the GitHub repository validatedpatterns/docs (20 stars, last pushed 7d ago), licensed Apache-2.0. It adds 123 tokens to every session and 1,800 once invoked, about $0.0006 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.