document

A writing guide for repository and product documentation, including READMEs, user guides, API references, architecture notes, migration notes, and changelogs.

In plain words
What is it for?
Use it to write or update technical documentation in a code repository. It does not create Word documents or publish releases.
Why use it?
It helps keep documentation aimed at the right readers, avoid duplicate pages, verify commands and paths, and clearly mark unknown information.

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/hmbown/codewhale/document
Any agent
npx skills add Hmbown/CodeWhale --skill document
Clone the repo
git clone --depth 1 https://github.com/Hmbown/CodeWhale

Made for: Claude Code, Codex.

Per session 0 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 149 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.00000 $0.00149
Opus 5 $0.00000 $0.00075
Sonnet 5 $0.00000 $0.00030
Haiku 4.5 $0.00000 $0.00015

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

Security

Grade A, and why

document 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.

crates/tui/assets/skills/document/SKILL.md · 21 lines

What it actually says

Document

When to use

Use for repo/product docs: README, guides, API docs, architecture, migrations, changelog notes.

Non-goals

  • Not Word/DOCX authoring (use docx).
  • Not release publication (use release only when explicit).

Workflow

  1. Identify the doc audience and location.
  2. Prefer updating existing docs over creating duplicates.
  3. Keep commands and paths verified.
  4. Call out unknowns instead of inventing them.
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 · 21 lines · 0 tokens per session scan A 4d37e7872519

Subscribe to this mod's changes

document is a skill published in the GitHub repository Hmbown/CodeWhale (40,889 stars, last pushed today), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 149 tokens. 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.

Related

Other skills, from other repositories

Session Monitoring

Provides awareness of claudectl session state, health checks, and cost tracking. Activated when the user asks about session health, spending, brain decisions, or multi-session coordination.

mercurialsolo/claudectl · 38 tokens

qa-testing

Verify your work by actually operating the app or website you changed, instead of assuming it works. Strongly recommended whenever you build, modify, or debug a web app, website, or desktop GUI app. Drive real browsers with the agent-browser CLI and native desktop apps with the cua-driver CLI. These are installed on…

openinterpreter/openinterpreter · 77 tokens

organize-modules

Apply private modules with public re-exports (barrel export) pattern for clean API design. Includes conditional visibility for docs and tests. Use when creating modules, organizing mod.rs files, or before creating commits.

r3bl-org/r3bl-open-core · 47 tokens

check-bounds-safety

Apply type-safe bounds checking patterns using VPIndex/VPLength types instead of usize. Use when working with arrays, buffers, cursors, viewports, or any code that handles indices and lengths.

r3bl-org/r3bl-open-core · 46 tokens

check-code-quality

Run comprehensive Rust code quality checks including compilation, linting, documentation, and tests. Use after completing code changes and before creating commits.

r3bl-org/r3bl-open-core · 31 tokens

analyze-performance

Establish performance baselines and detect regressions using flamegraph analysis. Use when optimizing performance-critical code, investigating performance issues, or before creating commits with performance-sensitive changes.

r3bl-org/r3bl-open-core · 38 tokens