Direkt zum Hauptinhalt

Redaktionsleitfaden für Bookstack

#

📘 Redaktionsleitfaden für BookStack
*

Unternehmensweite Dokumentation & Wissensmanagement*Wissensmanagement

---


##

🎯 Zielsetzung

Dieser Leitfaden dient der strukturierten und konsistenten Nutzung von **BookStack**BookStack als zentrales Wissens- und Dokumentationssystem unseres Unternehmens.

Alle Mitarbeitenden sollen relevante Informationen **einfach finden, verstehen und aktuell halten**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**Abteilung

> **Buch = Thema oder Prozess**Prozess

> **Kapitel = Detailgliederung**Detailgliederung

> **Seite = Inhalt**Inhalt

---

##


🧑‍🤝‍🧑 Zuständigkeiten

-

  • Jede Abteilung bekommt **ein eigenes Regal**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**
  • Regale: `IT`IT, `HR`HR, `Produktion`Produktion, `Marketing`Marketing, `Allgemein / Unternehmensinfo`
    -Unternehmensinfo
  • **Bücher**
  • Bücher: Klar, eindeutig, thematisch → `Netzwerk & Server`Server, `Onboarding`Onboarding, `Anleitungen Produktion`
    -Produktion
  • **Seiten**
  • Seiten: Aussagekräftig, idealerweise mit Subthema → `VPN-Einrichtung Standort A`A, `DATEV-Login-Prozess`

    Prozess
  • ###

4.2 Sprachstil

-

    **
  • Klar & sachlich**sachlich, keine Umgangssprache
    -
  • **
  • Du-Form**Form bei Anleitungen: *„Öffne die Systemsteuerung…“*
    -
  • **
  • Technisch präzise**präzise bei IT-Themen
    -
  • Keine Redundanzen – lieber verlinken als kopieren

  • ###

4.3 Strukturierung

Jede Seite sollte möglichst enthalten:

-

    **
  • Kurze Einleitung**Einleitung: *Was wird beschrieben? Warum relevant?*
    -
  • **
  • Gliederung mit Überschriften (H2/H3)**
    -
  • **
  • Screenshots oder Tabellen**Tabellen, wenn sinnvoll
    -
  • **
  • Stand oder Änderungsdatum**Änderungsdatum am Ende

  • ---

##


🔒 Zugriffsrechte & Sichtbarkeit

-

    **
  • Regale sind standardmäßig privat**privat und nur für die jeweilige Abteilung sichtbar.
    -
  • **
  • Allgemeine Informationen**Informationen (z. B. Telefonliste, Urlaubskalender) sind für alle sichtbar, aber nur durch festgelegte Rollen bearbeitbar.
    -
  • Sichtbarkeit wird durch die **IT-Administration**Administration oder die jeweiligen Abteilungsverantwortlichen gesetzt.

  • ---

##


📦 Versionierung & Pflege

-

  • Änderungen sollten **mit Datum und Name**Name markiert werden.
    -
  • Für sensible Inhalte (z. B. Passwörter, interne Abläufe) ist auf **aktuelle & sichere Speicherung**Speicherung zu achten.
    -
  • Jede Abteilung prüft ihre Inhalte **mindestens 1× pro Quartal**Quartal auf Aktualität.

  • ---

##


✅ Checkliste für neue Inhalte

|

|Erledigt|
|-------|----------|
| ||
|||
|||
|||
|||

---

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**de

📄 Oder nutze die interne Seite: `Allgemein / IT-Wissen / Hilfe zu BookStack`BookStack

---


##

🔄 Änderungen am Leitfaden

Der Redaktionsleitfaden wird durch die **IT-Abteilung**Abteilung gepflegt. Vorschläge und Feedback sind ausdrücklich erwünscht.

---


##

🖋️ Beispielhafte Titelformate

|

|Beispiel|
|-----|----------|
| | `|
| | `|
| | `|
| | `|

Typ Beispiel
Anleitung Windows 11 – VPN einrichten`einrichten
Prozess Einarbeitung neuer Mitarbeitender`Mitarbeitender
Übersicht Serverstandorte im Überblick`Überblick
FAQ Häufige Fragen zur Zeiterfassung`Zeiterfassung

---

*Stand: {{date:YYYY-MM-DD}}*