Gestaltung von Wiki-Artikeln

Aus ITWiki
Zur Navigation springen Zur Suche springen

Dies ist eine Beispielseite, um zu zeigen, wie die Seiten einer Wiki nach unseren Qualitiätskriterien aussehen sollen. In der Regel fängt man als erstes mit einer Einleitung an, so wie diese. Eine Einleitung soll das Wichtigste über das Thema enthalten. Wichtige Begriffe oder Ausdrücke sollten in kursiv geschrieben sein. Manche Überschriften sind verlinkt, um auf die Seite "Wiki-Artikel erstellen" zurückzukehren und auf die entsprechenden Abschnitte und Kapitel zu springen.

1 Abschnitte, Kapiteln und Unterkapiteln

Diese Überschrift dient vor allem als Kennzeichnung für einen Abschnitt in einer Seite. Das dient später als Gliederung, da die Wiki automatisch ein Inhaltsverzeichnis vor dem ersten Abschnitt erstellt. Eine Überschrift ist übrigens ein Schlagwort, kein Text!

1.1 Kapitel

Diese Überschrift dient als Kennzeichnung für ein Kapitel unter einem Abschnitt. Kapiteln sollten dann angelegt werden, wenn ein Abschnitt zu groß ist. Es ist übrigens wünschenswert, möglichst kurz und knapp seine Informationen reinzuschreiben. Einen ganzen Roman zu erstellen, ist nicht empfehlenswert.

1.1.1 Unterkapitel

Diese Überschrift dient als Kennzeichnung für ein Unterkapitel. Unterkapitel sollten nur so wenig wie möglich eingesetzt werden, da darunter die Lesequalität leidet. Übrigens sind Überschriften schon formatiert; sie mit extra Formatierungen zu versehen ist nicht.

2 Texte und Listen

2.1 Texte schreiben und formatieren

Texte sollen nur möglichst wenig formatiert sein. Die wichtigsten Begriffe oder Anmerkungen sollen kursiv geschrieben, fett sollte nur als Warnung dienen. Andere Formatierungen sind unerwünscht.

Zusammengefasst:

  • Halte dich kurz mit deinen Texten, schreibe keine Romane.
  • Bei Formatierungen gilt: So viel wie nötig, so wenig wie möglich.

Eine Ausnahme bilden dabei die Befehlseingaben und Befehlsausgaben einer Shell. Will man eine Eingabe oder eine Ausgabe deutlich kennzeichnen, so muss am Anfang einer Zeile ein Leerzeichen einfügen. Der Befehl zum Löschen von Dateien in einem Verzeichnis sieht bspw. so aus:

rm -r [Verzeichnis]

Man sieht, dass durch ein Leerzeichen am Anfang ein Kasten entsteht und dass der Text als Code angezeigt wird. Optionen oder Parameter eines Befehls sollten, wie in der man-Page der Shell, in eckigen Klammern gesetzt werden. Dateien oder Befehle sollten ebenfalls als Code geschrieben werden.

2.2 Listen

  • Es ist übrigens guter Lesestil, Stichpunkte zu nehmen.
  • Man erhält die Punkte, wenn man am Anfang jeder Zeile ein * einsetzt.
  • So erhalten die Leser einen guten Überblick.
  • Allerdings sollten möglichst wenige Stichpunkte verwendet werden. Maximal sollte man 5-6 Punkte verwenden.

  1. Nummerierungslisten haben statt einen * ein # vor jeder Zeile.
  2. Damit erhält man statt Punkte eine Zahl.
  3. Diese Listen sind vor allem als Schritt-für-Schritt-Anweisungen zu verstehen.
  4. Wie bei normalen Listen gilt: Nicht allzu viele Schritte verwenden.

3 Links

Eine gute Wiki ist nur dann gut, wenn die Artikel mit anderen Artikel oder Seiten verlinkt sind. Je mehr Artikel miteinander verlinkt sind, desto besser. Natürlich sollten diese sinnvoll und mit Bedacht angelegt werden; sie sollten thematisch zueinander passen.

Dieser Artikel bspw. ist eng mit dem Artikel "Wiki-Artikel erstellen" verwoben.

3.1 Interne Links

Als interner Link wird ein Link bezeichnet, der mit einer anderen Seite aus dieser Wiki verbunden ist. Man kann auch eine Seite mit einer Kategorieseite verlinken; vornehmlich soll der Link zu einer Kategorieseite am Ende gesetzt werden.

3.2 Externe Links

Externe Links sind Links auf Webseiten. Sie sind notwendig, um die Quelle der Inhalte einer Seite zu überprüfen.