code-documenter

An agent skill by Jeffallan, from Jeffallan/claude-skills. Tags: api, copy-editing, developer-tools, documentation, documents, web.

What it does

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.

Install

With the skills CLI, which installs into Claude Code, Codex, Cursor and other agents:

npx skills add Jeffallan/claude-skills --skill code-documenter

Or copy the skill folder into Claude Code's skills directory by hand (~/.claude/skills for every project, or .claude/skills inside one):

git clone --depth 1 https://github.com/Jeffallan/claude-skills
cp -r claude-skills/skills/code-documenter ~/.claude/skills/code-documenter

Safety box score

Grade C, moderate risk: 30 of 100 risk points, rated 2026-10-18. The grade rates what the skill and its scripts can reach on the machine of whoever installs it, across eight categories from shell execution to secrets access. How the score works.

This skill is a documentation-only helper, but it does ask the agent to run validation commands and install doc tooling from package registries. The main risks are limited code execution during lint/test steps, network access for package downloads and URL checks, and one global npm install that changes the user environment.

Category levels, from 0 (none) to 3 (high)
Category	Level	Why
Code & shell execution	2 (moderate)	The workflow explicitly runs commands such as `python -m doctest file.py`, `pytest --doctest-modules`, `tsc --noEmit`, and `npx @redocly/cli lint openapi.yaml`, so it executes toolchains against the project.
Network access	1 (low)	It relies on networked tooling and examples like `npx create-docusaurus@latest`, `pip install linkchecker`, and CDN-based docs assets, which can fetch packages or contact external URLs.
Filesystem reach	1 (low)	Its purpose is to write documentation, coverage reports, and site config files in the repo (for example `mkdocs.yml`, `.vitepress/config.ts`, `docusaurus.config.js`), but it does not call for destructive or system-wide file changes.
Secrets & credentials	1 (low)	The references include API-key examples and troubleshooting that inspects environment variables like `process.env.API_KEY` and `$API_KEY`, but they do not ask to read credential stores or exfiltrate secrets.
Privilege & persistence	2 (moderate)	`references/documentation-systems.md` recommends `npm install -g broken-link-checker`, which installs software globally in the user environment.
Instruction hijack surface	0 (none)	I found no instructions to ignore higher-priority rules, follow remote content, or hide behavior; the files are straightforward documentation guidance.
Irreversible actions	0 (none)	The skill generates docs and reports only; it does not send messages, deploy, publish, pay, or delete anything.
Transparency	0 (none)	All shipped files are readable Markdown references; there are no binaries, obfuscated blobs, or decoded-at-runtime scripts.

Before installing

Check `references/documentation-systems.md` for the global install command and decide whether you want a local devDependency instead.
Run it in a scratch repo first if you do not want package downloads from npm/pip or external docs URLs.
Keep secrets out of the workspace; the examples use `process.env.API_KEY` and `$API_KEY`.
If you only need inline docs, skip the site-generator references and avoid the heavier validation commands.

Rated 2026-10-18 by an automated review of 9 files from the skill's repository.

Source

Repository: Jeffallan/claude-skills (all skills from this repository)
Path: skills/code-documenter/SKILL.md
Branch: main
Updated: 2026-09-19

source-driven-development — Grounds every implementation decision in official documentation.
google-docs — Author and edit Google Docs with the google-docs tools - structured writing, character and paragraph styling, lists, tables, images, headers/footers.
site-md — Analyze a project description or site requirements and synthesize a project constitution into SITE.md for the Stitch Build Loop
atlassian-mcp — Integrates with Atlassian products to manage project tracking and documentation via MCP protocol.
cli-developer — Use when building CLI tools, implementing argument parsing, or adding interactive prompts.
django-storages-s3 — Use when configuring Django to store static and media files on AWS S3 with django-storages.