Description
code-documenter is an agent skill from the jeffallan claude-skills collection that helps a coding agent generate, format and validate technical documentation. It covers inline documentation such as docstrings, JSDoc annotations and OpenAPI or Swagger specifications, as well as API documentation for REST or GraphQL endpoints, documentation sites and developer portals, and getting-started guides, tutorials and user guides. The skill is meant to be used when you need to add docstrings to functions, classes and modules, write an OpenAPI spec or JSDoc annotations, document an API, build a documentation site, or write user-facing guides. Its core workflow is shown as a list of steps for generating documents from the code and checking them. The skill is aimed at maintainers who have code that works but lacks documentation, and at teams that want consistent docs across services. It is listed on skills.sh, where the page shows install counts and GitHub stars for the collection. Its Gen Agent Trust Hub audit is marked as failing, which is listed in the FAQ, while Socket and Snyk pass. Install it with npx skills add https://github.com/jeffallan/claude-skills --skill code-documenter.…
Highlights
- Docstrings and JSDoc annotations
- OpenAPI and Swagger specs
- API documentation for REST and GraphQL
- Documentation sites and portals
- Getting-started guides and tutorials
- Installs from skills.sh
Ratings & Reviews
No ratings yet
Be the first to rate code-documenter.
People also visit
code-documenter FAQ
What does this skill generate?
Docstrings, JSDoc annotations, OpenAPI and Swagger specs, API docs, documentation sites and user guides.
When should I use it?
When you need to add docstrings to code, write an API spec, document endpoints, build a docs site, or write a getting-started guide.
How do I install it?
Run npx skills add https://github.com/jeffallan/claude-skills --skill code-documenter.
What are the security audit results?
skills.sh lists three audits: Gen Agent Trust Hub Fail, Socket Pass and Snyk Pass. A Warn or Fail is worth reading before you install.
How popular is it?
The page shows about 5.4K installs, and the claude-skills repository has 11.9K GitHub stars.
Does it validate what it writes?
The skill is described as generating, formatting and validating documentation.
What are the best code-documenter alternatives?
Popular alternatives to code-documenter include lark-openapi-explorer, context-driven-development and grounded-vault. See all code-documenter alternatives