documentation

documentation is a skill for Codex from kreek/consult. It costs 26 tokens per session (770 once invoked), scanned A, original, MIT.

Guidance for documenting existing software and systems in READMEs, runbooks, API documentation, module notes, and code comments. It focuses on describing how the code works now.

In plain words
What is it for?
Use it when writing or reviewing documentation for existing code, including Consult skill files, setup guides, operational procedures, and API or module references.
Why use it?
It keeps explanations close to the code or team responsible for them and avoids documenting behavior that does not exist. It also helps decide when code, tests, schemas, or generated references should be the source of truth.

Skill for Codex

Written for Codex: agents/openai.yaml present. Also seen: installed under .agents/ (shared by several agents).

Good fit Use it when writing or reviewing documentation for existing code, including Consult skill files, setup guides, operational procedures, and API or module references.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/kreek/consult/documentation
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.

Any agent
npx skills add kreek/consult --skill documentation
Clone the repo
git clone --depth 1 https://github.com/kreek/consult

Made for: Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for documentation

README.md
[![agentmods](https://agentmods.dev/badge/skills/kreek/consult/documentation/github.svg)](https://agentmods.dev/skills/kreek/consult/documentation)
Your own site
<a href="https://agentmods.dev/skills/kreek/consult/documentation"><img src="https://agentmods.dev/badge/skills/kreek/consult/documentation/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for documentation

Your own site · 80×15
<a href="https://agentmods.dev/skills/kreek/consult/documentation"><img src="https://agentmods.dev/badge/skills/kreek/consult/documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 26 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 770 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00026 $0.00770
Opus 5.5 $0.00010 $0.00308
Sonnet 5.5 $0.00005 $0.00154
Haiku 4.5 $0.00003 $0.00077

Measured 16d ago against content hash e3c7813a00a3, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

documentation 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 16d 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.

agents/.agents/skills/documentation/SKILL.md · 68 lines

How it starts

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

Documentation

Iron Law

DOCUMENT ONLY WHAT NEEDS PROSE. KEEP DOCS NEAR THE CODE, CONTRACT, OR TEAM THAT MAINTAINS THEM.

When to Use

  • The user asks for or approves READMEs, runbooks, tutorials, how-to guides, reference docs, module docs, or code comments describing code as it exists.
  • Authoring or revising Consult SKILL.md files; skills are documentation for agents and follow the same rules.

When NOT to Use

  • Forward-looking documents: design docs, ADRs, RFCs, tech specs, PRDs, requirements, strategy. Consult does not cover these; use a dedicated writing skill such as Terse.
  • Ordinary implementation where docs were not requested, approved, or required by a validator. Name the possible gap in the final response instead of editing docs.
  • CHANGELOG, release notes, migration notes, version manifests; use release. API contract shape; use api.

Rules

  1. Documentation is a separate work product, not an implementation reflex. Run only when requested, approved after a concrete gap is found, or required by validation.
  2. Check whether the answer already lives in code, schema, tests, CLI help, OpenAPI, or a dashboard. Write only the missing context and link the source of truth; do not restate generated facts.
  3. Encode the rule in names, types, schemas, or tests first. Add a comment only for the why that remains non-obvious.
  4. One doc, one reader situation (tutorial, how-to, reference, explanation, runbook), titled as the reader's question. Introduce terms and prerequisites before the step that depends on them.
  5. README is purpose, install and run, minimal usage, and links onward.
  6. Voice: plain, direct, concrete sentences, no em dashes, only words that earn their place. Split any sentence that needs rereading.
  7. Delete stale docs you cannot fix now, or mark them with a tracked rewrite owner. Orphaned prose is misinformation.
  8. Put docs next to the code or service whose reviewers can catch drift, in the repo's existing docs system. If none exists, choose one during scaffolding or with user approval.

Read the full file on GitHub · 68 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 16d ago Changed · +2 tokens per session e3c7813a00a3
  2. 1mo ago Changed · -52 lines e37145fd773f
  3. 1mo ago First seen · 120 lines · 24 tokens per session scan A fe2bb970a3d9

Subscribe to this mod's changes

documentation is a skill published in the GitHub repository kreek/consult (1 stars, last pushed 17d ago), licensed MIT. It adds 26 tokens to every session and 770 once invoked, about $0.0001 per session on Opus 5.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-31.

Related

Other skills, from other repositories

arch-review

Team baseline for architecture, design-doc, and RFC review — produces summary, strengths, concerns, and open questions. Auto-triggers when you say review this design, review this architecture, review this proposal, review my RFC, poke holes in this proposal, is this design sound, or critique this tech spec. Defers to…

ramboz/jig · 207 tokens

clarify

Lightweight spec clarification scan for jig projects — a six-category ambiguity audit that asks up to five prioritized questions and appends them to the spec's ## Clarifications section. Auto-triggers when you say clarify this spec, audit this spec for ambiguities, is this spec ready for review, find unknowns in this…

ramboz/jig · 153 tokens

explain

Explain jig vocabulary and artifacts in plain language. Three modes: term mode defines one lexicon term; artifact mode walks through a spec or ADR and its linked references; passage mode explains pasted jig output. Output is ephemeral (chat-only). Auto-triggers when you say explain this term, walk me through this…

ramboz/jig · 173 tokens

pr-review

Team baseline for PR and code review — produces scope, blockers, nits, and strengths. Auto-triggers when you say review this PR, check this diff, review these changes, pre-review before I share, what do you think of this PR, or review the diff on this branch. Defers to any other installed skill whose description…

ramboz/jig · 183 tokens

security-review

Team baseline for security review — a best-effort heuristic security pass over a diff or change-set. Auto-triggers for review this for security, any vulnerabilities here, security pass on this diff, is this code secure, check this for security issues, or security review this. Uses installed scanners when available…

ramboz/jig · 147 tokens

contracts

Team baseline for external-interface contract artifacts: OpenAPI, JSON Schema, AsyncAPI, .proto, and GraphQL SDL, with spectral, ajv, buf, and graphql-inspector validation. Nudges devs toward contract-first artifacts; never writes them and never scaffolds a contracts/ directory. Auto-triggers for what contract should…

ramboz/jig · 163 tokens