Wissensdokumentation: Unterschied zwischen den Versionen
Aus lugvswiki
Zur Navigation springenZur Suche springenUlf (Diskussion | Beiträge) K (ref tag gefixt) |
(→Effiziente Wissensdokumentation in der IT: Schreibefehler, kleine Ergänzungen/) |
||
| Zeile 3: | Zeile 3: | ||
= Effiziente Wissensdokumentation in der IT = | = Effiziente Wissensdokumentation in der IT = | ||
Version: 1.2 | Version: 1.2 | ||
| − | Von: | + | <!--Wissensdokumentation effizient, Abläufe dokumentieren, Notizen wiederfinden, |
| + | Von: Ulf 22:30, 22. Apr. 2024 (CEST) (basieren auf v1.1 von plocki <ref>[https://plocki.org/blog/diverses/wissensdoku-draft.html Wissensdokumentation v1.1] von plocki (Datum=19.04.2024)</ref> sowie der Videoaufzeichnung des Vortrags<ref>[https://tube.sp-codes.de/w/xsZAC4H8LC4i1xPuSFhvYP LUG-VS PeerTube] (Datum=19.04.2024)</ref> | ||
| Zeile 19: | Zeile 20: | ||
* Einleitung / Überblick | * Einleitung / Überblick | ||
* Hauptteil | * Hauptteil | ||
| − | * | + | * Schluss / Referenzen, hilfreiche Quellen (Links mit Datum des letzten Aufruf) |
| Zeile 25: | Zeile 26: | ||
== Einleitung / Motivation == | == Einleitung / Motivation == | ||
| − | Zunächst sollte man sich | + | Zunächst sollte man sich folgende Fragen stellen: |
* Was wird erklärt? Was ist das Ziel? | * Was wird erklärt? Was ist das Ziel? | ||
* Welche Methodik wurde wie angewendet? | * Welche Methodik wurde wie angewendet? | ||
| − | Dieses Dokument beschreibt allgemeine Grundlagen, wie eigenes Wissen, Problemlösungen | + | Dieses Dokument beschreibt allgemeine Grundlagen, wie eigenes Wissen, Problemlösungen und seltene Abläufe sinnvoll dokumentiert werden können. Beispielhaft wird auf die Dokumentation in unserem LUG-VS Wiki eingegangen, ohne in die Details der Wiki-Syntax einzugehen. |
| Zeile 38: | Zeile 39: | ||
* Hauptsätze sind gut! | * Hauptsätze sind gut! | ||
* Beim Thema bleiben: "Doku erstellen". NICHT Wiki Syntax | * Beim Thema bleiben: "Doku erstellen". NICHT Wiki Syntax | ||
| − | * Bilder, Tabellen, | + | * Bilder, Tabellen, Stichworte, Fußnoten… sinnvoll einsetzten |
* technischen/komplizierte Themen exakt formulieren | * technischen/komplizierte Themen exakt formulieren | ||
* Codebeispiele minimal beschrieben | * Codebeispiele minimal beschrieben | ||
| Zeile 58: | Zeile 59: | ||
# Für jeden, jederzeit gut erreichbar, sofern eine Internetverbindung (notfalls mit einem Zweitgerät) besteht | # Für jeden, jederzeit gut erreichbar, sofern eine Internetverbindung (notfalls mit einem Zweitgerät) besteht | ||
# Keine besondere Hardware oder Software erforderlich | # Keine besondere Hardware oder Software erforderlich | ||
| − | # Zugang für LUG-VS bekannte Personen einfach verfügbar (muss nur bei Ulf angefordert werden) | + | # Zugang für LUG-VS-bekannte Personen einfach verfügbar (muss nur bei Ulf angefordert werden) |
# Struktur vorgegeben | # Struktur vorgegeben | ||
# Integration von Bildern und Dokumenten möglich | # Integration von Bildern und Dokumenten möglich | ||
| − | # Dokumente werden automatisch | + | # Die Versionen der Dokumente werden automatisch verwaltet (also man kann sich ältere Stände wieder anschauen, obwohl man selber oder jemand anderes Informationen verändert oder entfernt hat) |
| − | # | + | # Dokument-Ersteller / -Bearbeiter mit Zugang können die Dokumentation erweitern, ergänzen oder aktualisieren |
| − | # Daten werden in der Regel von den | + | # Daten werden in der Regel von den zuständigen Serveradmins regelmäßig gesichert |
| Zeile 82: | Zeile 83: | ||
| − | == Schluß / Fazit / Quellen== | + | == Schluß / Fazit / Quellen == |
* Qualität der Links prüfen | * Qualität der Links prüfen | ||
| Zeile 89: | Zeile 90: | ||
* … | * … | ||
| − | Beispiel aus dem [https://wiki.ubuntuusers.de/ls/ ls im Ubuntu-Wiki]: | + | Beispiel aus dem [https://wiki.ubuntuusers.de/ls/ Konsolenbefehl '''ls'' im Ubuntu-Wiki] (ls = list = auflisten: |
Version vom 22. April 2024, 23:31 Uhr
Diese Seite behandelt Grundlegende Themen die Einsteigern zu Internetfähigen Geräten und PCs dazu dienen soll sich mit dem Linux basierten System zurechtzufinden und selbständig Probleme zu lösen.
Effiziente Wissensdokumentation in der IT
Version: 1.2
