documentation

4 posts

J'ai arrêté de copier du code dans la documentation en gardant les tests, le code et la prose dans un seul fichier Markdown

La programmation littéraire maintient la documentation, les tests et l'implémentation synchronisés en faisant d'un fichier Markdown la source unique de vérité. Voici comment l'implémenter en trente lignes de Python.

Vos docs, vos tests et votre code sont trois fichiers qui racontent la même histoire mal. Vous mettez à jour la signature de la fonction dans le source. Vous…

Votre Thread avec Claude Est Déjà de la Documentation. Il Meurt Juste en Douze Heures.

Les conversations avec les LLM contiennent l'intention, les alternatives rejetées et le code fonctionnel. C'est exactement ce que la documentation devrait être. Voici comment transformer un chat éphémère en documentation durable et consultable sans perdre la narration.

Vous avez passé quarante-cinq minutes avec Claude à concevoir un circuit de réessai. Vous avez expliqué les modes de défaillance, rejeté le backoff exponentiel…

Donald Knuth voulait que les programmes se lisent comme de la littérature. Le compilateur en avait décidé autrement.

La programmation lettrée promettait que le code devait être écrit d'abord pour les humains et ensuite pour les machines. Quatre décennies plus tard, presque personne n'écrit de cette manière. Voici pourquoi l'idée la plus élégante de la documentation logicielle n'a pas changé notre façon de travailler.

En 1984, Donald Knuth a publié un article proposant une inversion radicale. Les programmes ne devraient pas être écrits pour les compilateurs et annotés pour…

Votre diagramme d'architecture est déjà un mensonge

La documentation d'architecture pourrit dès que vous la sauvegardez. Voici comment garder une documentation honnête en utilisant des diagrammes générés depuis le code, des ADR et des tests d'architecture automatisés.

Chaque diagramme d'architecture que j'ai vu dans un wiki était faux. Pas dramatiquement faux. Juste calmement, progressivement faux. Le service nommé « Auth »…