generate-docs

generate-docs is a skill for Claude Code, Codex from viknesh20-20/claude-code-tool-kit. It costs 35 tokens per session (753 once invoked), scanned A, original, MIT.

A documentation generator that examines a project's existing style and creates documentation such as README files, API references, inline code notes, or architecture documents.

In plain words
What is it for?
Creating project setup instructions, usage examples, configuration notes, public API references, code documentation, and architecture documentation.
Why use it?
It avoids writing documentation from scratch and helps new documents match the formats already used in the project.

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/viknesh20-20/claude-code-tool-kit/generate-docs
Any agent
npx skills add viknesh20-20/claude-code-tool-kit --skill generate-docs
Clone the repo
git clone --depth 1 https://github.com/viknesh20-20/claude-code-tool-kit

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 generate-docs

README.md
[![agentmods](https://agentmods.dev/badge/skills/viknesh20-20/claude-code-tool-kit/generate-docs.svg)](https://agentmods.dev/skills/viknesh20-20/claude-code-tool-kit/generate-docs)
Your own site
<a href="https://agentmods.dev/skills/viknesh20-20/claude-code-tool-kit/generate-docs"><img src="https://agentmods.dev/badge/skills/viknesh20-20/claude-code-tool-kit/generate-docs.svg" alt="Measured on agentmods" height="20"></a>
Per session 35 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 753 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.00035 $0.00753
Opus 5 $0.00017 $0.00377
Sonnet 5 $0.00007 $0.00151
Haiku 4.5 $0.00003 $0.00075

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

Security

Grade A, and why

generate-docs 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.

.claude/skills/generate-docs/SKILL.md · 77 lines

How it starts

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

Generate Documentation

Detect Documentation Style

!find . -name "README*" -o -name "CONTRIBUTING*" -o -name "CHANGELOG*" -o -name "docs" -type d 2>/dev/null | grep -v node_modules | grep -v .git | head -10 !ls docs/ doc/ documentation/ wiki/ 2>/dev/null

Detect Code Documentation Format

!grep -r "\/\*\*" --include="*.ts" --include="*.js" --include="*.java" -l 2>/dev/null | head -3 !grep -r '"""' --include="*.py" -l 2>/dev/null | head -3 !grep -r "\/\/\/" --include="*.rs" --include="*.cs" --include="*.go" -l 2>/dev/null | head -3


Documentation Types

Type 1: README Generation

If "readme" is specified, generate a complete README.md with:

  • Project name and one-line description
  • Badges (build status, coverage, version — if CI is configured)
  • Table of contents
  • Features list
  • Prerequisites and installation
  • Quick start / usage examples
  • Configuration options
  • API reference (if applicable)
  • Contributing guidelines
  • License

Type 2: API Documentation

If "api" is specified:

  • Find all public endpoints/routes/handlers
  • Document each with: method, path, description, parameters, request body, response body, error codes
  • Generate in the format matching existing docs (OpenAPI, Markdown, or inline)

Type 3: Module/File Documentation

If a file or module is specified:

  • Read the code completely
  • Add inline documentation following the project's convention:
    • JavaScript/TypeScript: JSDoc (/** ... */)
    • Python: Docstrings ("""...""")
    • Go: GoDoc comments (// FunctionName ...)
    • Rust: Doc comments (/// ...)
    • Java: Javadoc (/** ... */)
    • C#: XML comments (/// <summary>)
    • Ruby: YARD (# @param, # @return)

For each public function/method/class, document:

  • Brief description of what it does
  • Parameters with types and descriptions
  • Return value with type and description
  • Exceptions/errors that can be thrown
  • Usage example (for complex APIs)

Type 4: Architecture Documentation

If "architecture" is specified:

  • Map the high-level system components
  • Create ASCII or Mermaid diagrams
  • Document data flow between components
  • List external dependencies and integrations
  • Note key design decisions and trade-offs

Read the full file on GitHub · 77 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. 3d ago First seen · 77 lines · 35 tokens per session scan A 774e3def451e

Subscribe to this mod's changes

generate-docs is a skill published in the GitHub repository viknesh20-20/claude-code-tool-kit (7 stars, last pushed 4mo ago), licensed MIT. It adds 35 tokens to every session and 753 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

interview

Ask one useful structured question at a time only when material product/implementation choices are genuinely missing; remember answers and produce a brief/spec. Discoverable facts should be investigated instead of asked.

Hmbown/CodeWhale · 40 tokens

beevibe-team-mesh-negotiation

Multi-round negotiation protocol — covers both initiator and peer roles. Use when about to call negotiate(), when receiving a intent block as a peer, or when receiving an 'escalated' sentinel from a blocked respondnegotiate. Covers proposal crafting, counter-strategy, deadlock detection, when to accept early…

beevibe-ai/beevibe · 112 tokens

suede-aso

Suede-owned app-store optimization discipline for keyword fields, titles, subtitles, descriptions, screenshots, ratings context, and competitor listing audits. Use when improving App Store or Google Play visibility or listing conversion from a live app URL and current console evidence. NOT FOR: building or releasing…

JasonColapietro/suede-creator-skills · 146 tokens

suede-copy

Suede Labs conversion-copy writer: landing sections, email, microcopy, buttons, headlines, CTAs, variants, and anti-slop edits. Use when asked to write or rewrite conversion copy for one surface in one pass — a hero, a button set, an email subject, a README section, a product blurb — or when copy on a single surface…

JasonColapietro/suede-creator-skills · 140 tokens

copywriting

When the user wants to write, rewrite, or improve marketing copy for any page — including homepage, landing pages, pricing pages, feature pages, about pages, or product pages. Also use when the user says "write copy for," "improve this copy," "rewrite this page," "marketing copy," "headline help," "CTA copy," "value…

stagewise-io/stagewise · 174 tokens

crest

Building engineer self-branding by turning technical contributions into a professional brand. Use for GitHub/LinkedIn/blog/conference positioning or content strategy.

simota/agent-skills · 31 tokens