Richtlinien für die Dokumentation in diesem Wiki:
Einteilung#
Die Dokumentation ist in vier Rubriken oder Handbücher eingeteilt:
- für Nutzer_innen
- für Administrator_innen
- für Entscheider_innen
- Prozessdokumentation
Handbuch für Nutzer_innen#
Das Handbuch für Nutzenden erklärt auf den einzelnen Unterseiten, wie die verschiedenen Teile der Softwarelösung zu benutzen sind. Es gibt also z.B. eine Seite für das Anmelde-Modul, eine Seite für Mastodon, eine Seite für Nextcloud usw…
Bei ausführlicheren Informationen können mehrere Unterseiten erstellt werden.
Die Seiten für Nutzende haben kein Prefix im Seitennamen.
Handbuch für Administrator_innen#
Das Handbuch für Operatorinnen und Administratoren erklärt auf den einzelnen Unterseiten, wie die verschiedenen Teile der Softwarelösung aufgesetzt, in Betrieb genommen und gewartet werden. Es gibt Unterseiten für die entsprechenden Bestandteil der Software, z.B. für das Identity-Management, für Mastodon, die Integration via LDAP und SSO usw.
Bei ausführlicheren Informationen können mehrere Unterseiten erstellt werden.
Die Seiten für Administrator_innen tragen immer das Prefix "Admin" im Seitennamen.
Handbuch für Entscheider_innen#
Das Handbuch für Entscheider_innen legt Argumente, Abwägungsgründe und Faktoren vor, die für die Nutzung der Softwarelösung sprechen und bei der Nutzung der Lösung zu bedenken sind.
Ein Struktur für die unterschiedlichen Seiten ist bisher nicht vorgegeben.
Alle Seitennamen in diesem Handbuch sollten das Prefix "Stakeholder" tragen.
Prozessdokumentation#
Dieses Handbuch nutzen die Entwicklerinnen und Entwickler, um den Entwicklungs- und Dokumentationsprozess zu dokumentieren und organisieren.
Alle Seitennamen in diesem Handbuch tragen das Prefix "Process".
Lizenzen und Quellen#
Alle Inhalte sind selbst zu produzieren. Externe Quellen können dann verwendet werden, wenn sie unter einer CC(-BY-SA)-Lizenz freigegeben sind. Andere Quellen sind als solche zu kennzeichnen und sind nur im Rahmen üblicher Zitation zu verwenden.
Alle eingestellten Inhalten stellen die Autor_innen unter CC-BY-SA 4.0 zur Verfügung. Eigene Texte können durch Ergänzung eines Autornamens am Seitenende kenntlich gemacht werden, wenn gewünscht.
