documentation-writer

documentation-writer is a skill for Claude Code, Codex from codebygarv/Ai-skills. It costs 42 tokens per session (479 once invoked), scanned A, original, MIT.

A guide for creating structured technical documentation from code, requirements, notes, or existing documentation. It explains how to match the writing to the intended readers and describe actual behavior.

In plain words
What is it for?
Use it to write or update overviews, usage instructions, examples, configuration notes, edge cases, and maintenance documentation.
Why use it?
It helps when a feature or system is difficult to understand, undocumented, or described inaccurately.

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/codebygarv/ai-skills/documentation-writer
Any agent
npx skills add codebygarv/Ai-skills --skill documentation-writer
Clone the repo
git clone --depth 1 https://github.com/codebygarv/Ai-skills

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 documentation-writer

README.md
[![agentmods](https://agentmods.dev/badge/skills/codebygarv/ai-skills/documentation-writer.svg)](https://agentmods.dev/skills/codebygarv/ai-skills/documentation-writer)
Your own site
<a href="https://agentmods.dev/skills/codebygarv/ai-skills/documentation-writer"><img src="https://agentmods.dev/badge/skills/codebygarv/ai-skills/documentation-writer.svg" alt="Measured on agentmods" height="20"></a>
Per session 42 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 479 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.00042 $0.00479
Opus 5 $0.00021 $0.00239
Sonnet 5 $0.00008 $0.00096
Haiku 4.5 $0.00004 $0.00048

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

Security

Grade A, and why

documentation-writer 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 4d 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.

skills/documentation/documentation-writer/SKILL.md · 35 lines

How it starts

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

Purpose

Produce clear, structured technical documentation from a given source — source code, requirements, meeting notes, or a mix — that explains what something is, how it works, and how to use it, for the audience it's meant for.

When to Use

  • A feature, module, API, or system has no documentation, or what exists is stale.
  • Turning requirements or design notes into a reference doc.
  • The user has working code but needs it explained for other engineers, or non-engineers.

What to Analyze / Do

  1. Identify the audience — engineers integrating with this, engineers maintaining it, or non-technical stakeholders — and match depth/jargon accordingly. Ask if unclear and it meaningfully changes the doc.
  2. Establish structure before writing prose — overview, how it works, usage/examples, configuration, edge cases/limitations, is a reasonable default shape; adapt to what the source material actually supports.
  3. Extract behavior from source — if working from code, document what it actually does, not an idealized version of what it's supposed to do; flag any place the code and stated intent seem to diverge.
  4. Include concrete examples — a real usage example beats an abstract description every time.
  5. Note what's deliberately left out — assumptions, out-of-scope behavior, known limitations — so the doc doesn't imply completeness it doesn't have.

Output Format

  • A structured Markdown doc: title, one-paragraph overview, then sections appropriate to the content (How it works / Usage / Configuration / Examples / Limitations).
  • Code examples in fenced blocks with the correct language tag.
  • Headings that let someone scan and jump to the relevant section rather than reading linearly.

Avoid

  • Documenting intended behavior instead of actual behavior when working from code — verify against the code, don't assume the docstring/comment is accurate.
  • Padding with generic boilerplate paragraphs that don't convey real information.
  • Writing at the wrong depth for the stated audience (over-explaining basics to engineers, or under-explaining to non-technical readers).

Read the full file on GitHub · 35 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. 4d ago First seen · 35 lines · 42 tokens per session scan A 2af05ff3f5a3

Subscribe to this mod's changes

documentation-writer is a skill published in the GitHub repository codebygarv/Ai-skills (24 stars, last pushed 14d ago), licensed MIT. It adds 42 tokens to every session and 479 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-30.

Related

Other skills, from other repositories

bun-api

Bun runtime API reference for TypeScript scripts. Covers Bun.file(), Bun.write(), Bun.$() shell, Bun.spawn(), Bun.Glob, Bun.env, bun:sqlite, Bun.sql() for PostgreSQL/MySQL via DATABASEURL, Bun.s3 for S3-compatible storage, Bun.redis for Redis/Valkey, Bun.Archive for tarballs, Bun.Image image processing, Bun.WebView…

dmythro/agent-skills · 229 tokens

bun-cli

Bun CLI reference for package management, script running, testing, bundling, and compilation. Covers bun install/add/remove/update, bun run, bun test, bun build, bunx, bun patch, bun audit fix, bun dedupe, bun prune, bun why, bun pm, bun repl, bunfig.toml, bun.lock, workspace catalogs, isolated installs and the global…

dmythro/agent-skills · 159 tokens

deps-upgrade

Validate JavaScript/TypeScript dependency upgrades after an interactive or manual update. Establish the real delta from git, detect peer/engine/type conflicts, extract breaking changes, migrations and adoptable features from release notes, assess held-back or seemingly unused packages, and run verification gates.…

dmythro/agent-skills · 134 tokens

git-pr

PR and MR workflows for GitHub (gh) and GitLab (glab). Creation, review comment handling, thread resolution, review state queries, merging, cost-aware bot review rounds (GitHub: Copilot, CodeRabbit), and Copilot code review configuration (rulesets, custom instructions, billing). Use when creating PRs/MRs, addressing…

dmythro/agent-skills · 138 tokens

git-project

GitHub Projects (v2) setup and management via gh CLI + GraphQL: organize a repo's issues into epics with native sub-issues, drive a board Status flow (Todo -> In Progress -> Done), set Project Priority, classify with native issue Types (Task/Bug/Feature) instead of labels, scope work with milestones (incl. resolving…

dmythro/agent-skills · 176 tokens

git-ci

CI/CD status queries for GitHub Actions (gh) and GitLab CI (glab). Check pipeline status, failing jobs, workflow runs, job logs, and merge readiness. Use when checking CI status, debugging build failures, viewing job logs, watching pipeline progress, or configuring gh/glab CI read-only allowlists. Not for PR workflows…

dmythro/agent-skills · 88 tokens