Esta skill debe usarse cuando el usuario pide "documenta los endpoints", "documenta la API", "documentar las rutas", "document the endpoints", "document the API", "necesito la doc de los endpoints para el frontend", o cuando menciona documentar endpoints HTTP para consumo desde el frontend. Tambien activar cuando el usuario menciona pasar endpoints al frontend, compartir contratos HTTP, o preparar documentacion de rutas REST. No usar para WebSockets ni socket.io (usar document-sockets en su lugar).
Determine scope from conversation context -- identify which routes/controllers were created or modified. If the user names specific resources, limit to those. If ambiguous, use AskUserQuestion to confirm which endpoints to document.
Determine the file prefix (feature name or session context, e.g., auth, payments). If unclear, ask with AskUserQuestion.
Create .claude/docs/api/ directory if it does not exist.
Write documentation to .claude/docs/api/<prefix>-ENDPOINTS.md.
Follow the template and conventions in references/endpoint-template.md for every endpoint.
Group endpoints by resource using H2 sections for resources and H3 for individual endpoints.
1---2name: document-endpoints3description: Esta skill debe usarse cuando el usuario pide "documenta los endpoints", "documenta la API", "documentar las rutas", "document the endpoints", "document the API", "necesito la doc de los endpoints para el frontend", o cuando menciona documentar endpoints HTTP para consumo desde el frontend. Tambien activar cuando el usuario menciona pasar endpoints al frontend, compartir contratos HTTP, o preparar documentacion de rutas REST. No usar para WebSockets ni socket.io (usar document-sockets en su lugar).4---56# Document Endpoints78## Workflow9101. Determine scope from conversation context -- identify which routes/controllers were created or modified. If the user names specific resources, limit to those. If ambiguous, use `AskUserQuestion` to confirm which endpoints to document.112. Determine the file prefix (feature name or session context, e.g., `auth`, `payments`). If unclear, ask with `AskUserQuestion`.123. Create `.claude/docs/api/` directory if it does not exist.134. Write documentation to `.claude/docs/api/<prefix>-ENDPOINTS.md`.145. Follow the template and conventions in `references/endpoint-template.md` for every endpoint.156. Group endpoints by resource using H2 sections for resources and H3 for individual endpoints.
Run npx skillmds@latest add diegopherlt/document-endpoints 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.
Esta skill debe usarse cuando el usuario pide "documenta los endpoints", "documenta la API", "documentar las rutas", "document the endpoints", "document the API", "necesito la doc de los endpoints para el frontend", o cuando menciona documentar endpoints HTTP para consumo desde el frontend. Tambien activar cuando el usuario menciona pasar endpoints al frontend, compartir contratos HTTP, o preparar documentacion de rutas REST. No usar para WebSockets ni socket.io (usar document-sockets en su lugar). It is listed under Web & Frontend on SkillMD.
This skill has not completed SkillMD's automated safety review yet. Capability flags: docs only. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
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.
Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
DieGopherLT (@diegopherlt) published this skill. Their other Agent Skills are listed on their SkillMD profile.
DieGopherLT