Draft For Versionsverwaltung.md

[hejjoe]

Kurzbezeichnung

Dokumente neu veröffentlichen ohne eine Versionsverwaltung

Kategorie

???

Ungute Lösung

Wichtige Dokumente (z.B. eine API-Dokumention) werden gern geändert ohne, dass die Art der Änderung (z.B. Löschungen oder Ergänzungen) und das Datum der Änderung erkennbar ist.

Negative Konsequenzen

Ohne eine Versionsverwaltung es ist nicht möglich Änderungen, die sich im Laufe der Zeit durchaus immer mal ergeben können, nachzuvollziehen. So kann z.B. die Verfügbarkeit neuer Funktionen zwar dokumentiert sein aber ohne eine Versionsverwaltung bleibt das dann unentdeckt. Oder wenn angebotene Funktionen sich ändern und die Änderungen nicht nachvollzogen werden können, können Anwendungen, die auf den angebotene Funktionen basieren, kaputt gehen.

Ursprüngliches Problem

Oft werden wichtige Dokumente einfach überschrieben mit der neuen Version (egal ob als PDF oder als Webseite). Dabei fehlt das Bewusstsein und/oder die technischen Möglichkeiten eine Versionsverwaltung sicherzustellen.

WorkAround

externe Versionsverwaltung mit verschiedenen Methoden und Werkzeugen (archive.org, web scraping, draftable.com).

Empfohlene Lösung

Dokumente nur noch mit Versionsverwaltung veröffentlichen und bei der Veröffentlichung einer neuen Version über geeignete Wege eine öffentlichen Kommunikation über die Änderung und die Motivation dahinter sicherstellen (z.B. in Form eines Blogposts).

Cartoon/Visualisierung

Beispiel

DIP API Doku: Ein Zeitstempel ist im Dokument vorhanden aber ohne Erklärung, was wann geändert wurde. Die Versionsnachverfolgung ist leider nur über den Vergleich der alten PDF-Dokumente via archive.org möglich. archive.org

Weitere Informationen

https://de.wikipedia.org/wiki/Versionsverwaltung