In drei Jahren hat generative KI den ersten Entwurf von einem teuren Ergebnis zu einer billigen Operation gemacht. Entscheidend ist heute, wer Fakten, Struktur, Review, Aktualisierung und Qualität verantwortet.
Docs-as-Code bedeutet nicht, alle Schreibenden in eine IDE zu zwingen. Entscheidend sind versionierte Quellen, einfache Browser-Bearbeitung, nützliche automatische Checks, sinnvolles Review und eine messbar bessere Veröffentlichung.
Gute API-Dokumentation verbindet maschinenlesbare Verträge mit Erklärungen, ausführbaren Beispielen und klar beschriebenem Fehlerverhalten. REST-API-Dokumentation hat zwei Zielgruppen: Maschinen und Menschen.
Die Werkzeuge haben sich radikal verändert, doch der Kern bleibt erstaunlich vertraut: Zielgruppe, Belege, Struktur, Terminologie und Verantwortung. 2006 waren Desktop-Publishing, Office-Formate und manuell gepflegte Hilfesysteme wesentlich verbreiteter.
Sphinx, MkDocs, Astro und andere Generatoren optimieren unterschiedliche Content Models und Teams. Entscheide nach Authoring Workflow, Erweiterbarkeit, Lokalisierung und Wartungskosten statt nach einer schönen Demo. Eine beeindruckende Demo kann für deine Dokumentation trotzdem falsch sein.
Ein praktischer und prüfbarer Ansatz für „Suche für Dokumentation wählen: bei Fehlerszenarien beginnen“, der langfristig wartbare Dokumentation unterstützt. „Suche für Dokumentation wählen: bei Fehlerszenarien beginnen“ mit einem praktischen, prüfbaren und wartbaren Ansatz für technische Dokumentation.
Ein praktischer und prüfbarer Ansatz für „Diagramme als Code: wann sie helfen und wann nicht“, der langfristig wartbare Dokumentation unterstützt. „Diagramme als Code: wann sie helfen und wann nicht“ mit einem praktischen, prüfbaren und wartbaren Ansatz für technische Dokumentation.
Dokumentation als Build-Artefakt behandeln: Struktur, Links, Beispiele und Publikationsregeln vor der Veröffentlichung prüfen. CI kann nicht beurteilen, ob eine Erklärung nützlich ist, aber vorhersehbare Defekte vor dem menschlichen Review abfangen.
Von Woz’ Notizen und dem Paste-up von 1982 bis Inside Macintosh, HIG, DocC, Markdown und Xcode-Agenten.
Bengaluru, India
Veranstaltungen →Berlin, Germany
Veranstaltungen →Toronto, Canada
Veranstaltungen →Ideen, Methoden und Debatten früherer Generationen technischer Redakteure — im heutigen Kontext neu betrachtet.