Skills
.Work. You
Rest

code-documenter

Community

Generate high-quality code documentation.

Software Engineering#documentation#code generation#technical writing#OpenAPI#docstrings#API docs
AuthorCoffelix2023
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill automates the creation of comprehensive documentation for code, APIs, and developer guides, ensuring clarity and maintainability.

Core Features & Use Cases

  • Docstring Generation: Automatically adds docstrings to functions and classes in various languages.
  • API Documentation: Creates OpenAPI/Swagger specs for REST APIs and documents GraphQL/gRPC services.
  • Documentation Sites: Assists in building and structuring documentation sites using tools like Docusaurus or MkDocs.
  • Use Case: You have a new Python microservice with several undocumented functions. Use this Skill to generate Google-style docstrings for all public functions and create an OpenAPI specification for its REST API.

Quick Start

Use the code-documenter skill to add docstrings to the provided Python function.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: code-documenter
Download link: https://github.com/Coffelix2023/c6x-mynotes/archive/main.zip#code-documenter

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.