4.12 Dokumentationssystem (WIKI)
Die Struktur des Moduls umfasst vier wesentliche Teilbereiche:
- Dokumentationsübersicht – Dokumentationskategorie
- Seitenliste – Kapitel
- Neue Seite – Seite erstellen
- Dokumentenliste – Dokumentationsdokumente verwalten
- Sprachenliste – Dokumentationssprachen
4.12.1 Dokumentationsübersicht
Diese Ansicht dient zur Verwaltung von technischen Dokumentationen und Handbüchern, die im System zentral gepflegt werden – z. B. für Benutzerinformationen, QM-Dokumente, IT-Richtlinien oder Prozesshandbücher.
Schritt 2: Ausführliche technische Dokumentation
🖼️ Screenshot: screenshot_dokumentationskategorie.png
ALT-Text: Verwaltungsansicht für Dokumentationskategorien mit Anzeigeoptionen, Sprachangaben und Änderungsverlauf.
Schritt 1: Tabellarische Übersicht der markierten Elemente
| Nr. | Bezeichnung | Funktionale Beschreibung |
| ① | Anzeigen | Button zur Vorschau der Dokumentation im Lesemodus. |
| ② | Titel | Titel oder Name der jeweiligen Dokumentationskategorie (z. B. „Handbuch 1“). |
| ③ | Sprache | Sprache, in der die Dokumentation verfasst ist (z. B. Deutsch, Englisch). |
| ④ | erstellt | Datum und Uhrzeit der Erstellung des Dokuments. |
| ⑤ | aktualisiert | Letzter Änderungszeitpunkt der Dokumentation. |
| ⑥ | Seiten | Anzahl der enthaltenen Seiten in der Dokumentation. |
| ⑦ | Aktionen | Kontextmenü zur Bearbeitung, Export oder Löschung der Dokumentation. |
🔄 Typische Nutzungsszenarien und Abläufe
- Erstellung und Pflege von Handbüchern: Neue Dokumentationen werden über diese Oberfläche erstellt und versioniert.
- Mehrsprachige Dokumentation: Durch die Sprachangabe (③) lassen sich Dokumente zielgruppengerecht bereitstellen.
- Änderungskontrolle: Mit Erstellt (④) und Aktualisiert (⑤) wird der Änderungsverlauf dokumentiert – wichtig für Audits und Nachvollziehbarkeit.
- PDF-Export: Markierte Einträge können gesammelt über den Button „Markierte als PDF exportieren“ ausgegeben werden.
- Zugriff auf Inhalte: Über den Button in der Spalte Anzeigen (①) kann die Vorschau direkt geöffnet werden.
⚙️ Funktionale und technische Hinweise
- Die Dokumentationen bestehen aus einer oder mehreren Seiten (⑥) und werden zentral verwaltet.
- Über das Aktionsmenü (⑦) lassen sich je nach Rechtevergabe Bearbeitungen oder Exporte durchführen.
- Systemseitig ist eine Exportfunktion nach PDF eingebaut, ideal zur Weitergabe oder Archivierung.
- Das Filter- und Suchsystem oberhalb jeder Spalte erleichtert das Auffinden bestimmter Dokumente bei wachsendem Umfang.
4.12.2 Seitenliste
Diese Ansicht dient der Verwaltung einzelner Kapitel, die zu einer oder mehreren technischen Dokumentationen gehören. Sie ermöglicht eine strukturierte Gliederung großer Inhalte in einzelne, versionierbare Einheiten.
Schritt 2: Ausführliche technische Dokumentation
🖼️ Screenshot: screenshot_kapitel_verwalten.png
ALT-Text: Verwaltungsübersicht für Kapitel innerhalb von Dokumentationen mit Titel, Zeitstempeln und Sprachfilter.
Schritt 1: Tabellarische Übersicht der markierten Elemente
| Nr. | Bezeichnung | Funktionale Beschreibung |
| ① | Anzeigen | Vorschau-Button zur Ansicht des Kapitelinhalts im Lesemodus. |
| ② | Titel | Titel oder Überschrift des Kapitels innerhalb der Dokumentation. |
| ③ | Dokumentationen | Zugehörige Dokumentation, zu der das Kapitel gehört (z. B. „IT-Handbuch“). |
| ④ | erstellt | Erstellungsdatum und Uhrzeit des Kapitels. |
| ⑤ | aktualisiert | Letzter Bearbeitungszeitpunkt des Kapitels. |
| ⑥ | Sprache | Sprache, in der das Kapitel verfasst ist (z. B. „de“ = Deutsch). |
| ⑦ | Aktionen | Menü zur Bearbeitung, Löschung oder weiteren Optionen des Kapitels. |
🔄 Typische Nutzungsszenarien und Abläufe
- Pflege modularer Inhalte: Kapitel werden getrennt angelegt, um Inhalte modular verwalten, versionieren und wiederverwenden zu können.
- Mehrsprachige Handbücher: Über das Feld Sprache (⑥) kann gezielt nach Sprachversionen gefiltert oder exportiert werden.
- Bearbeitung & Vorschau: Kapitelinhalte lassen sich über das Aktionsmenü (⑦) bearbeiten und über das Vorschau-Icon (①) live anzeigen.
- Versionierung und Historie: Die Spalten erstellt (④) und aktualisiert (⑤) unterstützen die Dokumentationsnachverfolgung – z. B. für Audit-Zwecke.
- Zugehörigkeit: Über die Spalte Dokumentationen (③) ist direkt ersichtlich, welchem Handbuch das Kapitel zugeordnet ist.
⚙️ Funktionale und technische Hinweise
- Ein Kapitel muss eindeutig einem Handbuch zugeordnet sein, ist aber intern als eigenständige Einheit pflegbar.
- Kapitel mit identischem Titel in verschiedenen Sprachen (z. B. „Maintenance“ / „Wartung“) können durch das Sprachfeld differenziert werden.
- Die Vorschau-Funktion (①) öffnet das Kapitel in einem lesefreundlichen, formatieren Layout.
- Die Auswahloptionen „Markierte löschen“ oder Export als PDF sind systemseitig meist im Dokumentationsmodul integriert.
4.12.3 Neue Seite
Diese Eingabemaske wird genutzt, um Einzelseiten innerhalb einer Dokumentation zu erstellen oder zu bearbeiten. Sie ist Teil eines modularen Dokumentationssystems und ermöglicht die Versionierung, Gliederung und mehrsprachige Bereitstellung von Inhalten.
Schritt 2: Ausführliche technische Dokumentation
🖼️ Screenshot: screenshot_dokumentation_seite_erstellen.png
ALT-Text: Formular zur Erstellung einer neuen Seite innerhalb einer technischen Dokumentation mit Sprachwahl, Titel, Struktur und Inhaltseditor.
Schritt 1: Tabellarische Übersicht der markierten Elemente
| Nr. | Bezeichnung | Funktionale Beschreibung |
| ① | Sprache | Auswahlfeld zur Festlegung der Sprache der Dokumentationsseite. Pflichtfeld. |
| ② | Dokumentationen | Zuweisung der Seite zu einer bestehenden Dokumentation (z. B. „IT-Handbuch“). |
| ③ | gehört zu Seite | Optionale Verknüpfung als Unterseite einer bestehenden Dokumentationsseite (Kapitelstruktur). |
| ④ | Titel | Titel oder Überschrift der Seite. Wird als Navigationseintrag und Seitenkopf verwendet. Pflichtfeld. |
| ⑤ | Inhalt | Editorfeld zur Eingabe und Formatierung des Seiteninhalts (Rich Text mit HTML-/WYSIWYG-Funktion). Pflichtfeld. |
🔄 Typische Nutzungsszenarien und Abläufe
- Seitenpflege in Handbüchern: Administratoren, Fachverantwortliche oder Redakteure erstellen neue Anleitungen, technische Kapitel oder Richtlinienseiten.
- Mehrsprachige Inhalte: Jede Seite kann in mehreren Sprachen angelegt werden – z. B. durch Kombination von Sprache (①) und Titel (④).
- Kapitelstruktur: Über „gehört zu Seite“ (③) lassen sich Seiten hierarchisch gliedern (z. B. „Wartung“ → „Serverwartung“ → „Neustart“).
- WYSIWYG-Inhaltspflege: Der Editor (⑤) ermöglicht formatierte Texte, Tabellen, Bilder und Quellcode-Einbindung – nützlich für strukturierte Anleitungen.
⚙️ Funktionale und technische Hinweise
- Die Felder Titel (④) und Inhalt (⑤) sind Pflichtfelder und müssen sinnvoll befüllt sein, damit die Seite gespeichert werden kann.
- Die Sprache (①) wird im Export und bei der Navigation verwendet – wichtig bei internationalem Rollout oder für Filter.
- Der Editor (⑤) unterstützt HTML, Tabellen, mathematische Formeln und Medien – ideal für technische Dokus.
- Seiten lassen sich später über die Module „Kapitel“ oder „Dokumentationen“ aufrufen, exportieren oder versionieren.
- „gehört zu Seite“ (③) ermöglicht die Erstellung von mehrstufigen Dokumentationsbäumen.
4.12.4 Dokumentenliste
Diese Ansicht dient der Verwaltung von einzelnen Dokumentdateien, die innerhalb einer Dokumentation als Anhang oder ergänzendes Material geführt werden – z. B. technische Anweisungen, Formulare, Richtlinien oder Checklisten.
Schritt 2: Ausführliche technische Dokumentation
🖼️ Screenshot: screenshot_dokumentationsdokumente_verwalten.png
ALT-Text: Verwaltungsübersicht für eigenständige Dokumente innerhalb von Dokumentationen, mit Vorschau, Beschreibung und Erstellerangabe.
Schritt 1: Tabellarische Übersicht der markierten Elemente
| Nr. | Bezeichnung | Funktionale Beschreibung |
| ① | Anzeigen | Vorschau-Button zur Ansicht des Dokuments im Lesemodus. |
| ② | Name | Bezeichnung des Dokuments (z. B. „Anweisung_1“). |
| ③ | Beschreibung | Kurzbeschreibung oder erklärender Text zum Dokument. |
| ④ | Ersteller | Name oder Rolle der Person, die das Dokument angelegt hat. |
| ⑤ | erstellt | Datum und Uhrzeit der Dokumenterstellung. |
| ⑥ | aktualisiert | Datum der letzten Änderung (falls vorhanden). |
| ⑦ | Dokumentationen | Zugehörige Dokumentation, in der das Dokument eingebunden ist (z. B. „IT-Handbuch“). |
| ⑧ | Aktionen | Menü zur Bearbeitung, Löschung oder Verwaltung des Dokuments. |