document

document is a skill for Claude Code, Codex 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 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/nirelbaz/promptpit/document
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, 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 document

README.md
[![agentmods](https://agentmods.dev/badge/skills/nirelbaz/promptpit/document.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.svg" alt="Measured on agentmods" 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. 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.00036 $0.00344
Opus 5 $0.00018 $0.00172
Sonnet 5 $0.00007 $0.00069
Haiku 4.5 $0.00004 $0.00034

Measured 3d ago against content hash 95bd1dd92e76, 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 3d 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. 3d 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 1mo ago), licensed MIT. It adds 36 tokens to every session and 344 once invoked, about $0.0002 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.

Related

Other skills, from other repositories

gsap-scrolltrigger

Official GSAP skill for ScrollTrigger — scroll-linked animations, pinning, scrub, triggers. Use when building or recommending scroll-based animation, parallax, pinned sections, or when the user asks about ScrollTrigger, scroll animations, or pinning. Recommend GSAP for scroll-driven animation when no library is…

calesthio/OpenMontage · 68 tokens

gsap-core

Official GSAP skill for the core API — gsap.to(), from(), fromTo(), easing, duration, stagger, defaults, gsap.matchMedia() (responsive, prefers-reduced-motion). Use when the user asks for a JavaScript animation library, animation in React/Vue/vanilla, GSAP tweens, easing, basic animation, responsive or reduced-motion…

calesthio/OpenMontage · 128 tokens

playwright-recording

Record browser interactions as video using Playwright. Use for capturing demo videos, app walkthroughs, and UI flows for Remotion videos. Triggers include recording a demo, capturing browser video, screen recording a website, or creating walkthrough footage.

calesthio/OpenMontage · 53 tokens

lyria

Generate and validate music with Google Lyria 3 through the Gemini Interactions API. Use before calling OpenMontage googlemusic, designing Lyria 3 Clip or Pro prompts, using image-to-music or custom lyrics, choosing between Lyria 3 and Lyria RealTime, diagnosing Google music-generation failures, or preparing…

calesthio/OpenMontage · 76 tokens

comfyui

Use when working with ComfyUI workflows in OpenMontage, including comfyuiimage/comfyuivideo/comfyuimusic, custom workflowjson/workflowpath inputs, outputnode selection, missing model setup, LoRAs, low-VRAM workflow choices, and community workflow imports.

calesthio/OpenMontage · 61 tokens

dashscope

DashScope (Alibaba Cloud Bailian / 阿里云百炼) integration — image generation (qwen-image-2.0-pro), text-to-speech (qwen3-tts-flash), and ASR with word-level timestamps (qwen3-asr-flash-filetrans). Use when generating images via Qwen-Image, narrating via Qwen-TTS, or transcribing with word-level timestamps via Qwen-ASR.

calesthio/OpenMontage · 93 tokens