Redaktionsleitfaden für Bookstack
# 📘 Redaktionsleitfaden für BookStack
*Unternehmensweite Dokumentation & Wissensmanagement*
---
## 🎯 Zielsetzung
Dieser Leitfaden dient der strukturierten und konsistenten Nutzung von **BookStack** als zentrales Wissens- und Dokumentationssystem unseres Unternehmens.
Alle Mitarbeitenden sollen relevante Informationen **einfach finden, verstehen und aktuell halten** können.
---
## 🧱 Grundstruktur
Die Inhalte in BookStack sind hierarchisch organisiert:
- **Regale (Shelves)** = Themen- oder Abteilungsbereiche
- **Bücher (Books)** = Thematische Einheiten oder Projekte
- **Kapitel (Chapters)** = Gliederung innerhalb eines Buchs (optional)
- **Seiten (Pages)** = Konkrete Inhalte
> 💡 *Faustregel:*
> **Regal = Bereich oder Abteilung**
> **Buch = Thema oder Prozess**
> **Kapitel = Detailgliederung**
> **Seite = Inhalt**
---
## 🧑🤝🧑 Zuständigkeiten
- Jede Abteilung bekommt **ein eigenes Regal** und ist für die Pflege selbst verantwortlich.
- Jede Abteilung bestimmt mindestens **eine:n Verantwortliche:n („Dokupate“)**.
- Allgemeine Bücher (z. B. Telefonliste, FAQ) werden durch zentrale Stellen gepflegt (z. B. IT oder Verwaltung).
---
## 📝 Schreibregeln
### 4.1 Titel & Benennung
- **Regale**: `IT`, `HR`, `Produktion`, `Marketing`, `Allgemein / Unternehmensinfo`
- **Bücher**: Klar, eindeutig, thematisch → `Netzwerk & Server`, `Onboarding`, `Anleitungen Produktion`
- **Seiten**: Aussagekräftig, idealerweise mit Subthema → `VPN-Einrichtung Standort A`, `DATEV-Login-Prozess`
### 4.2 Sprachstil
- **Klar & sachlich**, keine Umgangssprache
- **Du-Form** bei Anleitungen: *„Öffne die Systemsteuerung…“*
- **Technisch präzise** bei IT-Themen
- Keine Redundanzen – lieber verlinken als kopieren
### 4.3 Strukturierung
Jede Seite sollte möglichst enthalten:
- **Kurze Einleitung**: *Was wird beschrieben? Warum relevant?*
- **Gliederung mit Überschriften (H2/H3)**
- **Screenshots oder Tabellen**, wenn sinnvoll
- **Stand oder Änderungsdatum** am Ende
---
## 🔒 Zugriffsrechte & Sichtbarkeit
- **Regale sind standardmäßig privat** und nur für die jeweilige Abteilung sichtbar.
- **Allgemeine Informationen** (z. B. Telefonliste, Urlaubskalender) sind für alle sichtbar, aber nur durch festgelegte Rollen bearbeitbar.
- Sichtbarkeit wird durch die **IT-Administration** oder die jeweiligen Abteilungsverantwortlichen gesetzt.
---
## 📦 Versionierung & Pflege
- Änderungen sollten **mit Datum und Name** markiert werden.
- Für sensible Inhalte (z. B. Passwörter, interne Abläufe) ist auf **aktuelle & sichere Speicherung** zu achten.
- Jede Abteilung prüft ihre Inhalte **mindestens 1× pro Quartal** auf Aktualität.
---
## ✅ Checkliste für neue Inhalte
| Punkt | Erledigt |
|-------|----------|
| Titel ist aussagekräftig ✅ | ☐ |
| Seite hat sinnvolle Gliederung ✅ | ☐ |
| Inhalt wurde korrekturgelesen ✅ | ☐ |
| Sichtbarkeit ist korrekt gesetzt ✅ | ☐ |
| Änderungsdatum am Ende ✅ | ☐ |
---
## 💬 Fragen & Support
Bei Fragen zur Struktur, Technik oder Berechtigungen:
📧 **it@firmenname.de**
📄 Oder nutze die interne Seite: `Allgemein / IT-Wissen / Hilfe zu BookStack`
---
## 🔄 Änderungen am Leitfaden
Der Redaktionsleitfaden wird durch die **IT-Abteilung** gepflegt. Vorschläge und Feedback sind ausdrücklich erwünscht.
---
## 🖋️ Beispielhafte Titelformate
| Typ | Beispiel |
|-----|----------|
| Anleitung | `Windows 11 – VPN einrichten` |
| Prozess | `Einarbeitung neuer Mitarbeitender` |
| Übersicht | `Serverstandorte im Überblick` |
| FAQ | `Häufige Fragen zur Zeiterfassung` |
---
*Stand: {{date:YYYY-MM-DD}}*