Vorgaben für Wiki-Autoren

Vorgaben für Wiki-Autoren

Damit sich der Leser auf den Wiki-Seiten gut und schnell zurechtfindet, sind einige Dinge zu beachten, welche die Orientierung auf der Seite und innerhalb des Artikels begünstigen. Hierzu zählt, dass die Artikel wie aus einem Guss wirken und sich an gleiche Konventionen und Notationen halten. Dies erleichtert auch die Arbeit an den Artikeln, wenn diese von verschiedenen Autoren bearbeitet werden.

Die Musterseite für Wiki-Autoren soll helfen, die hier beschriebenen Vorgaben schneller umsetzen zu können. Auf der Musterseite finden sich typischen Bausteinen, die in einem Artikel verwendet werden. Sie dient dem Wiki-Autor als Referenz, welche Befehle in der Auszeichnungssprache gesetzt werden müssen, damit ein Effekt realisiert werden kann. So kann der Wiki-Autor in der Ansichtsversion ein Element heraussuchen und in der Bearbeitungsversion die verwendete Syntax verstehen lernen.

Zielgruppe berücksichtigen

Es ist davon auszugehen, dass vor allem Anfänger und unerfahrene Programmnutzer das Wiki aufsuchen. Die Artikel sollten deshalb inhaltlich so aufgebaut sein, dass sie umfangreiche und vollständige Informationen liefern die von Screenshots begleitet werden. Das Augenmerk sollte auf der genauen Beschreibung der Inhalte und die exakte Verwendung von Begriffen liegen.

Organisation und Layout

Artikel sollen nicht auf andere Unterseiten verlinken, also nicht künstlich zergliedert werden. Verlinkungen sorgen dafür, dass der Leser die Orientierung verliert. Dies ist auch der Grund, weshalb moderne Internetseiten von verschachtelten Menüs absehen und auf ein One-Page-Design setzen. Der Wiki-Leser soll aus der Artikelübersicht einen Artikel aufrufen können um anschließend mit dem Back-Button des Browsers wieder in die Übersicht zurückkehren zu können. Ein Artikel soll alle relevanten Informationen enthalten, so dass man diese Informationen auch in einem Rutsch lesen und drucken kann.

Tabellenstrukturen sollen vermieden werden, da sie den Browser daran hindern, eine responsive Anzeige zu generieren. Es sollen nur Formatierungen verwendet werden, welche das MediaWiki anbietet. Hierdurch werden HTML- und CSS-Tags vermieden, wodurch die Überarbeitung eines Artikels durch andere Autoren erleichtert wird. Bei manchen Formatierungen geht jedoch kein Weg an HTML- oder CSS-Tags vorbei.

Einbinden von Bildern und Dateien

Eingebundene Bilder sollen logisch benannt werden. Bei der Benennung ist darauf zu achten, dass keine Sonderzeichen oder Umlaute genutzt werden. Der Name der Bilddatei sollte alle wesentlichen Informationen enthalten. So sollte z.B. ein Bild zur Erläuterung einer Menüfunktion nach folgendem Schema benannt sein:

Programm_Reitername_Menuename_Bildname.png

Beispiel: Schild_Verwaltung_Import_Auswahlfenster.png

Das bevorzugte Bildformat von Screenshots sollte png sein, da es die beste Kompression für Screenshots bietet. Die Bilder sollten als Bildvorschau (Thumbnail) rechts im Fließtext so eingebunden werden, dass die Größe ausreicht, Informationen zu erkennen. Erst ein Klick auf das Bild führt zu einer Vergrößerung. Die Bilder Vorschaubilder sollen einen Rahmen und einen Untertitel tragen.

Verwenden von Kategorien

Die Wiki-Artikel sollen kategorisiert werden. Damit lassen sich mit Hilfe der Kategorie-Übersichtseiten relevante Artikel schneller finden. Ein Artikel kann mehreren Kategorien angehören. So kann ein Artikel die Kategorien "SchILD-NRW", "Karteireiter Verwaltung" und "Import" haben. Ein Artikel wird kategorisiert, indem ein Kategorie-Tag oder mehrere Kategorie-Tags am Ende des Artikels angefügt werden. Die Kategorie "SchILD-NRW" wird zum Beispiel durch den Tag [[Kategorie:SchILD-NRW]] zugeordnet. Wird ein Kategorie-Tag benutzt, für den es noch keine Kategorie gibt, legt das MediaWiki automatisch eine Kategorie an. Bei der Verwendung der Kategorien ist unbedingt auf Groß- und Kleinschreibung zu achten, ansonsten werden unterschiedliche Kategorien angelegt. Eine Übersicht über alle schon verwendeten Kategorien findet man unter dem Menüpunkt Spezialseiten > Rubrik Seitenlisten > Kategorien. Im Hauptmenü findet sich ein Direktlink in der Rubrik MediaWiki.

Verwenden von Vorlagen

Manchmal möchte man in einem Artikel einen farblich hervorgehobenen Hinweis oder ähnliches geben. Hierzu gibt es einige Vorlagen, von denen gerne Gebrauch gemacht werden soll. Eine Übersicht über die Vorhandenen Vorlagen findet man unter dem Menüpunkt Spezialseiten > Rubrik Seitenlisten > Kategorien > Vorlage.