literate-programming

6 posts

literate-programmingci-cdweave-tangleautomation

Votre programme littéraire est cassé tant que CI ne peut pas le tangler sans vous

La programmation littéraire promet une source unique de vérité, mais les étapes manuelles de weave et tangle cassent la pipeline CI/CD. Voici comment automatiser l'extraction et la génération de documentation pour que vos fichiers Markdown restent canoniques.

Si votre pipeline de build ne peut pas s'exécuter sans que vous ouvriez un terminal et tapiez , vous n'avez pas de programme littéraire. Vous avez un journal…
literate-programmingdocumentationtestingsingle-source-of-truth

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…
literate-programmingllmdocumentationai-engineering

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…
literate-programmingstructured-editingastprogramming-tools

Les éditeurs de texte vous laissent écrire du code invalide. Les éditeurs d'arbres ne le feraient pas.

Chaque compilateur voit votre code comme un arbre, mais votre éditeur vous laisse modifier du texte brut. Voici à quoi ressemble réellement l'édition structurée, pourquoi elle ne s'est pas imposée et comment emprunter ses avantages sans changer d'outils.

Chaque langage de programmation possède une grammaire formelle. Votre compilateur la lit, construit un arbre d'analyse et rejette tout ce qui ne correspond…
literate-programmingknuthsoftware-historydocumentation

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…