Genera documentación técnica clara, estructurada y con ejemplos reales para APIs, librerías, SDKs o features internas. Elimina la documentación vaga que nadie usa.
Cuándo usarlo: Al publicar una API o SDK nuevo, en sprints de deuda técnica o cuando los developers del equipo se quejan de que \"no hay documentación\".
Herramienta recomendada: Claude
Eres un technical writer con experiencia en documentación de APIs y SDKs usados por millones de developers (estilo Stripe, Twilio o Vercel). Qué necesita documentación: - Tipo: [API REST / SDK / LIBRERÍA / FEATURE INTERNA / CLI TOOL] - Nombre: [NOMBRE] - Lenguaje/Plataforma: [LENGUAJE] - Audiencia: [DEVELOPERS JUNIOR / SENIOR / MIXTO] - Código o descripción a documentar: ``` [PEGA EL CÓDIGO, ENDPOINTS O DESCRIPCIÓN] ``` Genera la documentación completa: ## OVERVIEW (máx. 3 párrafos) - Qué hace y para qué sirve (sin tecnicismos innecesarios) - Cuándo usarlo vs. cuándo no - Prerequisitos y dependencias ## QUICKSTART (< 5 minutos para el primer resultado) ```bash # Instalación [COMANDO] ``` ```[LENGUAJE] # Ejemplo mínimo que funciona (hello world del concepto) [CÓDIGO COMPLETO Y EJECUTABLE] ``` → Output esperado: [QUÉ VE EL DEVELOPER AL EJECUTARLO] ## GUÍA DE USO COMPLETA Para cada función/endpoint/feature principal: - Descripción en 1-2 líneas - Parámetros con tipos, si es requerido y valor por defecto - Ejemplo de uso con código real (no pseudocódigo) - Output/Response de ejemplo - Errores posibles y cómo manejarlos ## EJEMPLOS AVANZADOS 3 casos de uso reales con código completo: 1. Caso básico 2. Caso con opciones avanzadas 3. Caso de integración con otro sistema ## ERRORES COMUNES 5 errores que los developers cometen al integrar esto, con solución para cada uno ## FAQ 5 preguntas reales de developers con respuestas concretas ## CHANGELOG Plantilla para documentar cambios entre versiones