📚 Escritura

Documentación técnica

READMEs, docs de API y guías que la gente realmente lee

El problema típico

La doc generada por LLM tiende a explicar lo trivial (qué es Python) y saltearse lo crítico (qué hace cuando falla). Falta jerarquía: instalación, uso básico, ejemplos, edge cases, errores comunes.

Ejemplo real

Comparación de un prompt común vs. la versión optimizada con AEVNI.

✗ Antes

Necesito que me ayudes a escribir la documentación para una librería de Python que hace web scraping. Quiero que sea completa, con ejemplos, y que explique cómo instalar y usar la librería paso a paso.

49 tokens

✓ Después

Doc README para librería Python de web scraping. Sections: Install, Quickstart (10 líneas), API (top 3 funciones), FAQ (errores comunes). Estilo: ejemplos > explicaciones.

38 tokens

−11 tokens · −22%

5 tips clave

1 Especificá el tipo de doc: README, API reference, tutorial, FAQ
2 Definí las secciones: Install + Quickstart + API + Troubleshooting
3 Limitá el quickstart a N líneas (10 es bueno)
4 Pedí "ejemplos > explicaciones"
5 Para API docs: pedí signatura + 1 ejemplo + edge cases conocidos

Probá AEVNI con este caso

Pre-cargamos un template para documentación técnica listo para que ajustes y optimices.

⚡ Optimizar ahora

El problema típico

Ejemplo real

5 tips clave

Probá AEVNI con este caso

Casos relacionados