code-documenter SKILL.md skillA

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

Install it, pinned
mdr add zebbern/claude-code-guide/code-documenter@v1.0.0

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

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
zebbern/claude-code-guide
Path
skills/code-documenter/SKILL.md
Versions recorded
1
Latest version
v1.0.0, committed May 31, 2026
Size
4,116 bytes
Repository stars
4,666
License
MIT

Use when adding docstrings, creating API documentation, or building documentation sites. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, tutorials, user 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.

## Role Definition

You are a senior technical writer with 8+ years of experience documenting software. You specialize in language-specific docstring formats, OpenAPI/Swagger specifications, interactive documentation portals, static site generation, and creating comprehensive guides that developers actually use.

## When to Use This Skill

- Adding docstrings to functions and classes
- Creating OpenAPI/Swagger documentation
- Building documentation sites (Docusaurus, MkDocs, VitePress)
- Documenting APIs with framework-specific patterns
- Creating interactive API portals (Swagger UI, Redoc, Stoplight)
- Writing getting started guides and tutorials
- Documenting multi-protocol APIs (REST, GraphQL, WebSocket, gRPC)
- Generating documentation reports and coverage metrics

## 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. **Report** - Generate coverage summary

## Reference Guide
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add zebbern/claude-code-guide/code-documenter@sha256:9cf10b19e88a127b

The line at the top of this page pins the label v1.0.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 badge

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

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

Versions

The registry has recorded 1 version of this file, committed on May 31, 2026.

versioncommittedcommitsizeaudit
v1.0.0 latest2026-05-31 164971d 4,116 BA 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 (4116 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

zebbern/claude-code-guide · 4,666 stars · license MIT · pushed 2026-10-19 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_eghyffvibw7kb5qm
GET https://markdownregistry.com/api/v1/resolve?ref=zebbern/claude-code-guide/code-documenter
GET https://markdownregistry.com/api/v1/blob/9cf10b19e88a127b71f2eecb789e4f8be474a14ade1a745cf85fbd315dd806e3

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 zebbern/claude-code-guide

academic-paper-reviewer SKILL.md skill
zebbern/claude-code-guide · skills/academic-paper-reviewer/SKILL.md · Simulates academic peer review, evaluating papers across Originality, Methodology, Results, and Writing to provide…
git:20260531.164971d · audit A · 4,666 stars
active-directory-attacks SKILL.md skill
zebbern/claude-code-guide · skills/active-directory-attacks/SKILL.md · This skill should be used when the user asks to "attack Active Directory", "exploit AD", "Kerberoasting", "DCSync"…
v1.1 · audit A · 4,666 stars
api-fuzzing-bug-bounty SKILL.md skill
zebbern/claude-code-guide · skills/api-fuzzing-bug-bounty/SKILL.md · This skill should be used when the user asks to "test API security", "fuzz APIs", "find IDOR vulnerabilities", "test…
v1.1 · audit C · 4,666 stars
api-shape-explorer SKILL.md skill
zebbern/claude-code-guide · skills/api-shape-explorer/SKILL.md · Generate multiple radically different interface designs for a module using parallel sub-agents. Use when user wants to…
git:20260531.164971d · audit A · 4,666 stars
audit-flow SKILL.md skill
zebbern/claude-code-guide · skills/audit-flow/SKILL.md · Interactive system flow tracing across CODE, API, AUTH, DATA, NETWORK layers with SQLite persistence and Mermaid…
v1.0.0 · audit A · 4,666 stars
authentication-patterns SKILL.md skill
zebbern/claude-code-guide · skills/authentication-patterns/SKILL.md · Authentication patterns: session vs JWT vs OAuth comparison, provider selection (NextAuth, Clerk, Supabase Auth)…
git:20260531.164971d · audit A · 4,666 stars
aws-penetration-testing SKILL.md skill
zebbern/claude-code-guide · skills/aws-penetration-testing/SKILL.md · This skill should be used when the user asks to "pentest AWS", "test AWS security", "enumerate IAM", "exploit cloud…
v1.1 · audit B · 4,666 stars
broken-authentication SKILL.md skill
zebbern/claude-code-guide · skills/broken-authentication/SKILL.md · This skill should be used when the user asks to "test for broken authentication vulnerabilities", "assess session…
v1.1 · audit A · 4,666 stars
burp-suite-testing SKILL.md skill
zebbern/claude-code-guide · skills/burp-suite-testing/SKILL.md · This skill should be used when the user asks to "intercept HTTP traffic", "modify web requests", "use Burp Suite for…
v1.1 · audit B · 4,666 stars
caching SKILL.md skill
zebbern/claude-code-guide · skills/caching/SKILL.md · Caching strategies — invalidation, TTL guidelines, cache keys, cache layers, and when not to cache. Use when…
git:20260531.164971d · audit A · 4,666 stars
chart-image SKILL.md skill
zebbern/claude-code-guide · skills/chart-image/SKILL.md · Generate publication-quality PNG chart images from data, supporting line, bar, area, candlestick, pie, and heatmap…
v2.5.1 · audit A · 4,666 stars
cloud-penetration-testing SKILL.md skill
zebbern/claude-code-guide · skills/cloud-penetration-testing/SKILL.md · This skill should be used when the user asks to "perform cloud penetration testing", "assess Azure or AWS or GCP…
v1.1 · audit C · 4,666 stars

Every file in zebbern/claude-code-guide

Other files named code-documenter

code-documenter SKILL.md skill
jeffallan/claude-skills · skills/code-documenter/SKILL.md · Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc…
v1.1.0 · audit A · 12,006 stars
code-documenter SKILL.md skill
sandbaseai/sandbase-skills · marketing/code-documenter/SKILL.md · Plan, implement, or review code documenter work in an existing codebase with compatibility, security, and verification…
git:20260908.a887321 · audit A · 202 stars
code-documenter SKILL.md skill
jahidulislamseo/antigravity-ai-skills · skills/code-documenter/SKILL.md · Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc…
v1.1.0 · audit A · 4 stars
code-documenter SKILL.md skill
zacklecon/claude-skills · skills/code-documenter/SKILL.md · Use when adding docstrings, creating API documentation, or building documentation sites. Invoke for OpenAPI/Swagger…
v1.0.0 · audit A · 3 stars

Browse by kind, by grade A, or by owner.