2018-08
Kolumne: Hitchhiker's Guide to Docs as Code - Websites mit Asciidoctor
Wir zeigen Ihnen in dieser Folge, wie Sie statische Websites mithilfe von AsciiDoc erstellen und pflegen können. Dazu greifen wir etwas tiefer in die Werkzeugkiste der Softwareentwicklung, nämlich zum Ruby-basierten Generator Jekyll. Ebenso diskutieren wir Alternativen zu Jekyll.
2018-07
Kolumne: Hitchhiker's Guide to Docs as Code - PDF-Output
In Folge 3 unserer Kolumne hatten wir die Generierung von PDFs aus AsciiDoc bereits kurz angerissen. In dieser Folge gehen wir auf ein paar Details ein, mit denen Sie die Klippen bei der Erstellung von PDFs gezielt umschiffen können (und davon gibt es leider noch einige …).
2018-06
Kolumne: Hitchhiker's Guide to Docs as Code - Build-Magie
“Jede hinreichend fortschrittliche Technologie ist von Magie nicht zu unterscheiden.” Dieses Zitat von Arthur C. Clarke trifft auf vieles zu, was ein modernes Build-Skript stellenweise leistet. In dierser Folge unserer Kolumne lüften wir das Geheimnis und erklären einige der nützen Gradle-Features, die Sie für Ihre Dokumentation verwenden können.
2018-04
Kolumne: Hitchhiker's Guide to Docs as Code - Beautiful Code
Ein halbes Dutzend Folgen dieser Kolumne, bevor wir endlich zum Thema Sourcecode kommen: Wir möchten in Architekturdokumentation an manchen Stellen Code integrieren, etwa zur Beschreibung wichtiger Schnittstellen. AsciiDoc bietet hierfür schicke Features.
2018-03
Kolumne: Hitchhiker's Guide to Docs as Code - Diagramme, jetzt wird modelliert
Wenn es um die Modellierung von Architekturen geht, also das Erstellen eines Modells mit verschiedenen Sichten anstelle von unkorrelierten Zeichnungen, dann reicht das Einbinden von statischen Diagrammen oder PlantUML nicht mehr aus. Deshalb greifen wir in dieser Folge etwas tiefer in den Werkzeugkasten und integrieren echte Modelle in unseren Docs-As-Code Ansatz.
2017-12
Kolumne: Hitchhiker's Guide to Docs as Code - Des Doktors neue Kleider
In der letzen Ausgabe haben wir gezeigt, wie Sie Ihre AsciiDoc-Dokumente modular aufbauen können. In der dritten Folge der Kolumne erklären wir am Beispiel der Formate PDF, DOCX, Confluence und EPUB, wie sich verschiedene Ausgabeformate aus Ihrem AsciiDoc-Input erzeugen lassen.
2017-11
Kolumne: Hitchhiker's Guide to Docs as Code - Modulare Dokumentationen erstellen
In der letzten Ausgabe haben wir gezeigt, wie Sie mithilfe von AsciiDoc schnell zu ordentlich gestalteten Dokumenten kommen können. In der zweiten Folge unserer Kolumne möchten wir Ihnen die Möglichkeiten zur Strukturierung und Modularisierung von Dokumentation vorstellen, was einerseits zur Erleichterung von Teamarbeit, andererseits zur Verwendung einzelner Doku-Teile für verschiedene Zielgruppen dient.
2017-10
Kolumne: Hitchhiker's Guide to Docs as Code - Nenn' mich einfach Doktor
Wir kennen das alle, diese gewisse Abscheu des Entwicklungsteams in puncto Dokumentation. Der Horror von ungeeigneten Werkzeugen, fehlender Versionierung und binären Datenformaten. Wir schaffen Abhilfe. Schritt für Schritt führen wir Sie in dieser Kolumne an das Konzept Docs as Code heran, bei dem Sie Ihre technische Dokumentation genauso behandeln wie Ihren Code: Schreiben, bauen, testen, comitten, mergen. Gut, oder?