dev-docs

Generate structured markdown documentation from scanned repository files.

1|Updated Apr 7, 2026
One-click install
npx skills add https://github.com/learnzdevelopmenthub/paadhai --skill dev-docs-learnzdevelopmenthub
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dev-docs
Source: https://github.com/learnzdevelopmenthub/paadhai/tree/main/.claude/skills/dev-docs
Command: npx skills add https://github.com/learnzdevelopmenthub/paadhai --skill dev-docs-learnzdevelopmenthub

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes uncertainty when creating API references, user guides, or architecture overviews by scanning the live codebase and producing consistent documentation.

Core Features & Use Cases

  • Scope-driven documentation: Select api, user, architecture, or all to tailor the scan to the desired output.
  • Guided context gathering: Reads controllers, middleware, configs, README, and architectural layouts relevant to the selected scope.
  • Automated output & commit: Presents drafts, writes approved content to docs/api.md, docs/guide.md, or docs/architecture.md, and commits the results to keep the repository history clean.

Quick Start

Tell the skill to generate the requested documentation scope and confirm writing the results to the matching docs/ file.

Frequently Asked Questions about dev-docs

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

FAQPage Schema
How do I generate API reference documentation from my existing codebase?

Generate API reference documentation by scanning your existing repository's controllers, middleware, and configs. The skill produces structured markdown outputs and writes approved drafts directly to docs/api.md, then commits the results to git.

What is the best way to create an architecture overview from repository files?

Creating an architecture overview is best handled by scanning architecture files and configs to produce a structured markdown summary. The skill drafts the overview, writes it to docs/architecture.md, and commits the file to keep your repository history clean.

Can I automatically generate user guides and commit them to git?

Yes, you can automatically generate user guides and commit them to git. The skill reads README files and relevant repository components, drafts the user guide, writes it to docs/guide.md, and commits the approved content directly.

Does this documentation tool work without external dependencies?

This documentation tool works without external dependencies, requiring only your existing repository files. It scans controllers, configs, and architectural layouts directly from your codebase to produce the needed markdown documentation.

How do I scope documentation generation to only API references or user workflows?

Scope documentation generation by selecting api, user, architecture, or all to tailor the scan. The skill then gathers context relevant to your selected scope and produces the matching markdown output file.

When should I not use automated codebase documentation generation?

You should not use automated codebase documentation generation when your repository lacks the necessary controllers, configs, or architectural files for the selected scope. The tool depends on scanning these existing files to produce accurate markdown outputs.