A documentation command that reads code and creates or updates usage documentation, API references, examples, and code comments.

Use it for a package, module, function, or class when you need a README or inline documentation covering behavior, errors, examples, and design reasons.

It makes unfamiliar modules and functions easier to understand and use correctly.

doc — Command for Claude Code by boparaiamrit

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.

Clone the repo

git clone --depth 1 https://github.com/boparaiamrit/skills-by-amrit

Made for: Claude Code.

Or install skills-by-amrit, the plugin that ships this one along with the rest of its 33 skills, 34 commands, 9 agents.

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.

README.md

[![agentmods](https://agentmods.dev/badge/commands/boparaiamrit/skills-by-amrit/doc/github.svg)](https://agentmods.dev/commands/boparaiamrit/skills-by-amrit/doc)

Your own site

<a href="https://agentmods.dev/commands/boparaiamrit/skills-by-amrit/doc"><img src="https://agentmods.dev/badge/commands/boparaiamrit/skills-by-amrit/doc/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.

Your own site · 80×15

<a href="https://agentmods.dev/commands/boparaiamrit/skills-by-amrit/doc"><img src="https://agentmods.dev/badge/commands/boparaiamrit/skills-by-amrit/doc.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 11 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.

When invoked 351 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.

Model	Per session	Once invoked
Fable 5.1	$0.00011	$0.00351
Opus 5	$0.00005	$0.00176
Sonnet 5	$0.00002	$0.00070
Haiku 4.5	$0.00001	$0.00035

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

Security

Grade A, and why

doc 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 10d 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.

commands/doc.md · 63 lines

What it actually says

/doc — Documentation Generation

Generate comprehensive documentation for code.

Instructions

Analyze the target from $ARGUMENTS:
- Read the file or module thoroughly
- Understand the public API, types, and contracts
- Identify usage patterns from callers
Generate documentation:

For a module/package → Create or update README.md:
```
# Module Name

Brief description of what this module does and why it exists.

## Usage
```code
import { thing } from './module';
const result = thing.doSomething(input);
```
API Reference

functionName(param: Type): ReturnType

Description. Throws ErrorType when...

Examples

[Real-world usage examples]

Architecture Notes

[How this fits into the larger system]
```
**For a function/class** → Add JSDoc/docstring:
```
/**
- Brief description.
- @param name - Description
- @returns Description
- @throws ErrorType - When condition
- @example
- const result = myFunction('input'); */
Quality rules:
- Document the WHY, not just the WHAT
- Include at least one usage example
- Document error conditions and edge cases
- Keep descriptions concise — no filler words
- Match the existing documentation style in the project

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.

10d ago First seen · 63 lines · 11 tokens per session scan A 88987bd3e523

Subscribe to this mod's changes

doc is a command published in the GitHub repository boparaiamrit/skills-by-amrit (5 stars, last pushed 5mo ago), licensed MIT. It adds 11 tokens to every session and 351 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-31.

Writing and docs

doc

Getting it into your agent

Wrote this? Show the measurements

What it costs to keep this loaded

Grade A, and why

Nothing flagged

What it actually says

/doc — Documentation Generation

Instructions

API Reference

`functionName(param: Type): ReturnType`

Examples

Architecture Notes

What this file has done since we first saw it

Other commands, from other repositories

checklist

clarify

specify

analyze

converge

implement