How do I ensure the generated documentation is accurate?

The skill includes a validation step that runs tools like doctest or tsc to verify that code examples in the documentation actually work as written.

How does it handle API documentation?

It analyzes your route handlers and controllers to draft OpenAPI/Swagger specifications, including request/response schemas and security requirements.

Can it help me build a full documentation website?

Yes, it can configure structure and content for popular static site generators including Docusaurus, MkDocs, and VitePress.

Which programming languages are supported?

Code Documenter is optimized for Python (Google, NumPy, Sphinx styles) and TypeScript/JavaScript (JSDoc), but can detect and adapt to conventions in many other languages.

Code Documenter

Name: Code Documenter
Author: newkayak12

bynewkayak12

0•

学习与文档

Generates comprehensive docstrings, API specifications, and documentation sites to improve codebase maintainability and onboarding.

The Code Documenter skill transforms undocumented or legacy code into professional, well-structured documentation by identifying public classes and functions across various languages. It intelligently detects existing coding conventions to generate Google-style docstrings or JSDoc, builds OpenAPI/Swagger specifications for APIs, and can scaffold entire documentation sites using tools like Docusaurus or MkDocs. By enforcing a documentation coverage gate and validating code examples against the actual implementation, it ensures your project remains accessible to new developers and compliant with industry standards.

主要功能

01Documentation site scaffolding for Docusaurus, MkDocs, and VitePress

02Automated docstring and JSDoc generation for functions and classes

03Automated documentation coverage reporting with a 70% quality gate

04OpenAPI/Swagger specification drafting from existing route handlers

05Validation of code examples to ensure documentation remains executable

060 GitHub stars

使用场景

01Standardizing documentation styles across a polyglot microservices project

02Onboarding new engineers to a large, undocumented legacy codebase

03Generating interactive API documentation for frontend and third-party consumers

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add newkayak12/claude-skills code-documenter

For use in Claude.ai and ChatGPT

主要功能

01Documentation site scaffolding for Docusaurus, MkDocs, and VitePress

02Automated docstring and JSDoc generation for functions and classes

03Automated documentation coverage reporting with a 70% quality gate

04OpenAPI/Swagger specification drafting from existing route handlers

05Validation of code examples to ensure documentation remains executable

060 GitHub stars

使用场景

01Standardizing documentation styles across a polyglot microservices project

02Onboarding new engineers to a large, undocumented legacy codebase

03Generating interactive API documentation for frontend and third-party consumers

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add newkayak12/claude-skills code-documenter

For use in Claude.ai and ChatGPT