三栏文档页: 侧导航 + 正文 + 右 TOC
code-documenter
code-documenter is an open-source docs skill for Claude Code and compatible agents, published by Jeffallan. Its author describes it as: “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 AP…”. The project has 11k stars on GitHub and is available under the MIT license. Add it to your setup with `/plugin marketplace add Jeffallan/claude-skills`.
What code-documenter does
Documentation specialist for inline documentation, API specs, documentation sites, and developer guides.
Installation
Add code-documenter to your agent with:
/plugin marketplace add Jeffallan/claude-skills Always review a skill's source before installing it. This command comes from the skill's public repository; the linked repo is the source of truth for exact setup steps.
What's inside
The SKILL.md for code-documenter is organised into these sections:
- When to Use This Skill
- Core Workflow
- Quick-Reference Examples
- Google-style Docstring (Python)
- NumPy-style Docstring (Python)
- JSDoc (TypeScript)
- Reference Guide
- Constraints
- MUST DO
- MUST NOT DO
- Output Formats
- Knowledge Reference
When to use it
Reach for code-documenter when you want docs help from your agent without writing the same instructions every session. Load the skill and the agent picks it up automatically for relevant tasks.
Strengths
- Clear MIT license — safe to read and adapt
- Ships in Jeffallan/claude-skills, an established project with 11,060 GitHub stars
- Actively maintained (recent commits)
Topics
Frequently asked questions
- What does code-documenter do?
- 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.
- How do I install code-documenter?
- Run /plugin marketplace add Jeffallan/claude-skills in your agent, then reload your skills. Review the source at https://github.com/Jeffallan/claude-skills before installing.
- Is code-documenter free to use?
- Yes. code-documenter is free and open source under the MIT license, so you can read, run, and adapt it within that license's terms.
- Where does code-documenter come from?
- code-documenter ships inside Jeffallan/claude-skills, a repository that contains 41 catalogued skills in total. The repository's 11,060 GitHub stars apply to that whole collection, not to this skill on its own.
Related skills
More Docs →Audit and rewrite prose so it stops reading as machine-generated. Use this skill when asked to remove AI-isms, clean up AI writing, edit a draft for AI tells, audit a README, changelog, release note, PR description, or blog post for machine-sounding prose, or make text sound less like AI. Supports a detect-only mode, a rewrite mode, and an edit-in-place mode, with optional voice and context profiles.
Knowledge and governance closeout: reconcile project docs, rule files (CLAUDE.md/AGENTS.md), authorized agent memory, and workspace residue with what the code and runtime actually do, so the next session or the next person starts from one current answer. Trigger when the user names "neat-freak", "洁癖", or "/neat" — and also on clear knowledge-closeout intent without the name: syncing or tidying project docs/rules/memory after development ("把文档和记忆整理一下", "收尾时把文档同步掉", "docs 和代码对不上了"), stale or conflicting CLAUDE.md/memory, a clean handoff to a teammate or a fresh session, or auditing whether workspace rules are actually followed. Do not trigger for pure coding/refactoring/debugging tasks, tidying data or prose (JSON, 周报, changelog announcements), or a bare "整理" with no project-knowledge context.
Human + AI music production workflow for Suno - skills, templates, and tools
Add local office-document-to-Markdown conversion to NanoClaw agent containers with the pinned Firecrawl AnyDoc CLI. Use when agents need to read attached Word, PowerPoint, Excel, OpenDocument, RTF, EPUB, CSV, or text-based PDF files without uploading them to a hosted parser.