Warum eine Dokumentationsplattform?
Viele IT-Mitarbeiter nutzen OneNote als Dokumentationsplattform, manche Word-Dateien, wieder andere Textdateien. Die Lösungen sind oftmals dezentral, mindestens aber nicht zentral verwaltet.
Systemdokumentationen sowie Geschäftsfälle gehören zentral und durchsuchbar dokumentiert.
Ungeordnete Sammlungen von Word-, Textdateien oder OneNotes auf Fileshares oder unter Sharepoint-Sites sind zwar durchsuchbar, aber im Zweifelsfall nicht für nicht lizenzierte Benutzer verfügbar.
Im Rahmen der Beratungsprojekte passen wir oftmals Prozesse an oder Implementieren neue Lösungen. Für den Betrieb aber auch für ISO-Zertifizierungen ist es essenziell, dass Konfigurationen oder Prozesse dokumentiert werden.
Im Rahmen einer Marktsichtung zur Suche einer modernen Dokumentationsplattform unter Berücksichtigung folgender Kernpunkte:
- niedrige Lizenzkosten
- einfache Wartbarkeit
- Single Sign on mit Microsoft Entra ID
- einfacher WYSIWIG-Editor mit Drag’n’Drop-Funktion für Bilder und Anhänge
- für mobile Endgeräte geeignet
- Berechtigungsmanagement
- Auditing-Funktion
- Versionierung
- Export der Inhalte als PDF
- Kommentarfunktion
haben wir BookStack (siehe https://www.bookstackapp.com/) entdeckt.
BookStack ist eine freie Open Source-Lösung unter MIT lizenziert. Das Projekt basiert auf php bzw. dem Laravel Framework und nutzt als Datenbank-Backend MySQL oder MariaDB. Es verzichtet auf unnütze Spielereien und ist dem analogen Bücherregal in der Ablagelogik nachempfunden.
Es gibt verschiedene englisch sprachige Dokumentationen vom primären Entwickler Dan Brown, ebenso viele Youtube-Tutorials.
Für einen ersten PoC hat es inklusive der Ubuntu-Installation als VM weniger als 2 Stunden gebraucht, bis man Daten in die Instanz eingeben konnte.
Die Performance und Suche entspricht den Erwartungen, die Einstellungsmöglichkeiten sind nahezu selbsterklärend:
Es werden viele Sprachen unterstützt (u. A. Deutsch, Englisch, Französisch, Spanisch).
Das Userinterface lässt sich in den Administrationseinstellungen branden und Berechtigungen werden über Rollen auf die Shelves, Books, Chapter und Pages zugewiesen. Entra ID-Gruppen lassen sich hierbei mit den BookStack-Rollen verknüpfen.
Neben Entra ID werden auch andere Authentifizierungs-Methoden unterstützt:
- GitHub
- Slack
- Entra ID
- Okta
- GitLab
- Twitch
- Discord
- LDAP (z. B. Active Directory)
Screenshots lassen sich via Drag’n’Drop einfach im WYSIWYG-Editor einfügen:
Die Basiskonfiguration von BookStack erfolgt über eine zentrale Konfigurationsdatei („.env“)
Die Konfigurationsparameter werden in der Dokumentation beschrieben und darüber hinaus stellt der Entwickler ebenfalls viele Youtube-Tutorials für die Einrichtung bereit.
Vorherige Versionen einer Seite lassen sich einfach anzeigen bzw. wiederherstellen.
Innerhalb der Anwendung gibt es eine Kommentarfunktion:
Bei abonnierten Seiten, wie auch bei Kommentaren, kann man sich via E-Mail benachrichtigen lassen.
Inhalte lassen sich standardmäßig als PDF, HTML, Text- oder Markdown-Datei exportieren. Das Export-Recht lässt sich über die Rollen zuweisen.
Inzwischen haben wir bei mehreren Kunden BookStack implementiert, sowohl mit Active Directory als LDAP-Quelle wie auch Entra ID. Die eigentliche Implementation war nach maximal einem Arbeitstag vollständig. Über nginx bzw. HAProxy wurde die Dokumentations-Plattform bei einigen Umgebungen auch nach außen veröffentlicht.
Fragen Sie uns gerne für eine Demo oder die Umsetzung Ihrer BookStack-Instanz an.
