Dokumentversionierung
📝 Dokumentversionierung in Brainframe
"Jede Änderung nachverfolgen, komplette Historie behalten."
Von Entwurf bis genehmigter Version – Brainframe zeichnet alles auf.
Alle neu erstellten Dokumente starten im Entwurfsmodus. Jedes Mal, wenn Sie speichern, erfasst Brainframe einen zeitgestempelten Verlaufseintrag.
1️⃣ Version zuweisen
Einen Entwurf in ein versioniertes Dokument umwandeln:
- Öffnen Sie das Dokument in der Dokumentenansicht.
- Klicken Sie in der oberen Leiste auf Version zuweisen.
- Geben Sie die neue Versionsnummer im x.y.z-Format ein (z. B.
1.2.0
) und speichern Sie.
2️⃣ Versionsregeln (SemVer)
Brainframe verwendet Semantic Versioning:
- x – MAJOR: Erste finale Releases oder komplette Neuschreibungen.
- y – MINOR: Rückwärtskompatible Änderungen (erweiterte Erklärungen, kleine Features).
- z – PATCH: Kleine Korrekturen (Tippfehler, Links, Formatierungen).
3️⃣ Als überprüft markieren (ohne Inhaltsänderung)
Eine Überprüfung nachverfolgen, ohne eine neue Version zu erstellen:
- Öffnen Sie den Tab Aktivitäten.
- Aktivieren Sie Dieses Dokument als überprüft markieren.
- Speichern.
📌 Dadurch wird das Datum der Überprüfung/Alterung aktualisiert, ohne die Version zu ändern.
4️⃣ Freigaben nach Versionszuweisung
Wenn der Dokumenttyp einen Freigabe-Workflow konfiguriert hat:
- Nach der Versionszuweisung erscheinen die Workflow-Schritte (z. B. Überprüfung, Genehmigen/Ablehnen).
- Verwenden Sie Genehmigen oder Ablehnen, um den konfigurierten Ablauf fortzuführen.
5️⃣ Revisionen anzeigen und vergleichen
Der Revisionen-Tab bietet Ihnen eine vollständige Audit-Spur:
- Sehen Sie die komplette Versionshistorie (wer was wann geändert/genehmigt hat).
- Wählen Sie eine beliebige frühere Version aus, um deren Inhalt zu sehen. Mit Änderungen anzeigen können Unterschiede zwischen Versionen hervorgehoben werden. Nur verfügbar für Dokumente, die mit dem Standard-Editor erstellt wurden.
6️⃣ Best Practices
- 🔄 Überprüfungsmarkierungen nutzen für regelmäßige Checks ohne Inhaltsänderungen.
- 🚨 Konsistent SemVer anwenden, damit Ihr Team die Änderungstypen versteht.
- 📝 Klare Versionsnotizen hinzufügen, um zu dokumentieren, warum Änderungen erfolgten.
- 👀 Revisionen regelmäßig vergleichen, um subtile Änderungen zu verfolgen.
- ✅ Freigaben an Versionen binden für eine vollständige Audit-Spur.
🎯 Checkliste
- [x] Version mit SemVer zugewiesen
- [x] Überprüfungsmarkierung genutzt, wo keine Inhaltsänderung erfolgte
- [ ] Freigabe-Workflow abgeschlossen
- [ ] Versionshistorie geprüft und verglichen
- [ ] Versionsnotizen für Audit-Bereitschaft dokumentiert
Aktualisiert am: 22/09/2025
Danke!