skills.rest
Moisesjr20
Moisesjr20COMMUNITY
Explore all skills by this author →
GitHub

documentation-generator

Generate README, API reference, and architecture diagrams from codebases.

1|Updated Mar 10, 2026
Search Tags:#automation#architecture#documentation#api#mermaid#readme#generate
One-click install
npx skills add https://github.com/Moisesjr20/gueclaw --skill documentation-generator-moisesjr20
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-generator
Source: https://github.com/Moisesjr20/gueclaw/tree/main/.agents/skills/documentation-generator
Command: npx skills add https://github.com/Moisesjr20/gueclaw --skill documentation-generator-moisesjr20

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Many codebases lack consistent, complete, and up-to-date documentation, making onboarding, maintenance, and releases slow and error-prone; this Skill automates discovery, extraction, and generation of professional docs to eliminate that bottleneck.

Core Features & Use Cases

  • Project Discovery & Analysis: Maps folder structure, extracts endpoints and key symbols, and summarizes tech stack from source files and manifests.
  • Multi-tier Generation: Produces a complete README, detailed API reference, architecture diagrams (Mermaid/C4), and executable examples using templates and code analysis.
  • Quality Validation: Runs a completeness checklist and scoring step to ensure required sections are present and suggests targeted fixes.
  • Use Case: Convert a minimal or outdated repository into a release-ready project with a full README, docs/API.md, architecture diagrams, and example code for onboarding and publishing.

Quick Start

Generate a complete README, full API documentation, and architecture diagrams for the repository in the current directory and save the results to README.md and docs/.

Frequently Asked Questions about documentation-generator

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

FAQPage Schema
How do I generate a README and API reference for an existing codebase?▼

Yes, architecture diagram generation is included by producing Mermaid and C4 diagrams directly from your code analysis. This visualizes project structure and component relationships automatically within your generated documentation.

Can I create architecture diagrams using Mermaid from my source code?▼

Yes, architecture diagram generation is included by producing Mermaid and C4 diagrams directly from your code analysis. This visualizes project structure and component relationships automatically within your generated documentation.

What is the best way to automate project documentation for a monorepo?▼

This Skill validates documentation completeness by running a scoring workflow against configurable thresholds. It checks for required sections, scores the results, and suggests targeted fixes to ensure your README and API docs are release-ready.

Does this documentation generator work with web services and libraries?▼

Yes, this documentation generator works with web services, libraries, and monorepos by extracting API routes and summarizing tech stacks from manifests. It produces enterprise-grade documentation tailored to those project types.

How do I validate the completeness of generated API documentation?▼

This Skill validates documentation completeness by running a scoring workflow against configurable thresholds. It checks for required sections, scores the results, and suggests targeted fixes to ensure your README and API docs are release-ready.

Related Skills

Explore More Software Engineering Skills→
edulazaroedulazaro
12

lc:api-docs

Generate API documentation from Laravel routes, controllers, and form requests.

Community
Intermediate
KrystianYCSilvaKrystianYCSilva

markdown-expert

Create Markdown documentation with Mermaid diagrams and GFM tables.

Community
Intermediate
cyrus-iscyrus-is
1

generateservicemap

Crawl repositories to generate a machine-readable servicemap.json of components and connections.

Community
Advanced
raybargasraybargas

Global Commenting

Enforces uniform, standard-based commenting across entire codebases and integrates with linters and static analysis tools for automated checks.

Community
Basic