Gepostet in Technisches Schreiben.
20 Years of Git - How Versioning changed Technical Writing
Marvin Blome – .
Git wird 20! Erfahren Sie, wie sich Versionierung entwickelt hat und warum Git + AsciiDoc die Zukunft der technischen Dokumentation ist.
Happy Birthday, Git!
Am 7. April 2005 machte Linus Torvalds den ersten Commit in ein neues Versionskontrollsystem: Git. Was als Notlösung für die Linux-Kernel-Entwicklung begann, ist heute der Standard für Softwareentwicklung – und längst nicht mehr nur dort. Auch in der technischen Dokumentation hat Git eine Revolution ausgelöst.
Wie hat sich die Versionierung seit dem ersten Commit entwickelt? Was bedeutet das für technische Dokumente, insbesondere in AsciiDoc? Und welche Best Practices helfen, Dokumentationen effizient zu verwalten? Ein Blick zurück – und nach vorne.
Der erste Commit: Der Anfang von allem
Linus Torvalds war frustriert. Das bisherige Versionskontrollsystem BitKeeper wurde plötzlich kostenpflichtig. Die Linux-Community brauchte eine Alternative – schnell. Innerhalb weniger Tage schrieb Torvalds den ersten Code für Git. Der erste Commit vom 7. April 2005 ist eine Momentaufnahme dieser hektischen Tage:
commit e83c5163316f89bfbde7d9ab23ca2e25604af290
Author: Linus Torvalds <torvalds@linux-foundation.org>
Date: Thu Apr 7 15:13:13 2005 -0700
Initial revision
Ein einfacher Kommentar: "Initial revision". Ohne zu ahnen, wie groß dieses System in Zukunft werden würde.
Von Code zu Content
Damals war Versionskontrolle vor allem ein Tool für Entwickler. Doch heute nutzen auch technische Redakteure Git für Dokumentationen – ein Trend, der mit Docs-as-Code Fahrt aufnahm.
Von SVN zu Git: Der Wandel in der Dokumentation
Früher dominierten zentrale Systeme wie Apache Subversion (SVN) oder sogar Microsoft Word mit Track Changes die Dokumentation.
Git brachte dezentrale, verteilte Workflows – ideal für Remote-Teams und Open-Source-Dokumentationen.
Docs-as-Code etablierte Git als Standard für technische Dokumente, besonders mit AsciiDoc und Markdown.
Warum? Weil Dokumentation oft denselben Anforderungen wie Code folgt: Zusammenarbeit, Nachvollziehbarkeit, Versionierung und Automatisierung.
AsciiDoc + Git: Ein unschlagbares Duo
AsciiDoc hat sich als leistungsstarke Alternative zu Markdown für technische Dokumentation etabliert. Es bietet semantische Struktur, modulare Inhalte und hervorragende Konvertierungsoptionen. In Kombination mit Git entstehen enorme Vorteile:
Kollaboration: Teams arbeiten parallel an Dokumenten, ohne Konflikte in Binärformaten wie Word oder PDF.
Nachvollziehbarkeit: Jede Änderung ist mit einem Commit dokumentiert. Wer hat was geändert – und warum?
Automatisierung: Continuous Integration (CI) kann Dokumente automatisch generieren und veröffentlichen.
Ein typischer Workflow für AsciiDoc mit Git sieht so aus:
Repository klonen:
git clone https://github.com/user/docs-repo.git
Änderungen machen und committen:
git add . git commit -m "Kapitel zur API-Dokumentation hinzugefügt"
Änderungen veröffentlichen:
git push origin main
So lassen sich technische Dokumente nahtlos in größere Entwicklungsprozesse integriert werden.
Tipps & Tricks: Bessere Versionierung für technische Dokumente
Branches für größere Änderungen nutzen
Arbeiten Sie an neuen Kapiteln oder größeren Updates in separaten Branches, bevor sie inmain
gemerged werden.Atomic Commits verwenden
Halten Sie Änderungen klein und thematisch zusammen. Das erleichtert späteres Debugging und Review.Gute Commit-Messages schreiben
Statt „Update doc“ lieber „Erklärung zur API-Authentifizierung ergänzt“. Klare Messages helfen beim Nachvollziehen von Änderungen.Tags für Releases setzen
Markiere stabile Versionen der Dokumentation mit Tags, z. B.:git tag -a v1.0 -m "Erste veröffentlichte Version" git push origin v1.0
CI/CD für Doku-Automatisierung einrichten
Mit Tools wie GitHub Actions oder GitLab CI/CD lässt sich Dokumentation bei jedem Commit automatisch generieren und bereitstellen.
Fazit: Git verändert, wie wir Dokumentation denken
Seit dem ersten Commit hat sich Git von einem Entwickler-Tool zu einer universellen Plattform für kollaborative Arbeit entwickelt. In Kombination mit AsciiDoc ermöglicht es eine transparente, effiziente und skalierbare Dokumentation – ganz im Sinne von Docs-as-Code.
Am 7. April feiern wir also nicht nur Git, sondern auch eine neue Ära der technischen Dokumentation. Wer seine Dokumentation noch manuell verwaltet, sollte spätestens jetzt umsteigen. Denn die Zukunft ist versioniert – und sie beginnt heute. 🚀
Das könnte Sie auch interessieren:
-
AsciiDoc im Vergleich
- Marvin Blome
- Verfasst am
-
Markup-Sprachen versus WYSIWYG
- Marvin Blome
- Verfasst am