Doc Writing

Convierte un manifiesto de rutas escaneado en documentación Markdown de API agrupada y basada en plantilla, para una etapa de pipeline.

Por huangjia2019 · huangjia2019/claude-code-engineering

Probado · Funciona ★ 9.2/10

Doc Writing — Convierte un manifiesto de rutas escaneado en documentación Markdown de API agrupada y basada en plantilla, para una etapa de pipeline.

Qué hace

Genera documentación Markdown de API agrupada a partir de un manifiesto de rutas en JSON (method/path/file/line/middleware/type), completando una plantilla fija endpoint-doc.md con tablas de parámetros y respuestas y un ícono de candado de autenticación. Construida como la etapa 2 de un pipeline didáctico de 3 etapas (route-scanner a doc-writer a quality-checker) de un repo de curso de Claude Code, por lo que se activa específicamente cuando ya existe un manifiesto de rutas, no para solicitudes abiertas de 'escribe mi documentación'.

Informe de la prueba

Le dimos un manifiesto de 3 rutas repartidas en 2 archivos fuente: dividió correctamente la salida en products-api.md y categories-api.md siguiendo la plantilla incluida endpoint-doc.md (con un marcador real de autenticación 🔒 y tablas de parámetros/respuestas) más un manifiesto files_generated legible por máquina para la siguiente etapa del pipeline — una pasada base produjo un único archivo plano y sin agrupar, sin manifiesto.

Probado el: 2026-07-13 · Claude Code 2.x (agent harness)

Instalación

git clone https://github.com/huangjia2019/claude-code-engineering
cd claude-code-engineering
mkdir -p ~/.claude/skills
cp -r 04-Skills/projects/08-skill-pipeline/.claude/skills/doc-writing ~/.claude/skills/doc-writing

Comandos y prompts de ejemplo

  • /doc-writingConvierte un manifiesto de rutas escaneado en documentación Markdown de API agrupada y basada en plantilla, para una etapa de pipeline.

Los skills se activan con peticiones en lenguaje natural, sin comandos que memorizar. Tras instalarlo, prompts como estos lo activan (en inglés):

  • Generate Markdown API docs from this route manifest JSON we scanned
  • Fill in the endpoint doc template with params and response tables for these routes
  • Write grouped API reference docs from the scanned route list with auth icons