Skip to content
SkillModel-led1,174 tokens in use

Code Documenter

Adds docstrings and JSDoc, writes OpenAPI specs, doc sites and guides, tests every code example, and reports documentation coverage.

12,471 stars on the repository MIT LicenseJeffallan/claude-skills · skills/code-documenter
/plugin marketplace add jeffallan/claude-skills /plugin install fullstack-dev-skills@fullstack-dev-skills
View source

Install command as written in the repository's README

Skill label

measured from its files

What installing Code Documenter costs

82tokens idle
1,174tokens in use
12,477tokens, up to

Idle is what sits in context while the skill is installed. In use is its instructions, loaded when it runs. Up to adds the files its instructions link. Counts are approximate, made offline with cl100k_base.

Model dependence Model-led

Script-ledMixedModel-led

Mostly instructions, so how well it works depends on the model that follows them.

This describes the skill's structure, how much of it is scripts. It does not say how well it works.

Touches

shelldetected

Declared tags come from the skill's frontmatter; detected ones from its scripts, its code blocks and the commands it names in inline code. This is detected, not audited.

How it scores

Quality

How well the skill is written, counted from its own files: its frontmatter, its steps, examples, stated output and constraints, its size and whether every file it ships is one it names.How we score it →
Excellent
  • Frontmatter15/15
  • Structure23/25
  • Examples15/15
  • Output15/15
  • Size15/15
  • Resources15/15

Security

Starts at 100 and loses points for each thing in the skill's files that a reader should look at first.How we score it →
Excellent

No findings.

Repository health

Pre-computed score based on development activity, maintenance, community, maturity, and trend momentum.How we score it →
Excellent
  • Development activity100
  • Maintenance100
  • Community60
  • Maturity36
  • Momentum40

Code Documenter finds undocumented code, asks which docstring format you want, and applies it consistently. It covers Google, NumPy and Sphinx docstrings for Python, JSDoc for TypeScript, and API documentation for FastAPI, Django, NestJS and Express.

Examples in the documentation are validated: doctest for Python, tsc for TypeScript and the Redocly linter for OpenAPI. The run ends with a coverage summary.

What You Get

  • Documented files with parameter types, return values and raised errors
  • OpenAPI specs and developer portal configuration
  • Doc site setup with content structure and build instructions
  • Getting started guides, tutorials and troubleshooting pages
  • A documentation coverage report

Common Use Cases

  • Adding Google-style docstrings to a Python module
  • Writing JSDoc for a TypeScript library
  • Producing API docs for a FastAPI or NestJS service
  • Building a documentation site with Docusaurus or MkDocs
  • Writing a getting started guide

What Makes It Unique

It treats documentation as something to test. Python examples run under doctest or pytest, TypeScript examples compile with tsc, and OpenAPI specs go through a linter. Eight reference files split the work by language, framework, coverage reports, doc systems, interactive API docs and guides.

Under The Hood

The skill is a SKILL.md with eight reference files and no scripts of its own. During a run the agent edits your source files to add documentation and runs validation commands in your shell: python doctest, pytest, tsc and npx for the Redocly linter, which can download that npm package. It does not fetch web pages or call outside APIs.

Join founders building with open source

Opinionated takes, migration guides, cost-saving tips, and insights from the open source ecosystem.

Subscribe on SubstackJoin 750+ subscribers