skills.rest
Selfdb-io
Selfdb-ioCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

code-documentation

Generate docstrings, README files, API docs, and architecture overviews from source code.

Updated Feb 4, 2026
Search Tags:#architecture#documentation#codebase#docstrings#README#API-docs
One-click install
npx skills add https://github.com/Selfdb-io/StreamX --skill code-documentation-selfdb-io
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documentation
Source: https://github.com/Selfdb-io/StreamX/tree/main/.agentone/skills/code-documentation
Command: npx skills add https://github.com/Selfdb-io/StreamX --skill code-documentation-selfdb-io

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generating and maintaining accurate code documentation is time-consuming and error-prone. This Skill automates comprehensive documentation generation, including docstrings, inline comments, READMEs, API references, and architecture overviews, ensuring consistency and up-to-date docs across projects.

Core Features & Use Cases

  • Inline Documentation: Generate docstrings and comments for functions, classes, and modules in multiple languages.
  • Documentation Packages: Create README files, API references, and architecture overviews from existing codebases.
  • Use Case: When you refactor a module or start a new repository, run this Skill to produce a complete, up-to-date set of docs automatically.

Quick Start

Run the code-documentation skill on a new Python project by providing a sample file tree; the Skill will output structured Markdown documentation including a README.md, API reference, and docstrings for functions.

Frequently Asked Questions about code-documentation

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

FAQPage Schema
How do I generate README files and API docs from an existing codebase?▼

To generate README files and API docs from a codebase, the Skill analyzes source files, extracts signatures and inline comments, and formats the output into structured Markdown or HTML documentation.

Can I automatically add docstrings to functions and classes across different programming languages?▼

Yes, you can automatically add docstrings to functions and classes across multiple languages. The Skill analyzes source files to generate inline documentation and adheres to existing project conventions.

What is the best way to create an architecture overview from source code?▼

Creating an architecture overview from source code involves analyzing the repository structure and extracting module relationships. This Skill automates that process to produce a comprehensive architectural summary.

Does this documentation generator work for refactoring updates and new code?▼

Yes, this documentation generator works for both new code and refactoring updates. It ensures consistency by automatically updating docstrings, API references, and architecture overviews when source files change.

How do I ensure my generated API references match my project conventions?▼

To ensure generated API references match your project conventions, the Skill analyzes existing inline comments and file signatures. It formats the output to adhere strictly to the established project documentation style.

What output formats are supported when generating code documentation?▼

When generating code documentation, the supported output formats are Markdown and HTML. This allows for easy integration into existing documentation packages and API references.

Related Skills

Explore More Software Engineering Skills→
third774third774
5

documenting-code-comments

Establish code comment standards for WHY-focused inline documentation.

Community
Basic
microsoftmicrosoft
2.9k

wiki-vitepress

Package wiki Markdown into a VitePress static site with dark theme and Mermaid diagrams.

Official
Advanced
alangebalangeb

documentation

Generate and validate Google-style docstrings for Python source files and manage changelogs.

Community
Intermediate
mscipiomscipio

doc-generator

Generate README, API, and CLI documentation from source code comments.

Community
Advanced