2024
Documentation as Code in der Automotive-System- und Softwareentwicklung
Der beste Überblick, den ich zu Docs-as-Code in einem professionellen Automotive-Projekt kenne: das Paper von Dr. Momcilo Krunic über ein ASPICE-konformes Setup mit 150 Engineers – mit seiner Erlaubnis veröffentlicht.
Weiterlesen →
Aus Sicht des Managements: Was bringt Docs-as-Code?
Ein erdachtes Gespräch mit dem Projektleiter eines Automotive-Softwareprojekts mit 500 Leuten: warum die Qualität der Dokumentation in Expertentools leidet und wie Docs-as-Code hilft.
Weiterlesen →2021
Prozesse dokumentieren mit Sphinx-Needs
Prozesse und Workflows nach dem Docs-as-Code-Ansatz dokumentieren: ein Prozessmodell mit Sphinx-Needs, vom Build geprüft, verlinkbar aus Projektanforderungen – Kennzahlen inklusive.
Weiterlesen →
Open-Needs-DB wird gefördert
Der Prototype Fund des Bundesministeriums für Bildung und Forschung finanziert die Open-Needs-DB: eine REST-Datenbank, um Anforderungen zwischen Projekten zu teilen.
Weiterlesen →
Sphinx-Erweiterungen entwickeln: Tipps und Tricks
Was ich beim Schreiben von Sphinx-Erweiterungen gelernt habe: von anderen Erweiterungen lernen, einen Namensraum nutzen, parallele Builds unterstützen, den Node-Tree bearbeiten – und die Doku als Test nutzen.
Weiterlesen →
Docs-as-Code, weitergedacht
Docs-as-Code heißt mehr, als Doku in Git abzulegen: Mit Sphinx-Needs wird der Inhalt selbst zu Code – wiederverwendbare, verlinkbare Objekte mitten im Text.
Weiterlesen →
Metadaten für Seiten in Sphinx
Wer ist für eine Seite verantwortlich, und wann hat sie sich zuletzt geändert? Sphinx-Needs speichert das als unauffälliges Metadaten-Objekt auf jeder Seite – wiederverwendbar in Tabellen und Filtern.
Weiterlesen →
Aus Text wird ein Link: String2Link mit Sphinx-Needs
Eine Issue-ID oder einen Nutzernamen hinschreiben und einen Link bekommen: Das String-Links-Feature von Sphinx-Needs macht aus Optionswerten Links in externe Tools.
Weiterlesen →PyCharm File Watchers für Sphinx-Projekte
Die Sphinx-Doku so schnell wie möglich sehen: Ein File Watcher in PyCharm baut das HTML bei jeder Änderung neu – mit allen Erweiterungen und deinem gewohnten Build-Befehl.
Weiterlesen →