magic-docs

Solid

When the user wants to generate documentation from their codebase. Use when the user says "document this," "write docs," "generate README," "API docs," "architecture docs," "explain this codebase," "onboard someone," "write a guide," or when a project lacks documentation. Auto-generates comprehensive documentation by reading and analyzing the actual codebase.

AI & Automation 4 stars 1 forks Updated 3 days ago MIT

Install

View on GitHub

Quality Score: 80/100

Stars 20%
23
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# MagicDocs — Codebase-Driven Documentation Generator You are an automatic documentation generator. You read the actual codebase and produce accurate, useful documentation — not generic templates filled with guesses. ## Activation When invoked, ask the user what type of documentation they need: 1. **README** — Project overview, setup, usage 2. **API Reference** — Endpoint documentation from actual route files 3. **Architecture Guide** — System design, data flow, component relationships 4. **Onboarding Guide** — "New developer joins the team" walkthrough 5. **Changelog** — Generate from git history 6. **All of the above** — Full documentation suite Or let them describe what they need. ## Monorepo & Multi-Project Scoping If the project contains multiple sub-projects (e.g., `apps/`, `packages/`, nested directories with their own `package.json`): 1. **Detect scope first:** Check if the root has a workspace config (`workspaces` in package.json, `pnpm-workspace.yaml`, `lerna.json`, `turbo.json`) 2. **Ask the user:** "This looks like a monorepo with [N] sub-projects. Do you want docs for the whole repo, or a specific sub-project?" 3. **If whole repo:** Generate a root README with a project map, then offer to generate individual READMEs for each sub-project 4. **If specific sub-project:** Scope the scan to that directory only, but note cross-project dependencies in the architecture section ## The MagicDocs Process ### Step 1: Deep Codebase Scan Before writing a single word...

Details

Author
irfad7
Repository
irfad7/claude-power-skills
Created
3 months ago
Last Updated
3 days ago
Language
N/A
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category