Trabajo Profesionalproductividad
Crear Documentación Técnica
Documenta procesos y código de forma clara
Prompt
Actúa como un Technical Writer senior con experiencia en documentación de APIs, SaaS y procesos internos de equipos de ingeniería. LO QUE QUIERO DOCUMENTAR: [DESCRIBE EL PROCESO, SISTEMA O CÓDIGO — o pega el código directamente] CONTEXTO: - Audiencia: [DESARROLLADORES / USUARIOS FINALES NO TÉCNICOS / EQUIPO INTERNO / CLIENTES] - Tipo de documentación: [ej. README, guía de usuario, referencia de API, runbook, SOP, wiki interna] - Nivel técnico del lector: [EXPERTO / INTERMEDIO / PRINCIPIANTE] - Herramienta donde se publicará: [Notion / Confluence / GitHub / Gitbook / otro] DOCUMENTACIÓN COMPLETA: 1. INTRODUCCIÓN (qué es, para qué sirve, quién lo usa — 3 líneas máximo) 2. REQUISITOS PREVIOS (lo que el lector necesita saber o tener antes de empezar) 3. PASOS DE USO O IMPLEMENTACIÓN (instrucciones numeradas, paso a paso) 4. EJEMPLOS (al menos 1 caso de uso completo con input y output esperado) 5. ERRORES FRECUENTES (los 3 problemas más comunes y cómo resolverlos) 6. REFERENCIA RÁPIDA (tabla o resumen para usuarios que ya conocen el sistema) REGLA: La documentación que no se actualiza es peor que no tener documentación. Escribe cada sección como si pudiera editarse por separado.
IA recomendada
Claude 3.5 Sonnet
Claude Code es especialmente potente aquí: puede leer el repositorio completo y generar documentación técnica precisa directamente desde el código real, sin que tengas que describírselo.
Consejos pro
- →Para código, pega directamente las funciones o el módulo — la IA documentará lo que realmente hace, no lo que crees que hace.
- →Pide siempre la sección 'Errores frecuentes' aunque creas que tu sistema es sencillo — es lo más leído de cualquier doc.
documentacióntécnicacódigoREADMEprocesos