How do I install the Generate Docs skill?

Run npx skillmds@latest add buildpad-ai/generate-docs in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Generate Docs safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Generate Docs?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Generate Docs free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Generate Docs?

buildpad-ai (@buildpad-ai) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Generate Docs by buildpad-ai — Agent Skill

Name: Generate Docs
Author: buildpad-ai

Generate Docs

Generate or update documentation for DaaS application code changes including API references, component docs, hook docs, schema files, and changelogs. Use when the user says generate-docs, update docs, document this, or needs documentation.

buildpad-ai Updated Sep 21, 2026

File contents

Generate Documentation

Every code change MUST have corresponding documentation updates.

Documentation by Change Type

What Changed	Documentation Required
API endpoint	`docs/API_REFERENCE.md`, `docs/api/[collection].md`
Component	`docs/COMPONENTS.md`, `docs/components/[name].md`
Hook	`docs/HOOKS.md`
Collection	`docs/COLLECTIONS.md`, `docs/schemas/[name].schema.json`
Feature	`docs/features/[name].md`
Workflow	`docs/WORKFLOWS.md`
Any change	`docs/CHANGELOG.md` (always!)

Process

Read the code that was changed or created
Identify doc type from the table above
Generate docs following the templates below
Update CHANGELOG.md with a dated entry

API Route Documentation Template

## [Method] /api/[endpoint]

**Description:** Brief description

**Authentication:** Required / Public

**Request Body:**
| Field | Type | Required | Description |
|-------|------|----------|-------------|

**Response:**
| Status | Body | Description |
|--------|------|-------------|

**Example:**

Component Documentation Template

## ComponentName

**Import:** `import { ComponentName } from '@/components/ui/component-name'`

**Props:**
| Prop | Type | Default | Description |
|------|------|---------|-------------|

**Usage:**
[Working code example]

Standards

JSDoc comments on all exported functions/types
Usage examples for every public API
Complete prop tables for components
Working code examples that can be copy-pasted

References

Documentation guidelines

---name: generate-docsdescription: Generate or update documentation for DaaS application code changes including API references, component docs, hook docs, schema files, and changelogs. Use when the user says generate-docs, update docs, document this, or needs documentation.---# Generate DocumentationEvery code change MUST have corresponding documentation updates.## Documentation by Change Type| What Changed | Documentation Required || -------------- | -------------------------------------------------------- || API endpoint | `docs/API_REFERENCE.md`, `docs/api/[collection].md` || Component | `docs/COMPONENTS.md`, `docs/components/[name].md` || Hook | `docs/HOOKS.md` || Collection | `docs/COLLECTIONS.md`, `docs/schemas/[name].schema.json` || Feature | `docs/features/[name].md` || Workflow | `docs/WORKFLOWS.md` || **Any change** | `docs/CHANGELOG.md` (always!) |## Process1. **Read the code** that was changed or created2. **Identify doc type** from the table above3. **Generate docs** following the templates below4. **Update CHANGELOG.md** with a dated entry## API Route Documentation Template```markdown## [Method] /api/[endpoint]**Description:** Brief description**Authentication:** Required / Public**Request Body:**| Field | Type | Required | Description ||-------|------|----------|-------------|**Response:**| Status | Body | Description ||--------|------|-------------|**Example:**```## Component Documentation Template```markdown## ComponentName**Import:** `import { ComponentName } from '@/components/ui/component-name'`**Props:**| Prop | Type | Default | Description ||------|------|---------|-------------|**Usage:**[Working code example]```## Standards- JSDoc comments on all exported functions/types- Usage examples for every public API- Complete prop tables for components- Working code examples that can be copy-pasted## References- [Documentation guidelines](references/documentation.instructions.md)

Frequently asked questions