document

document is a skill for Claude Code from nirelbaz/promptpit. It costs 36 tokens per session (344 once invoked), scanned A, original, MIT.

A documentation-writing guide for code projects. It helps place explanations in useful locations, such as a README, source comments, public function documentation, or architecture notes.

In plain words
What is it for?
It is for documenting new modules, changed interfaces, complex decisions, installation and usage, public APIs, and system design.
Why use it?
It helps developers understand and use code without relying on scattered or outdated explanations, while avoiding comments that merely repeat what the code already says.

Skill for Claude Code

Written for Claude Code: user-invocable in frontmatter.

Good fit It is for documenting new modules, changed interfaces, complex decisions, installation and usage, public APIs, and system design.

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

Made for: Claude Code.

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 document

README.md
[![agentmods](https://agentmods.dev/badge/skills/nirelbaz/promptpit/document/github.svg)](https://agentmods.dev/skills/nirelbaz/promptpit/document)
Your own site
<a href="https://agentmods.dev/skills/nirelbaz/promptpit/document"><img src="https://agentmods.dev/badge/skills/nirelbaz/promptpit/document/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 document

Your own site · 80×15
<a href="https://agentmods.dev/skills/nirelbaz/promptpit/document"><img src="https://agentmods.dev/badge/skills/nirelbaz/promptpit/document.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 36 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 344 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.00036 $0.00344
Opus 5.5 $0.00014 $0.00138
Sonnet 5.5 $0.00007 $0.00069
Haiku 4.5 $0.00004 $0.00034

Measured 1mo ago against content hash 95bd1dd92e76, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 1mo 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.

.promptpit/skills/document/SKILL.md · 32 lines

What it actually says

Document

Write documentation that helps someone understand and use the code.

Process

  1. Identify what needs documenting: new module, changed API, complex logic
  2. Determine the audience: other developers on the team, users of the library, future you
  3. Write the docs where people will find them

Where to document

  • README.md: what this project does, how to install it, how to use it. Written for someone who just found the repo.
  • Inline comments: only for code that would surprise a competent reader. The "why", not the "what."
  • Function/method docs: for public APIs. Parameters, return value, one example.
  • Architecture docs: for non-obvious system design. How components fit together. When things are connected in ways that aren't visible from the code.

Rules

  • Don't comment obvious code. i++ // increment i helps nobody.
  • Do comment non-obvious decisions. "We use setTimeout here instead of requestAnimationFrame because..." is useful.
  • Keep docs close to the code. Docs in a separate wiki get stale. Docs in the same file get maintained.
  • Write for the reader, not the writer. You know why you did it. They don't.
  • Use examples. A code example is worth 100 words of explanation.
  • Update docs when you change the code. Stale docs are worse than no docs.
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. 1mo ago First seen · 32 lines · 36 tokens per session scan A 95bd1dd92e76

Subscribe to this mod's changes

document is a skill published in the GitHub repository nirelbaz/promptpit (6 stars, last pushed 2mo ago), licensed MIT. It adds 36 tokens to every session and 344 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

spreadsheets

Hosted xlsx-for-ai tools for spreadsheet files and links (.xlsx, .xlsm, .xls, .csv, .tsv, a Google Sheet). Use when the answer depends on formula results, totals, errors or whether saved values are current, on differences between versions, or on cleaning, converting or writing back a working workbook. A local…

senoff/xlsx-for-ai · 99 tokens

clinicaltrials-database

Query ClinicalTrials.gov via API v2. Search trials by condition, drug, location, status, or phase. Retrieve trial details by NCT ID, export data, for clinical research and patient matching.

synthetic-sciences/openscience · 47 tokens

openalex-database

Query and analyze scholarly literature using the OpenAlex database. This skill should be used when searching for academic papers, analyzing research trends, finding works by authors or institutions, tracking citations, discovering open access publications, or conducting bibliometric analysis across 240M+ scholarly…

synthetic-sciences/openscience · 76 tokens

glycoengineering

Analyze and engineer protein glycosylation. Scan sequences for N-glycosylation sequons (N-X-S/T), predict O-glycosylation hotspots, and access curated glycoengineering tools (NetOGlyc, GlycoShield, GlycoWorkbench). For glycoprotein engineering, therapeutic antibody optimization, and vaccine design.

synthetic-sciences/openscience · 75 tokens

wikipedia

Search and read Wikipedia via x wkp — MediaWiki API, no API key, zero install; query, extract, suggest, and DDG route in one module. Load for wiki, wikipedia, encyclopedia lookup, article summary.

x-cmd/x-cmd · 49 tokens

session-investigator

Investigate fast-agent session and history files to diagnose issues. Use when a session ended unexpectedly, when debugging tool loops, when correlating sub-agent traces with main sessions, or when analyzing conversation flow and timing. Covers session.json metadata, history JSON format, message structure, tool…

evalstate/fast-agent · 68 tokens