documentation-generator

documentation-generator is a skill for Claude Code, Codex from mehdiozdemir/awesome-agent-skills. It costs 53 tokens per session (5,740 once invoked), scanned A, original, MIT.

A guide for writing documentation for code, APIs, projects, and systems. It covers README files, API references, code comments, architecture descriptions, and onboarding guides.

In plain words
What is it for?
It helps create installation and usage instructions, describe API endpoints, document functions and classes, explain system design, and prepare new-team-member guides.
Why use it?
It turns technical details into written instructions and references that help people understand, use, and maintain a project.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit It helps create installation and usage instructions, describe API endpoints, document functions and classes, explain system design, and prepare new-team-member guides.

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

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/mehdiozdemir/awesome-agent-skills/documentation-generator"><img src="https://agentmods.dev/badge/skills/mehdiozdemir/awesome-agent-skills/documentation-generator.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 53 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 5,740 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. 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.00053 $0.05740
Opus 5 $0.00026 $0.02870
Sonnet 5 $0.00011 $0.01148
Haiku 4.5 $0.00005 $0.00574

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

Security

Grade A, and why

documentation-generator scanned grade A with 1 finding 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 11d 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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

curl -X POST https://api.example.com/api/v1/users \
skills/documentation-generator/SKILL.md · 925 lines

How it starts

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

Documentation Generator Skill

This skill creates clear, comprehensive, and maintainable documentation for any codebase, API, or system. Use this whenever you need to document code, create README files, generate API references, write technical guides, or improve code comments.

Documentation Types

1. README Documentation

Project entry point documentation including:

  • Project overview and purpose
  • Installation instructions
  • Quick start guide
  • Configuration options
  • Usage examples
  • Contributing guidelines
  • License information

2. API Documentation

Interface documentation including:

  • Endpoint descriptions
  • Request/response schemas
  • Authentication details
  • Error codes and handling
  • Rate limiting information
  • SDK/client examples

3. Code Documentation

Inline and block documentation:

  • Function/method docstrings
  • Class and module descriptions
  • Type annotations
  • Parameter descriptions
  • Return value documentation
  • Example usage

4. Architecture Documentation

System design documentation:

  • High-level architecture overview
  • Component relationships
  • Data flow diagrams
  • Technology stack
  • Design decisions (ADRs)
  • Deployment architecture

5. User Guides

End-user focused documentation:

  • Getting started tutorials
  • Feature walkthroughs
  • Troubleshooting guides
  • FAQ sections
  • Best practices

Documentation Process

Step 1: Analyze the Subject

  1. Understand the code/system being documented
  2. Identify the target audience (developers, users, operators)
  3. Determine documentation scope and depth
  4. Review existing documentation (if any)
  5. Note dependencies and prerequisites

Step 2: Structure the Documentation

  1. Choose appropriate format and template
  2. Organize content hierarchically
  3. Plan sections and subsections
  4. Identify code examples needed
  5. Determine visual aids required

Step 3: Generate Content

  1. Write clear, concise prose
  2. Include relevant code examples
  3. Add diagrams where helpful
  4. Cross-reference related sections
  5. Maintain consistent terminology

Read the full file on GitHub · 925 lines

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. 11d ago First seen · 925 lines · 53 tokens per session scan A 96cc96629f91

Subscribe to this mod's changes

documentation-generator is a skill published in the GitHub repository mehdiozdemir/awesome-agent-skills (2 stars, last pushed 7mo ago), licensed MIT. It adds 53 tokens to every session and 5,740 once invoked, about $0.0003 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). 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

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

local-ai-agents

Build local-first AI agents that run entirely on a developer workstation with Microsoft Foundry Local and Qwen function-calling models. Covers Small Language Models (SLMs), the OpenAI-compatible local endpoint, sandboxed local tools, local RAG with Chroma, local MCP servers, hybrid cloud/local routing, and the…

microsoft/ai-agents-for-beginners · 200 tokens

next-cache-components-adoption

Turn on Cache Components in a Next.js app and resolve the blocking routes it surfaces. Use when the user wants to enable, adopt, or migrate to Cache Components, flip the cacheComponents flag, work through a flood of blocking-prerender / instant validation errors, run the cache-components-instant-false codemod, or…

vercel/next.js · 95 tokens

insight-error-page

Write or audit an insight-kind error page for the Next.js dev overlay. Use when creating a new errors/ .mdx page, auditing an existing one, or checking that a page matches the framework fix cards. Covers page structure, title alignment, FixCard cards with Copy prompt button, code snippets, terminology verification…

vercel/next.js · 83 tokens

next-cache-components-optimizer

Drive a Next.js route to instant navigation by setting up an agentic loop, under Cache Components / PPR, on initial load (hard navigation) and client-side navigation (soft navigation). Encode the goal as a failing @next/playwright instant() e2e and work it to green, one verified route at a time; the shipped test then…

vercel/next.js · 170 tokens

next-partial-prefetching-adoption

Turn on Partial Prefetching in a Next.js app and work through the insights it surfaces. Use when the user wants to enable or adopt Partial Prefetching, flip the partialPrefetching flag, opt routes in with export const prefetch = 'partial', audit Link prefetch={true} behavior, preserve existing prefetched UI with…

vercel/next.js · 103 tokens