Dokumente erstellen und bearbeiten

Dokumente erstellen und bearbeiten

Dokumente in AB Projects sind Markdown-Seiten mit vollständigem Versionsverlauf. Das Erstellen und Bearbeiten erfolgt in einem seitlichen Bereich mit einer Live-Vorschau, und jede Änderung wird aufgezeichnet, sodass das Team stets weiß, was sich geändert hat und warum.

Eine Seite erstellen

• Beginnen Sie im Bereich Dokumente des Projekts eine neue Seite. Geben Sie ihr einen Titel, einen optionalen übergeordneten Pfad (Standard ist / — legen Sie etwas wie onboarding fest, um sie zu verschachteln) und optionale Tags.
• Schreiben Sie den Textkörper in Markdown. Der Editor zeigt eine Live-Vorschau neben dem Quelltext, sodass Sie das gerenderte Ergebnis beim Tippen sehen können.
• Speichern Sie, um die Seite im Baum zu veröffentlichen. Sie wird zu Version 1.

Eine Seite bearbeiten

• Öffnen Sie eine Seite und wählen Sie Bearbeiten (über das Aktionsmenü der Seite). Derselbe Bereich öffnet sich mit dem aktuellen Markdown.
• Beim Bearbeiten ist eine Bearbeitungsnotiz erforderlich. Bevor Sie eine Änderung speichern, müssen Sie eine kurze Notiz eingeben, die beschreibt, was sich geändert hat — lassen Sie sie leer, fordert AB Projects Sie auf, eine hinzuzufügen, "damit Ihr Team weiß, was sich geändert hat." (Neue Seiten benötigen keine Notiz; Bearbeitungen schon.)
• Beim Speichern wird eine neue Version erstellt, anstatt zu überschreiben — die vorherige Version bleibt erhalten.

Versionsverlauf und Wiederherstellung

• Jede Seite verfolgt eine Versionsnummer sowie den letzten Bearbeiter und die Zeit.
• Öffnen Sie Verlauf über das Aktionsmenü der Seite, um frühere Versionen zu sehen, jede mit ihrer Bearbeitungsnotiz — sodass das "Warum" jeder Änderung dokumentiert ist.
• Sie können eine frühere Version aus der Verlaufsliste wiederherstellen. Das Wiederherstellen bringt diesen Inhalt als aktuelle Seite zurück (und wird selbst als neue Version aufgezeichnet).

Eine Seite löschen

• Löschen ist über das Aktionsmenü der Seite verfügbar und bewusst von Bearbeiten/Verlauf getrennt platziert, damit es nicht versehentlich angeklickt wird.
• Beim Löschen wird die Seite aus dem Baum entfernt. Behandeln Sie dies als bedachte Aktion — ziehen Sie Bearbeiten oder Wiederherstellen dem Löschen vor, wenn Sie nur den Inhalt ändern müssen.

Tipps

• Verwenden Sie den übergeordneten Pfad, um eine klare Struktur aufzubauen (z. B. engineering/runbooks), anstatt einer flachen Liste von Seiten.
• Schreiben Sie aussagekräftige Bearbeitungsnotizen — sie sind das, was der Verlauf anzeigt und worauf sich Teammitglieder verlassen, um eine Änderung ohne Diff zu verstehen.
• Nutzen Sie die Live-Vorschau, um die Formatierung (Überschriften, Codeblöcke, Links) vor dem Speichern zu prüfen.
• Ist eine Bearbeitung schiefgegangen, stellen Sie die vorherige Version aus dem Verlauf wieder her, anstatt aus dem Gedächtnis neu zu schreiben.

Mit Markdown, Live-Vorschau, verpflichtenden Bearbeitungsnotizen und einem vollständigen Verlauf mit Wiederherstellung bleiben Dokumente leicht zu schreiben und sicher zu ändern.