Wissensdokumentation v1.1

Wissensdokumentation v1.1

19 April 2024

Hilfreich zum Verständnis dieses Artikels:

Eine mögliche, allgemeine Struktur eines Artikels:

* Titel/Überschrift
* Datum!
* Voraussetzungen, falls erforderlich
* Einleitung / Überblick
* Hauptteil
* Schluß / Referenzen, hilfreiche Quellen (Links mit Datum des letzten Aufruf)

Einleitung / Motivation

* Was wird erklärt? Was ist das Ziel?
* Welche Methodik wurde wie angewendet?

Dieses Dokument beschreibt allgemeine Grundlagen, wie eigenes Wissen, Problemlösungen, seltene Abläufe sinnvoll dokumentiet werden können. Beispielhaft wird auf die Dokumentation in unserem LUG-VS Wiki eingegangen, ohne in die Details der Wikisystax einzugehen.

Hauptteil

* Sinnvolle Struktur wählen
* Vom Allgemeinen zum Speziellen (ggf. mit konkreten Beispielen abschließen)
* Hauptsätze sind gut!
* Beim Thema bleiben: "Doku erstellen". NICHT Wiki Syntax
* Bilder, Tabellen, Sichworte, Fußnoten…​ sinnvoll einsetzten
* technischen/komplizierte Themen exakt formulieren
* Codebeispiele minimal beschrieben
* Abkürzungen erläutern (ggf. Abkürzungsverzeichnis erstellen)
* …​

Allgemein: Speicherorte und Formate

Bei der Wahl des Speicherorts bzw. des Speicherformates, sollte man folgende Anforderungen beachten:

  • Wie finde ich die Information einfach wieder (Stichpunktsuche, chronologische Suche, …​) (siehe auch Informationsbeschaffung)

  • Wo kann ich die Dokumente gut wiederfinden, selbst wenn mein PC / Notebook gerade nicht mehr funktioniert oder ich keinen Zugriff mehr habe?

  • Falls es sich nicht aus der Auswahl des Ortes ergibt, in welchen Format speichere ich die Daten (dass sie eben auch einfach durchsuchbar sind)?

  • Sollen die Informationen für Andere zur Verfügung stehen (bedingt, dass keine sensiblen Daten in der Dokumentation vorhanden sind)?

Beispiel: Ablage im Internet in unserem LUG-VS-Wiki [1]

Für die Ablage der Dokumente im Internet und insbesondere in unserem LUG-VS-Wiki, spricht:

  • Für jeden, jederzeit gut erreichbar, sofern eine Internetverbindung (notfalls mit einem Zweitgerät) besteht

  • Keine besondere Hardware oder Software erforderlich

  • Zugang für LUG-VS bekannte Personen einfach verfügbar (muss nur bei Ulf angefordert werden)

  • Struktur vorgegeben

  • Integration von Bildern und Dokumenten möglich

  • Dokumente werden automatisch versionsverwaltet (also man kann sich ältere Stände wieder anschauen, obwohl man selber oder jemand anderes Informationen verändert oder entfernt hat)

  • Andere mit Zugang können die Dokumentation erweitern oder ergänzen

  • Daten werden in der Regel von uns (Serveradmins) regelmäßig gesichert

Dagegen spricht:

  • Oben genannte Vorteile sind teilweise auch Nachteile (insbesondere der allgemeine Zugriff)

  • Man muss sich in die Formatierung des Wikis erst einarbeiten

Beispiele für Alternativen

  • Markdown, Asciidoc, usw

  • Webseiten-Blog

  • (Online)Office

  • Git-Wiki

  • …​

Schluß / Fazit / Quellen

* Qualität der Links prüfen
* Links mit Datum des letzten Aufrufs versehen
* ggf. weiterführende Themen verlinken
* …​

Beispiel aus dem Ubuntu-Wiki: https://wiki.ubuntuusers.de/ls/

Quellenangaben:
* https://lug-vs.org/lugvswiki/index.php/Wissensdokumentation [1]+