Home / jeffallan / claude-skills · GitHub

code-documenter SKILL.md skillA

code-documenter from jeffallan/claude-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned

mdr add jeffallan/claude-skills/code-documenter@v1.1.0

Pins v1.1.0 in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: jeffallan/claude-skills
Path: skills/code-documenter/SKILL.md
Versions recorded: 5
Latest version: v1.1.0, committed Oct 3, 2026
First version recorded: Mar 6, 2026
Size: 5,808 bytes
Repository stars: 12,006
License: MIT

Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Code Documenter

Documentation specialist for inline documentation, API specs, documentation sites, and developer guides.

## When to Use This Skill

- Adding docstrings to functions, classes, and modules
- Writing OpenAPI/Swagger specs or JSDoc annotations
- Creating API documentation for REST or GraphQL endpoints
- Building documentation sites or developer portals
- Writing getting-started guides, tutorials, and user guides

## Core Workflow

1. **Discover** - Ask for format preference and exclusions
2. **Detect** - Identify language and framework
3. **Analyze** - Find undocumented code
4. **Document** - Apply consistent format
5. **Validate** - Test all code examples compile/run:
   - Python: `python -m doctest file.py` for doctest blocks; `pytest --doctest-modules` for module-wide checks
   - TypeScript/JavaScript: `tsc --noEmit` to confirm typed examples compile
   - OpenAPI: validate spec with `npx @redocly/cli lint openapi.yaml`
   - If validation fails: fix examples and re-validate before proceeding to the Report step
6. **Report** - Generate coverage summary

## Quick-Reference Examples

### Google-style Docstring (Python)
```python
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add jeffallan/claude-skills/code-documenter@sha256:c317493f9b94df59

The line at the top of this page pins the label v1.1.0, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

[![mdr](https://markdownregistry.com/badge/art_lysy6bv3o3amorbx.svg)](https://markdownregistry.com/a/art_lysy6bv3o3amorbx)

3 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 5 versions of this file, between Mar 6, 2026 and Oct 3, 2026, about one every 53 days.

version	committed	commit	size	audit
v1.1.0 latest	2026-10-03	eae31de	5,808 B	A	view · diff
v1.1.0	2026-10-03	958e60f	5,672 B	A	view · diff
v1.1.0	2026-10-03	ec755b7	5,590 B	A	view · diff
v1.1.0	2026-04-29	efebc44	5,496 B	A	view · diff
v1.1.0	2026-03-06	c7afefb	5,404 B	A	view

Audit of the latest version

A 17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.

pass: Frontmatter block present
pass: Frontmatter declares a name
pass: Frontmatter declares a description
pass: Size between 200 bytes and 200 KB (5808 bytes)
pass: No zero-width or bidi control characters
pass: No instruction hidden inside an HTML comment
pass: No link to an exfiltration or paste host
pass: No credential-shaped string
pass: No instruction to send local credentials anywhere
pass: No text hidden with inline styles
pass: No prompt-injection phrasing
pass: No curl or wget piped into a shell
pass: No recursive delete of root, home or parent
pass: No instruction to read or print local credentials
pass: No base64 blob over 200 characters
pass: No link to a raw IP address
pass: No script tag

Source

GitHub

jeffallan/claude-skills · 12,006 stars · license MIT · pushed 2026-10-21 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_lysy6bv3o3amorbx
GET https://markdownregistry.com/api/v1/resolve?ref=jeffallan/claude-skills/code-documenter
GET https://markdownregistry.com/api/v1/blob/c317493f9b94df59ccb48a6783492bcb48e7f1c3d5299ed44718bd568eb8cdb0

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from jeffallan/claude-skills

CLAUDE.md CLAUDE.md file

jeffallan/claude-skills · CLAUDE.md

git:20261003.eae31de · audit A · 12,006 stars

angular-architect SKILL.md skill

jeffallan/claude-skills · skills/angular-architect/SKILL.md · Generates Angular 17+ standalone components, configures advanced routing with lazy loading and guards, implements NgRx…