documentation

4 posts

Ich habe aufgehört, Code in Docs zu kopieren, indem ich Tests, Code und Prosa in einer Markdown-Datei halte

Literate Programming hält Dokumentation, Tests und Implementierung synchron, indem eine Markdown-Datei zur single source of truth wird. So lässt es sich in dreißig Zeilen Python umsetzen.

Ihre Docs, Tests und Code sind drei Dateien, die dieselbe Geschichte schlecht erzählen. Sie aktualisieren die Funktionssignatur im Source. Sie vergessen das…

Ihr Claude-Thread ist bereits Dokumentation. Er stirbt nur in zwölf Stunden.

LLM-Konversationen enthalten Absicht, abgelehnte Alternativen und funktionierenden Code. Genau das sollte Dokumentation sein. So verwandeln Sie flüchtigen Chat in dauerhafte, durchsuchbare Docs, ohne die Erzählung zu verlieren.

Sie haben fünfundvierzig Minuten mit Claude damit verbracht, einen Retry-Circuit zu entwerfen. Sie haben die Failure Modes erklärt, exponentielles Backoff…

Donald Knuth wollte, dass Programme wie Literatur gelesen werden. Der Compiler hatte andere Pläne.

Literate Programming versprach, dass Code erst für Menschen und dann für Maschinen geschrieben werden sollte. Vier Jahrzehnte später schreibt fast niemand so. Hier ist, warum die eleganteste Idee der Software-Dokumentation die Art und Weise, wie wir arbeiten, nicht verändern konnte.

1984 veröffentlichte Donald Knuth einen Aufsatz, der eine radikale Umkehrung vorschlug. Programme sollten nicht für Compiler geschrieben und für Menschen…