Doc Generate

Technical documentation generation. Trigger when the user wants to create a README, API docs, or guides.

christopherlouet 41f341b 2 files · 3.6 KB Updated

File contents

Documentation Generation

README Structure

# Project Name

> Short description

[![CI](badge)](link) [![Coverage](badge)](link)

## Features

- Feature 1
- Feature 2

## Quick Start

\`\`\`bash
npm install
npm run dev
\`\`\`

## Documentation

- [Getting Started](docs/getting-started.md)
- [API Reference](docs/api.md)

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## License

MIT

API Documentation

## POST /api/users

Create a new user.

**Request:**

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| email | string | Yes | User email |
| name | string | Yes | User name |

**Response:**

\`\`\`json
{
  "id": "uuid",
  "email": "user@example.com",
  "name": "John"
}
\`\`\`

**Errors:**

| Status | Description |
|--------|-------------|
| 400 | Validation error |
| 409 | Email already exists |

Principles

  • Working code examples
  • Tables for parameters
  • Request/response schemas
  • List of possible errors
  • Internal links for navigation

christopherlouet/claude-base/tree/main/.claude/skills/doc-generate commit 41f341b607

Frequently asked questions

npx skillmds@latest add christopherlouet/doc-generate