documentation

4 posts

Parei de copiar código para a documentação mantendo testes, código e prosa num único ficheiro Markdown

A programação literária mantém a documentação, os testes e a implementação sincronizados ao tornar um ficheiro Markdown a única fonte de verdade. Eis como implementá-la em trinta linhas de Python.

A sua documentação, testes e código são três ficheiros a contar a mesma história mal. Atualiza a assinatura da função no source. Esqueces o exemplo do README.…

Seu thread no Claude já é documentação. Só morre em doze horas.

Conversas com LLM contêm intenção, alternativas rejeitadas e código funcional. É exatamente isso que a documentação deveria ser. Veja como transformar um chat efêmero em documentos duráveis e pesquisáveis sem perder a narrativa.

Você passou quarenta e cinco minutos com Claude projetando um circuito de retry. Você explicou os modos de falha, rejeitou o backoff exponencial porque esconde…

Donald Knuth queria que programas fossem lidos como literatura. O compiler tinha outros planos.

A programação literária prometia que o código deveria ser escrito primeiro para humanos e depois para máquinas. Quatro décadas depois, quase ninguém escreve assim. Veja por que a ideia mais elegante da documentação de software não conseguiu mudar a forma como trabalhamos.

Em 1984, Donald Knuth publicou um artigo que propunha uma inversão radical. Programas não deveriam ser escritos para compilers e anotados para humanos.…