documentation

documentation is a skill for Claude Code from vinnie357/claude-skills. It costs 24 tokens per session (2,396 once invoked), scanned A, original, MIT.

A guide for writing technical documentation such as READMEs, API references, user guides, and code comments.

In plain words
What is it for?
Use it when creating or improving project documentation, while verifying documentation-tool commands before relying on them.
Why use it?
It provides a consistent structure and writing approach so important setup and usage information is easier to find.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin.

Part of the core plugin — 14 skills, 5 commands, 7 agents, 1 hook shipped together

Good fit Use it when creating or improving project documentation, while verifying documentation-tool commands…

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/vinnie357/claude-skills/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 vinnie357/claude-skills --skill documentation
Clone the repo
git clone --depth 1 https://github.com/vinnie357/claude-skills

Made for: Claude Code.

Or install core, the plugin that ships this one along with the rest of its 14 skills, 5 commands, 7 agents, 1 hook.

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/vinnie357/claude-skills/documentation.svg)](https://agentmods.dev/skills/vinnie357/claude-skills/documentation)
Your own site
<a href="https://agentmods.dev/skills/vinnie357/claude-skills/documentation"><img src="https://agentmods.dev/badge/skills/vinnie357/claude-skills/documentation.svg" alt="Measured on agentmods" height="20"></a>
Per session 24 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,396 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.00024 $0.02396
Opus 5 $0.00012 $0.01198
Sonnet 5 $0.00005 $0.00479
Haiku 4.5 $0.00002 $0.00240

Measured 7d ago against content hash 0591f97c76fc, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, 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 7d 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.

plugins/core/skills/documentation/SKILL.md · 358 lines

How it starts

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

Technical Documentation Writing

This skill activates when writing or improving technical documentation, including README files, API documentation, user guides, and inline code documentation.

Anti-fabrication

This skill follows core:anti-fabrication. Most of it is house convention — README structure, ADR templates, changelog format, comment style — not claims that can go stale against an upstream. The one real claim area is the "Documentation Tools" section's generator commands (mix docs for ExDoc, cargo doc for rustdoc, Sphinx, MkDocs, JSDoc, TypeDoc): verify the invocation against the tool's current docs before asserting it, rather than repeating it from memory — these are stable but not immune to CLI changes.

README Files

Essential README Structure

Every README should cover: overview, features, installation, quick start, usage, configuration, API reference, development setup, contributing, license, acknowledgments, and support. A complete worked template with all these sections: references/templates.md.

README Best Practices

  • Start with a clear one-liner: Immediately tell readers what the project does
  • Include badges: Build status, coverage, version, license
  • Show, don't tell: Use code examples liberally
  • Keep it scannable: Use headers, lists, and code blocks
  • Make examples runnable: Readers should be able to copy-paste and run
  • Include visual aids: Screenshots, diagrams, GIFs when appropriate
  • Update regularly: Keep documentation in sync with code
  • Think about newcomers: Write for someone seeing the project for the first time

API Documentation

Document functions with language-native doc comments (Elixir @doc/@spec, JSDoc, Python docstrings, Rust doc comments), document modules/classes with their purpose and public API, and document REST endpoints with method, auth, request/response bodies, and error responses. Worked examples for all three: references/api-documentation.md.

Read the full file on GitHub · 358 lines

Files

What ships with it

2 files 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. 7d ago First seen · 358 lines · 24 tokens per session scan A 0591f97c76fc

Subscribe to this mod's changes

documentation is a skill published in the GitHub repository vinnie357/claude-skills (24 stars, last pushed yesterday), licensed MIT. It adds 24 tokens to every session and 2,396 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.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens

insight-error-page

Write or audit an insight-kind error page for the Next.js dev overlay. Use when creating a new errors/ .mdx page, auditing an existing one, or checking that a page matches the framework fix cards. Covers page structure, title alignment, FixCard cards with Copy prompt button, code snippets, terminology verification…

vercel/next.js · 83 tokens