skills.rest
fernando-fernandez3
fernando-fernandez3COMMUNITY
Explore all skills by this author →
GitHub

docs

Generate Markdown or reStructuredText documentation from codebases.

Updated Aug 23, 2026
Search Tags:#architecture#documentation#markdown#API#docstrings#code#READMEs
One-click install
npx skills add https://github.com/fernando-fernandez3/claude-code-resources --skill docs-fernando-fernandez3
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/fernando-fernandez3/claude-code-resources/tree/main/my-config/skills/docs
Command: npx skills add https://github.com/fernando-fernandez3/claude-code-resources --skill docs-fernando-fernandez3

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation of clear, audience-appropriate documentation from codebases, reducing manual documentation effort and keeping docs in sync with the code.

Core Features & Use Cases

  • API Reference: Generate up-to-date API docs from endpoints and docstrings.
  • Architecture Docs: Produce architecture summaries and diagrams (Mermaid/Diagrams) from project structure.
  • README Generation: Create or update READMEs with usage, installation, and examples.

Quick Start

Use the docs skill to generate a complete API reference for your project by running /docs api

Frequently Asked Questions about docs

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

FAQPage Schema
How do I generate API documentation from docstrings and code?▼

To generate API documentation from docstrings, the Skill analyzes your endpoints, inline comments, and project structure to produce accurate, audience-targeted Markdown or reStructuredText outputs.

What is the best way to create architecture diagrams from project structure?▼

The best way to create architecture diagrams from project structure is by analyzing the codebase to produce architecture summaries and diagrams formatted in Mermaid or Diagrams syntax.

Can I generate a README with installation and usage examples from my codebase?▼

Yes, you can generate or update READMEs from your codebase by analyzing the project structure and code to automatically produce installation instructions, usage guides, and examples.

Does this documentation generator work across different programming languages and frameworks?▼

Yes, this documentation generator works across multiple languages and frameworks by analyzing docstrings, inline comments, and project structure to produce Markdown or reStructuredText outputs.

How do I keep my code documentation in sync with my codebase?▼

To keep code documentation in sync with your codebase, you can automate the creation of audience-appropriate docs directly from source files, reducing manual effort and preventing outdated references.

Related Skills

Explore More Software Engineering Skills→
jeremydhoover-blipjeremydhoover-blip
7

writing-code-comments-and-docstrings

Generate inline code comments and docstrings for various programming languages.

Community
Intermediate
OnlyaguestOnlyaguest
18

data-showcase-site

Convert CSV, JSON, Markdown, or HTML data into a static report site.

Community
Intermediate
JNZaderJNZader

mermaid-validate

Validate Mermaid diagram syntax in Markdown files and directories.

Community
Intermediate
LittleSongxxLittleSongxx
2

code-documentation

Generate READMEs, API references, and architecture documents for codebases.

Community
Advanced