TypeScript Type Documenter skill for Claude and Codex
Writes reader-facing documentation for chosen TypeScript types: a description, a property table with type, optional flag, default and meaning, and usage…
Install it once and Claude or Codex runs it for you. When your request matches, your AI loads the skill, asks for anything it is missing, and works through the template itself. Prefer to fill it in by hand? See the full prompt template.
Download the skill (.zip) · View SKILL.md
When it is used
Use when TypeScript interfaces, types, or classes need reader-facing documentation with a property table and examples, in Markdown, HTML, or JSON. Do not use for producing a type inventory as data, writing the types themselves, or documenting runtime functions. Related topics: coding, typescript.
What it will ask you for
- Source code (longer free text)
- Source file path (free text, e.g. "src/types/billing.ts")
- Types to document (free text, e.g. "Names separated by spaces or all")
- Include private members (choose one: Yes, No)
- Output format (choose one: Markdown, HTML, JSON)
- Add usage examples (choose one: Yes, No)
- Hide generic parameters (choose one: Yes, No)
How it works
- Write a one or two sentence description per type from its JSDoc, names, and usages; every requested type has one.
- Build the property table with name, type, optional flag, default, and meaning, and list variants and discriminants for unions.
- Show generic parameters with constraints unless hidden, and include private members only when asked, marked private.
- Add one compiling example per type (one per union variant) when examples are requested.
- Render the whole thing in the chosen format in source order, with no commentary outside the document.
What you get
One document in the chosen format: a section per type with description, property table, and optional examples, in source order, and no text outside it.
What it watches out for
- Describing a property by restating its name (userId: the user id), which tells the reader nothing they could not see.
- Leaving the default column empty when a class initializer or JSDoc @default states one.
- Collapsing a discriminated union into one property table, so readers cannot tell which fields belong to which variant.
How to install
Claude.ai and the Claude desktop app
- Download the skill .zip.
- Open Settings, then Capabilities, and find Skills.
- Choose Upload skill and select the .zip.
- Ask Claude for help with the task. It loads the skill when your request matches.
Claude Code
- Download the skill .zip.
- Unzip it into ~/.claude/skills/ (or .claude/skills/ inside a project).
- Start a new session. Claude Code loads the skill when your request matches.
Codex
- Download the skill .zip.
- Unzip it into ~/.agents/skills/ (or .agents/skills/ inside a project).
- Codex picks it up on its own. Type $ and the skill name to use it, or just ask for the task.
Cursor
- Download the Cursor rule (.mdc).
- Save it in .cursor/rules/ inside your project.
- Cursor's agent applies the rule when your request matches its description.
AGENTS.md (Codex, Cursor, and other coding agents)
- Copy the AGENTS.md section.
- Paste it into AGENTS.md at the root of your repository, creating the file if needed.
- Coding agents that read AGENTS.md follow it when your request fits.