documentation-generation

documentation-generation is a skill for Claude Code from kumaran-is/claude-code-onboarding. It costs 55 tokens per session (570 once invoked), scanned A, original, MIT.

A documentation-writing helper that creates or refreshes project documentation, code comments, API descriptions, and README files. It supports common formats such as JSDoc, JavaDoc, Python docstrings, and OpenAPI prose.

In plain words
What is it for?
Use it to write README files, public-API docstrings, OpenAPI descriptions, or automated documentation pipelines. It can adapt its approach after identifying projects built with Java, NestJS, Python, or Flutter.
Why use it?
Documentation is often incomplete or inconsistent with the project's language and tools. This helps apply suitable templates and patterns instead of starting every document from scratch.

Skill for Claude Code

Written for Claude Code: allowed-tools in frontmatter.

Good fit Use it to write README files, public-API docstrings, OpenAPI descriptions, or automated documentation pipelines. It can adapt its approach after identifying projects built with Java, NestJS, Python, or Flutter.

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

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

README.md
[![agentmods](https://agentmods.dev/badge/skills/kumaran-is/claude-code-onboarding/documentation-generation/github.svg)](https://agentmods.dev/skills/kumaran-is/claude-code-onboarding/documentation-generation)
Your own site
<a href="https://agentmods.dev/skills/kumaran-is/claude-code-onboarding/documentation-generation"><img src="https://agentmods.dev/badge/skills/kumaran-is/claude-code-onboarding/documentation-generation/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 documentation-generation

Your own site · 80×15
<a href="https://agentmods.dev/skills/kumaran-is/claude-code-onboarding/documentation-generation"><img src="https://agentmods.dev/badge/skills/kumaran-is/claude-code-onboarding/documentation-generation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 55 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 570 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.00055 $0.00570
Opus 5 $0.00028 $0.00285
Sonnet 5 $0.00011 $0.00114
Haiku 4.5 $0.00006 $0.00057

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

Security

Grade A, and why

documentation-generation 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 6d 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.

.claude/skills/documentation-generation/SKILL.md · 46 lines

What it actually says

Iron Law: NO DOC GENERATION WITHOUT READING THE PROJECT-SPECIFIC TEMPLATES FIRST

Read the appropriate reference before writing any documentation.

Process

  1. Detect stack — Check for pom.xml (Java), package.json (NestJS/Angular), pyproject.toml (Python), pubspec.yaml (Flutter)
  2. Load template — Read the matching section in references/readme-templates.md
  3. Apply docstring pattern — Read references/docstring-patterns.md for the correct format per language
  4. Configure CI/CD — Read references/cicd-doc-pipeline.md when setting up automated doc generation

When to Use

  • Creating or refreshing a project README
  • Writing docstrings for public APIs (with /doc-generate)
  • Setting up a CI/CD pipeline that auto-generates API docs on push
  • Generating OpenAPI specs from code annotations (see openapi-spec-generation skill)
  • Creating architecture diagrams (use mermaid-expert agent)

References

File Content Load When
references/readme-templates.md Stack-specific README templates for Java/Spring, NestJS, Python FastAPI, Flutter Writing README for Java, NestJS, Python, or Flutter project
references/docstring-patterns.md Javadoc, JSDoc, Python Google-style, Dart /// patterns with examples Writing Javadoc, JSDoc, Python docstrings, Dart doc comments
references/cicd-doc-pipeline.md GitHub Actions workflow for auto-doc generation + Redocly + GitHub Pages Setting up automated doc generation, GitHub Pages, Redocly

Error Handling

If project type cannot be auto-detected, ask the user to specify the stack before loading templates. If README exists and appears current, report that and do not overwrite without explicit approval.

Files

What ships with it

3 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. 6d ago First seen · 46 lines · 55 tokens per session scan A 2ee8289b2910

Subscribe to this mod's changes

documentation-generation is a skill published in the GitHub repository kumaran-is/claude-code-onboarding (35 stars, last pushed 2mo ago), licensed MIT. It adds 55 tokens to every session and 570 once invoked, about $0.0003 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-09-03.

Related

Other skills, from other repositories

baoyu-youtube-transcript

A tool for downloading the written captions, subtitles, chapter information, speaker labels, and cover image from a YouTube video using its URL or ID.

JimLiu/baoyu-skills · 107 tokens

orbit-notion

Open Orbit briefing skill — selected by the Orbit pipeline when Notion is the user's only connected connector, or when the user explicitly scopes their daily digest to Notion. Pulls the past 24 hours of document edits, comments, mentions, and database row changes from the user's authenticated Notion connection and…

nexu-io/open-design · 117 tokens

instrument-data-to-allotrope

Convert laboratory instrument output files (PDF, CSV, Excel, TXT) to Allotrope Simple Model (ASM) JSON format or flattened 2D CSV. Use this skill when scientists need to standardize instrument data for LIMS systems, data lakes, or downstream analysis. Supports auto-detection of instrument types. Outputs include full…

anthropics/knowledge-work-plugins · 123 tokens

feishu

Work with Feishu or Lark bots, docs, sheets, bitables, approval flows, and OpenAPI/MCP setup without hardcoding credentials.

Hmbown/CodeWhale · 33 tokens

read

Reads URLs and PDFs by fetching source content, defaulting to concise summaries for plain read requests and clean Markdown when asked to convert, save, quote, cite, or feed downstream work. Use when users ask in any language to read, fetch, check, summarize, quote, cite, convert, or save a URL or PDF. Not for local…

tw93/Waza · 78 tokens

overleaf-sync

A two-way connection between a local paper folder and Overleaf, a web-based LaTeX editor for writing research papers. It lets you move changes between the local files and the shared Overleaf project.

wanshuiyin/Auto-claude-code-research-in-sleep · 97 tokens