Wiki¶
Das integrierte Dokumentationssystem (Wiki) dient der zentralen Verwaltung technischer Dokumentationen und Handbuecher -- z. B. fuer Benutzerinformationen, QM-Dokumente, IT-Richtlinien oder Prozesshandbuecher. Es umfasst fuenf Teilbereiche:
- Dokumentationsuebersicht -- Verwaltung von Dokumentationskategorien
- Seitenliste -- Verwaltung einzelner Kapitel
- Neue Seite -- Erstellung neuer Dokumentationsseiten
- Dokumentenliste -- Verwaltung von Dokumentdateien
- Sprachenliste -- Verwaltung der Dokumentationssprachen
Dokumentationsuebersicht¶
Die Uebersicht zeigt alle im System gepflegten Dokumentationen mit Titel, Sprache, Erstellungsdatum, letztem Aenderungszeitpunkt und Seitenzahl.
| Spalte | Beschreibung |
|---|---|
| Anzeigen | Vorschau der Dokumentation im Lesemodus |
| Titel | Name der Dokumentationskategorie (z. B. „Handbuch 1") |
| Sprache | Sprache der Dokumentation (z. B. Deutsch, Englisch) |
| erstellt | Erstellungszeitpunkt |
| aktualisiert | Letzter Aenderungszeitpunkt |
| Seiten | Anzahl der enthaltenen Seiten |
Ueber das Aktionsmenue lassen sich Dokumentationen bearbeiten, exportieren oder loeschen. Markierte Eintraege koennen gesammelt als PDF exportiert werden.
Seitenliste (Kapitel)¶
Die Seitenliste verwaltet einzelne Kapitel, die zu Dokumentationen gehoeren. Kapitel sind eigenstaendige, versionierbare Einheiten, die einer Dokumentation zugeordnet werden.
| Spalte | Beschreibung |
|---|---|
| Anzeigen | Vorschau des Kapitelinhalts im Lesemodus |
| Titel | Ueberschrift des Kapitels |
| Dokumentationen | Zugehoerige Dokumentation (z. B. „IT-Handbuch") |
| erstellt | Erstellungsdatum |
| aktualisiert | Letzter Bearbeitungszeitpunkt |
| Sprache | Sprache des Kapitels (z. B. „de" fuer Deutsch) |
Kapitel mit identischem Titel in verschiedenen Sprachen koennen durch das Sprachfeld differenziert werden. Die Vorschau-Funktion oeffnet das Kapitel in einem lesefreundlichen Layout.
Neue Seite¶
Das Formular zur Seitenerstellung ermoeglicht die Anlage von Einzelseiten innerhalb einer Dokumentation.
| Feld | Beschreibung | Pflicht |
|---|---|---|
| Sprache | Festlegung der Sprache der Dokumentationsseite | Ja |
| Dokumentationen | Zuweisung zu einer bestehenden Dokumentation | Nein |
| gehoert zu Seite | Optionale Verknuepfung als Unterseite (Kapitelstruktur) | Nein |
| Titel | Ueberschrift der Seite, verwendet als Navigationseintrag und Seitenkopf | Ja |
| Inhalt | Editorfeld mit Rich-Text- und HTML-Unterstuetzung | Ja |
Ueber das Feld „gehoert zu Seite" lassen sich Seiten hierarchisch gliedern und mehrstufige Dokumentationsbaeume erstellen. Der Editor unterstuetzt formatierte Texte, Tabellen, Bilder und Quellcode-Einbindung.
Dokumentenliste¶
Die Dokumentenliste verwaltet einzelne Dokumentdateien, die als Anhang oder ergaenzendes Material innerhalb einer Dokumentation gefuehrt werden -- z. B. technische Anweisungen, Formulare oder Checklisten.
| Spalte | Beschreibung |
|---|---|
| Anzeigen | Vorschau oder Download des Dokuments |
| Name | Bezeichnung des Dokuments |
| Beschreibung | Erklaerung oder Zusatztext zum Dokument |
| Ersteller | Person, die das Dokument angelegt hat |
| erstellt | Erstellungsdatum |
| aktualisiert | Datum der letzten Aenderung |
| Dokumentationen | Zugehoerige Dokumentation |
Ueber das Aktionsmenue koennen Dokumente bearbeitet, geloescht oder exportiert werden (z. B. als PDF oder ZIP). Eine Funktion „Dokument hinzufuegen" ermoeglicht das manuelle Hochladen und Kategorisieren neuer Dokumente.
Sprachenliste¶
Die Sprachenverwaltung definiert die verfuegbaren Dokumentationssprachen im System.
| Spalte | Beschreibung |
|---|---|
| Code | Sprachkuerzel nach ISO 639-1 (z. B. „de", „en") |
| Name | Englische Bezeichnung der Sprache (z. B. „German") |
| Familienname | Lokalisierte Sprachbezeichnung (z. B. „Deutsch") |
Neue Sprachcodes koennen hinzugefuegt werden, um Inhalte in zusaetzlichen Sprachen zu pflegen. Das Loeschen einer Sprache ist nur moeglich, wenn keine Seiten, Kapitel oder Dokumente mit dieser Sprache existieren.
Hinweis
Die Codes muessen systemweit eindeutig sein und folgen dem ISO 639-1 Standard. Die Spalte „Familienname" wird in Benutzeroberflaechen, Exportdateien und PDF-Titeln angezeigt.