documentation

4 posts

Dejé de copiar código en la documentación manteniendo tests, código y prosa en un solo archivo Markdown

La programación literaria mantiene la documentación, los tests y la implementación sincronizados al convertir un archivo Markdown en la única fuente de verdad. Así es como implementarlo en treinta líneas de Python.

Tus docs, tests y código son tres archivos contando la misma historia mal. Actualizas la firma de la función en el source. Olvidas el ejemplo del README. Una…

Tu Thread con Claude Ya Es Documentación. Solo Muere en Doce Horas.

Las conversaciones con LLM contienen intención, alternativas rechazadas y código funcional. Eso es exactamente lo que la documentación debería ser. Aquí está cómo convertir chat efímero en documentación durable y buscable sin perder la narrativa.

Pasaste cuarenta y cinco minutos con Claude diseñando un circuito de reintento. Explicaste los modos de falla, rechazaste el backoff exponencial porque oculta…

Donald Knuth quería que los programas se leyeran como literatura. El compilador tuvo otras ideas.

La programación literaria prometía que el código debía escribirse primero para humanos y segundo para máquinas. Cuatro décadas después, casi nadie escribe de esa manera. He aquí por qué la idea más elegante en la documentación de software no logró cambiar la forma en que trabajamos.

En 1984, Donald Knuth publicó un artículo que proponía una inversión radical. Los programas no deberían escribirse para compilers y anotarse para humanos.…