# API Docs Writer

Escribe documentación clara y orientada a desarrolladores.

- Repository: https://github.com/mohitagw15856/pm-claude-skills (1505 stars)
- Category: Engineering
- License: MIT
- Last updated: 2026-11-01
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add mohitagw15856/pm-claude-skills --skill api-docs-writer -g -a claude-code -y`
Codex: `npx skills add mohitagw15856/pm-claude-skills --skill api-docs-writer -g -a codex -y`
Cursor: `npx skills add mohitagw15856/pm-claude-skills --skill api-docs-writer -g -a cursor -y`
Gemini CLI: `npx skills add mohitagw15856/pm-claude-skills --skill api-docs-writer -g -a gemini-cli -y`
Claude Code plugin marketplace: `/plugin marketplace add mohitagw15856/pm-claude-skills`

## Description

Escribe documentación clara y orientada a desarrolladores. Úsalo cuando se te pida documentar un endpoint de API, escribir docs de referencia de API, crear una guía de desarrollador, o convertir una especificación cruda o colección Postman en documentación. Produce documentación de endpoint con descripciones, parámetros, ejemplos de request/response y códigos de error.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# API Docs Writer Skill

Esta skill transforma especificaciones de API crudas, descripciones de endpoint o colecciones Postman en documentación limpia y orientada a desarrolladores, siguiendo convenciones adyacentes a OpenAPI. El resultado está listo para un portal de desarrolladores, README o página en Notion/Confluence.

## Inputs Requeridos

Trabaja con lo que se proporciona. Si falta alguno de estos, aun así produce el output completo: llena cada brecha con una suposición razonable marcada como *(assumed, confirm)* y lista esas suposiciones al final. Haz una pregunta solo cuando el tema central en sí falte (no hay nada sobre qué escribir).
- **Detalles de API o endpoint** (especificación cruda, export de Postman o descripción verbal)
- **Método de autenticación** (API key / Bearer token / OAuth 2.0 / Ninguno)
- **URL base**
- **Versión de API** (p. ej. v1, v2.3, o "sin versionar", afecta notas de deprecación y headers de versionado)
- **Rate limits** (requests por segundo/minuto por token o IP, si se conoce, o "desconocido")
- **Audiencia** (desarrolladores internos / partners externos / público)
- **Formato de output** (Markdown para portales de desarrolladores y READMEs / Prosa plana para Confluence o Notion, nota: OpenAPI YAML no es producido por esta skill)

## Formato de Output

Para cada endpoint, produce lo siguiente:

---

## `[METHOD] /path/to/endpoint`

**Summary:** [Una línea, qué hace este endpoint]

**Description:** [2, 4 oraciones. Cuándo usar este endpoint. Qué devuelve. Cualquier comportamiento importante a conocer (paginación, rate limits, procesamiento asincrónico, etc.)]

**Authentication:** [Requerida / Opcional, método]

---

### Request

**Headers:**

| Header | Requerido | Descripción |
|---|---|---|
| `Authorization` | Sí | `Bearer <token>` |
| `Content-Type` | Sí | `application/json` |

**Path Parameters:**

| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| `id` | string | Sí | Identificador único para el recurso |

The rest: https://github.com/mohitagw15856/pm-claude-skills/blob/HEAD/i18n/es/skills/api-docs-writer/SKILL.md