Kategorien
opensource software

How2Help OpenSource Teil 2: Wikis

Der zweite Teil der Reihe How2Help OpenSource wird das Thema Wikis etwas näher beleuchten und zeigen man die ersten Klippen beim schreiben eines Artikels umschifft.

Warum?

Wikis sind Gang und Gebe im modernen Internet und bieten sowohl die Möglichkeit öffentliche als auch, zum Beispiel, firmeninterne Wissensdatenbanken zu erstellen. Ein Vorteil eines Wiki besteht darin, dass im Prinzip jeder dazu beitragen kann, diese Datenbanken zu erweitern. Dies wird zum einen dadurch ermöglicht, dass zum Hinzufügen oder ergänzen eines Artikels kaum Programmierkenntnisse benötigt werden. Jede Wiki-Software verfügt über eine Art Auszeichnungssprache, mit der die Formatierung des Textes von statten geht und die meist relativ schnell und leicht zu erlernen ist.

Um diese Datenbanken zu füllen wird aber schlichtweg Manpower gebraucht, die eine Einzelperson oder eine kleine Gruppe nur selten Aufbringen kann. Aber dafür gibt es ja die Communities rund um die Projekte, die durch die Mitarbeit am Wiki, auch ohne Programmierkenntnisse aktiv am Fortschritt des Projektes Anteil haben kann.

Wie?

Der einfachste Start in einen Wiki-Artikel ist sicherlich der, wenn man gerade selbst etwas erfolgreich auf dem eigenen Rechner installiert oder eingerichtet hat. Dann sollte man sich nicht scheuen das eigene Vorgehen festzuhalten und anderen zur Verfügung stellen.

Dazu ist es natürlich nötig das eigene Vorgehen genau zu protokollieren und so wiederzugeben, dass es auch von weniger erfahrenen Nutzern nachvollzogen werden kann.

Allerdings sollte man dabei einige Regularien nicht außer Acht lassen:

  • Das Vorgehen planen: Wenn man einige Vorüberlegungen zum bevorstehenden Artikel macht, fällt das schreiben meist leichter und man landet nicht so leicht in einer Sackgasse.
  • Immer nur ein Thema pro Artikel: Bestes Beispiel sind Kommandozeilen-Programme und eine GUI um dieses grafisch zu bedienen. So sollte für die Installation/Einrichtung des eigentlichen Programmes und der GUI jeweils ein eigener Eintrag ins Wiki erfolgen.
  • Am Anfang des Artikels sollte man die Voraussetzungen zur Durchführung der im Beitrag Schritte auflisten. Dies können sowohl Anforderungen an Hardware oder Software als auch an die Kenntnisse des Lesers sein.
  • Keinen Roman schreiben. Kurze, knappe, aber trotzdem verständliche Anweisungen sind vorzuziehen.

Natürlich gibt es je nach dem in welchem Wiki man sich betätigt, noch einiges mehr an Regeln und Vorschriften, wie der fertige Artikel auszusehen hat. Deshalb sollte man sich die Konventionen des Wikis zu dem man beitragen möchte genau ansehen und falls Unklarheiten (auch während dem Schreiben) auftauchen nicht scheuen die Betreiber um Rat zu fragen.

Schwierigkeiten:

Da es leider noch keinen allgemein anerkannten Standard für die sogenannte Wiki-Syntax gibt, also die Befehle mit denen man den Text formatiert, gibt, unterscheiden sich die Befehle von Wiki-System zu Wiki-System. Größtenteils bieten die Systeme aber WYSIWYG-Editoren, die die wichtigsten Funktionen per Klick zur Verfügung stellt. Die Hürde zum Einstieg ist also generell relativ niedrig und auch Laien sollten nach kurzer Zeit ansprechende Ergebnisse erzielen können.

Wo?

Wikis gibt es mittlerweile wie Sand am Meer. Fast jedes OpenSource-Projekt verfügt über ein angeschlossenes Wiki, das oft als Sammlung für die Dokumentation der Software dient. Aber auch Exoten gibt es, so zum Beispiel Wikia Search, eine Suchmaschine, die auf dem Prinzip eines Wikis beruht.

Für den Start, hier ein paar Wikis zum stöbern:

Natürlich sind das nur ein paar Beispiele, jede Menge mehr Wikis warten draußen im Internet auf eure Mitarbeit.

Mehrwert?

Der Mehrwert eines Wikis sollte eigentlich klar sein. Erstens als Training für euch selbst, zweitens als Spickzettel für spätere Aufgaben und drittens helft ihr natürlich dabei neuen Nutzern den Einstieg in die OpenSource Welt so einfach wie möglich zu machen. Die Dokumentation einer Software verschlingt Unmengen an Zeit, die gerade kleine OS-Projekte nicht immer alleine aufbringen können. Also, lasst andere an euren Erfolgen und eurem Wissen teilhaben und meldet euch noch heute bei eurem favorisierten Wiki an 🙂