skills.rest
seb1n
seb1nCOMMUNITY
Explore all skills by this author →
GitHub

code-documentation

Generate API references, docstrings, and README files for codebases.

147|32|Updated Feb 11, 2026
Search Tags:#developer tools#documentation#code generation#docstrings#README#API reference
One-click install
npx skills add https://github.com/seb1n/awesome-ai-agent-skills --skill code-documentation-seb1n
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documentation
Source: https://github.com/seb1n/awesome-ai-agent-skills/tree/main/code-and-development/code-documentation
Command: npx skills add https://github.com/seb1n/awesome-ai-agent-skills --skill code-documentation-seb1n

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of clear, comprehensive documentation for codebases, reducing the manual effort and ensuring consistency across projects.

Core Features & Use Cases

  • API Reference Generation: Creates detailed API documentation for functions, classes, and modules.
  • Inline Docstring Creation: Generates docstrings (e.g., JSDoc, Google-style Python) for code elements.
  • README Generation: Produces project-level README files based on code structure and package information.
  • Use Case: Ensure your new Python microservice is fully documented with Google-style docstrings and has a comprehensive README file explaining its purpose, setup, and API endpoints.

Quick Start

Add Google-style docstrings to all public functions in the src/utils/ directory.

Frequently Asked Questions about code-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate API references and inline docstrings automatically?▼

You can generate API references and inline docstrings automatically by analyzing code signatures, behavior, and existing tests. This process produces comprehensive documentation across multiple programming languages, including detailed API documentation for functions, classes, and modules.

How do I add Google-style docstrings to Python functions?▼

To add Google-style docstrings to Python functions, you can target specific directories like `src/utils/` to automatically generate and append documentation. The tool analyzes your code signatures and behavior to produce accurate Google-style Python docstrings for all public code elements.

Can I generate a README file based on my existing codebase structure?▼

Yes, you can generate a README file based on your existing codebase structure and package information. It produces project-level README files that explain your project's purpose, setup instructions, and API endpoints by analyzing the underlying code structure.

Does this automated documentation tool support JSDoc and TypeDoc formats?▼

Yes, this automated documentation tool supports various documentation formats including JSDoc and TypeDoc. It generates inline docstrings and API references tailored to these specific formats across multiple programming languages.

What is the best way to document a new Python microservice comprehensively?▼

The best way to document a new Python microservice comprehensively is to automate the creation of Google-style docstrings for inline code documentation and generate a README file. This ensures your API endpoints, setup process, and project purpose are fully explained and consistent.

Related Skills

Explore More Software Engineering Skills→
UnicornUnicorn

doc-agent

Generate README files, API references, and docstrings from source code.

Official
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
h4vzzh4vzz
33

code-documentation

Generate docstrings, API references, and READMEs for source code.

Community
Advanced
HCMUTE-RTICHCMUTE-RTIC

c4-code

Analyze code directories to generate C4 code-level documentation.

Official
Advanced