Thema¶

Wikiartikel sollen bevorzugt Themen behandeln, die spezifisch für Ubuntu und seine Derivate sind.

Es gibt viele hervorragende spezialisierte Wikis im Netz. So schön ein wachsendes ubuntuusers-Wiki auch ist – manche Themen sind anderswo besser aufgehoben. Dies gilt für Themen, die nicht für Ubuntu spezifisch sind, sondern beispielsweise auf Linux im Allgemeinen oder Spielen unter Wine anwendbar sind, wenn an anderer Stelle im Netz bereits eine deutschsprachige Seite hoher Qualität besteht.

Gute Wikis mit allgemeinen oder speziellen Themen findet man im WikiIndex

Beschränkung auf das Kernthema¶

Jeder Artikel sollte nur ein Thema behandeln, das aber dafür gut und möglichst vollständig.

Zur Erklärung soll ein Beispiel dienen: In vielen Artikeln wird an irgendeinem Punkt Software installiert. Würde man diese Softwareinstallation nun im Artikel selbst erklären, wäre dieser entweder schrecklich lang oder die Erklärung stark verkürzt. Die Installation von Paketen wird deshalb besser in einem eigenen Artikel behandelt. Dieser Artikel existiert natürlich längst. Aber auch wenn zu einem Teilaspekt des geplanten Artikels noch keine eigene Anleitung vorhanden ist, sollte man über eine Aufteilung nachdenken. Faustregel: Wenn es denkbar ist, dass der fragliche Teilaspekt auch für andere Artikel relevant sein könnte, sollte man ihn auslagern.

Benennung¶

Die endgültigen Seitennamen werden vom Wikiteam festgelegt, wenn die Seite aus der Baustelle (siehe unten) verschoben wird. Dennoch sollte man auch dort schon keine überlangen und komplizierten Namen verwenden. Siehe hierzu auch den Anhang.

Erstellung¶

Neue Wiki-Artikel werden grundsätzlich über die Seite Wikiartikel anlegen erstellt. Der neue Artikel liegt dann in der „Baustelle”. Dies stellt sicher, dass die Benutzer und speziell die Wiki-Moderatoren vor dem Freischalten drüber schauen können.

Bestehende Artikel überarbeiten¶

Möchte man einen bereits bestehenden Artikel im größeren Umfang überarbeiten, wendet man sich mit seinem Anliegen an das Forum Rund ums Wiki. Ein Wiki-Moderator wird dann den Artikel in die Baustelle verschieben und durch eine Kopie ersetzen. Dies sichert die Kontinuität in der Versionsgeschichte des Artikels. Das weitere Vorgehen unterscheidet sich nicht von der Handhabung mit neuen Artikeln.

Kleinere Änderungen, also solche, die schnell gemacht sind, z.B. mit einer Editierung, können direkt im Wiki gemacht werden.

Artikel freischalten¶

Nach der Fertigstellung sollte der Artikel im Wiki-Forum einem größeren Personenkreis bekannt gemacht werden. Benachrichtigungen an einzelne Mitglieder des Wikiteams sind dagegen überflüssig - wir verfolgen ohnehin alle Änderungen im Wiki. Durch den neuen Foreneintrag können nicht nur die Wiki-Moderatoren, sondern auch andere Forenteilnehmer leichter Tipps geben, was zur Vervollständigung des Artikels gegebenenfalls noch fehlt.

Ist der Artikel fertig, d.h. ist der Artikel wiki-konform (erfüllt also die Wiki-Regeln) und es sind keine weiteren Fehler darin, wird er vom Wikiteam bei der nächsten Gelegenheit verschoben.

Verfahren bei verlassenen Baustellen¶

Leider kommt es immer wieder vor, dass ein Artikel voller Elan angefangen wird, dann aber in Vergessenheit gerät. In einem solchen Falle wird der Ursprungsautor vom Wikiteam angeschrieben, und im Diskussionsthread eine Notiz dazu hinterlegt. Wenn innerhalb einer Zeitspanne von 3 Monaten keine Reaktion/Bearbeitung erfolgt, wird die Baustelle gelöscht, oder, wenn erhaltenswerter Inhalt besteht, auf "verlassen" gesetzt, so dass jeder Interessierte sie dann ohne Rückfragen weiterbearbeiten kann.

Verständlichkeit¶

Anleitungen sollten für jeden verständlich sein, der die Einsteiger-Sektion und die im Wissensblock angegebenen Grundlagenartikel gelesen hat.

Ausnahmen sind möglich, wenn der Inhalt der Anleitung eindeutig ausschließlich für Spezialisten von Interesse ist. In diesem Fall ist am Beginn der Anleitung ein Hinweis auf die Zielgruppe und die vorausgesetzten Kenntnisse anzugeben und ggf. die Fortgeschritten-Box zu benutzen.

Inhalt¶

Die Artikel sind mit Inhalt zu füllen. Es genügt nicht zu beschreiben, wie z.B. ein bestimmtes Programm installiert wird. Es sollte auf jeden Fall auf einfache Art und Weise beschrieben werden: Was kann es? Wofür ist es gut? Wie funktioniert es? Wie richte ich es ein? Grundwissen bildet die Basis des Artikels.

Umgangssprache¶

Auf umgangssprachliche Ausdrücke sollte verzichtet werden.

Fachbegriffe¶

Sind deutsche Fachbegriffe gebräuchlich, so sollten diese verwendet werden.

Unsinnige Eindeutschungen sollte man natürlich vermeiden. Im Zweifelsfall gibt die Übersetzung von Ubuntu selbst einen guten Anhaltspunkt - wenn hier beispielsweise von "einbinden" die Rede ist, sollte man im Wiki nicht von "mounten" sprechen. Eine Liste mit falscher und korrekter Verwendung findet man hier: Wiki/Begriffe. Wörter, die auf Fachbegriffe hinweisen oder diese betonen sollen, sind zu vermeiden.

Wahl der Werkzeuge¶

Der Leser soll in der Wahl seiner Werkzeuge nicht unnötig festgelegt werden.

Werkzeuge: das sind Texteditoren, Paketmanagementwerkzeuge, Benutzeroberflächen. Der eine Anwender liebt den Paketmanager aptitude, der andere fürchtet sich vor der Kommandozeile und installiert Programme am liebsten mit "Ubuntu Software Center" im GNOME-Menü, der dritte nutzt KDE und hat diese Möglichkeit zunächst einmal gar nicht, kann dafür aber Adept verwenden.

Alle diese Anwender wollen lediglich ein Paket installieren und nicht irgendein Programm benutzen, das dem Autor einer Anleitung gerade in den Sinn kam. Daher müssen Anleitungen möglichst allgemein gehalten werden. Wenn ein Paket installiert werden muss, sieht das so aus:

Oben im Wissensblock wird ein Link auf den passenden Artikel platziert,

in der Anleitung selbst genügt jetzt eine allgemeine Formulierung.

Die Grundlagenartikel enthalten außerdem Abschnitte für GNOME- und KDE-Nutzer. Unabhängigkeit von der verwendeten Oberfläche sollte in jeder Anleitung angestrebt werden.

GUI vs. Konsole¶

Wenn vorhanden, sollen GUI-Werkzeuge an erster Stelle beschrieben werden.

Einfachheit ist subjektiv. Könner lieben die Kommandozeile wegen ihrer Effizienz und Logik, aber für Einsteiger ist sie weder schnell noch einleuchtend. Daher sind in Wikiartikeln im Zweifelsfall stets GUI-Werkzeuge vorzuziehen. Hinweise auf Shellkommandos oder Konfigurationsdateien gehören dagegen in die "Experten"-Box (s.u.).

Installations-Abschnitt¶

Jeder Artikel - sofern es kein Übersichts- oder Grundlagenartikel ist - soll einen Abschnitt zur Installation des behandelten Programms haben. Die Installation sollte vollständig beschrieben werden, es sollte nicht nur auf eine andere, externe Seite verlinkt werden. Gibt es zusätzlich noch alternative oder weitere Installationsarten, kann hierfür ggf. auf externe Webseiten etc. verwiesen werden.

Pakete vs. Kompilieren¶

Wenn möglich ist die Installation über ein geeignetes Paket dem selber kompilieren vorzuziehen.

Auch hier ist Einfachheit bevorzugt, und das ist unter Ubuntu und dessen moderner Paketverwaltung die Installation von Programmen über fertige Pakete. Gibt es keine fertigen Pakete, so sollte das Selbst-Kompilieren für das Programm beschrieben werden. Gleiches gilt, wenn die Programm-Version in den Paketquellen (stark) veraltet ist oder bekannt Bugs oder fehlende Funktionen hat, die in der neueren Version beseitigt sind.

Ist die Beschreibung für das Kompilieren umfangreicher, z.B. weil zuerst umfangreiche Abhängigkeiten händig aufgelöst werden müssen, weil Make-Files angepasst werden müssen, weil der Quellcode erst gepatcht werden muss etc., so ist die Beschreibung des Kompilierens in einen eigenen Unterartikel auszulagern.

Fremdquellen und -pakete¶

Grundsätzlich sollten Fremdquellen oder Fremdpakete vermieden werden.

Wenn es nicht anders geht, muss zwingend entweder die Warnung für Quellen oder Pakete per

[[Vorlage(Fremd, Paket, "Kommentar")]]

bzw.

[[Vorlage(Fremd, Quelle, "Kommentar")]]

angegeben sein. In der Vergangenheit hat sich gezeigt, dass vor allem bei Upgrades (häufig mit Updates verwechselt) fremde Pakete sehr oft für Ärger sorgen.

Allgemeingültigkeit anstreben¶

Nutzer verschiedener Desktopumgebungen (GNOME/KDE/Xfce etc.) und Programme sollten mit dem Artikel gleichermaßen etwas anfangen können. Dies bedeutet: Verwendete Programme sollten entweder in allgemeiner Form erwähnt werden (IRC-Client, Texteditor, Medienplayer, ...) oder es sollte auf Programme für mehrere Oberflächen hingewiesen werden.

Hintergrundinformationen¶

Hintergrundinformationen dürfen nicht ablenken!

Ein guter Teil der Leser will nicht in erster Linie etwas lernen, sondern etwas erreichen: dass es funktioniert. Es ist gut und wichtig, Hintergrundinformationen für alle Interessierten anzubieten, aber sie sollten nicht aufdringlich im Weg stehen und den Lesefluss stören.

Für allgemeine Hinweise die besonders hervorgehoben werden sollen gibt es die Hinweis-Box. Sie soll sparsam verwendet werden.

Für Hintergrundinformationen gibt es die Experten-Box. Die dort enthaltenen Informationen wenden sich an interessierte Leser und Fachleute, sie sind möglichst knapp zu halten. Diese Box wird meist am Ende eines Abschnitts oder Artikels platziert.

Anrede¶

Direkte Anrede ist zu vermeiden.

Nicht "Du", nicht "Sie", sondern "man" ist richtig. Auch ein "wir" oder "ich" ist nicht gut geeignet!

Inhalt¶

Knapp formulieren. Keine Bekehrungsprosa, sondern Überzeugung durch Inhalt.

Knapp und klar formulierte Artikel sind leichter zu lesen. Niemand will beispielsweise lesen, wie toll und erstaunlich gut ein Programm ist, und wie es zum Brechen des bösen Monopols beiträgt. Wenn der Artikel stattdessen Hinweise auf Fähigkeiten und Schwächen liefert, das Programm dann wie beschrieben seine Aufgabe erfüllt und sich als zuverlässig erweist, ist das die weit bessere Werbung.

Zitate¶

He says someone else has already said it best. So if you can't top it, steal from them and go out strong. (IMDB - American History X Quotes )

Zitate kann man sehr gut in Einleitungen benutzen und sollten so aussehen wie oben. Das heißt, den Text mit Hilfe des Syntax als Zitat einfügen und am Ende einen Link (oder zumindest einen Namen) hinzufügen, woher das Zitat stammt.

Natürlich sollen keine ganzen Artikel "zitiert" werden. Ausnahmen sind hierbei Übersetzungen anderssprachiger Anleitungen oder die Umsetzung einer Anleitung für ein anderes Linux-System auf Ubuntu. In diesen beiden Fällen muss die Quelle aber zwingend am Anfang des Artikels genannt werden.

Textbausteine¶

Bei der Gestaltung eines Artikels hat man die Möglichkeit, durch Textblöcke bzw. -Kästen auf verschiedene Sachverhalte hinzuweisen. Um sie nicht der Aufmerksamkeit des Lesers entgehen zu lassen, positioniert man allgemeine Hinweise direkt an den Anfang des Artikels. Dazu zählen:

• der Getestet-Tag

• der Wissensblock

• gegebenenfalls auch ein Fortgeschritten-, Ausbaufähig- oder Fehlerhaft-Tag

Der Wissensblock ist neben dem Getestet-Tag ein zentraler Bestandteil des Artikels. Hier sollten die für den Artikel relevanten Grundlagen verlinkt sein. Bei Verwendung der Vorlage/Artikel umfangreich (siehe Wikiartikel anlegen) ist bereits eine Liste mit den meist genutzten Grundlagenartikeln enthalten. Diese Liste sollte für die meisten Artikel absolut ausreichend sein. Je nach Bedarf können auch noch weitere Artikel aufgenommen oder auf Teile verwiesen werden, wenn dies sinnvoll erscheint.

Eine komplette Übersicht gibt es unter Wiki/Textbausteine.

Abbildungen und Bildschirmfotos¶

Die Ladezeiten dürfen nicht durch riesige Abbildungen unnötig verlängert werden. Eine Anleitung, wie man kleine Bildschirmfotos/Bilder erstellt, findet man im Artikel Bildschirmfotos.

Bilder im Format .png haben bei Bildschirmfotos mit den richtigen Einstellungen eine geringere Dateigröße als Bilder im Format .jpg bei gleicher Qualität. Vor allem aber kommt die Skalierungsfunktion des Wiki wesentlich besser mit indizierten PNG-Bildern zurecht. Soll das Bild im Wiki nicht verkleinert werden, kann man auch ein JPG-Bild benutzen, wenn die Dateigröße geringer ist.

Ausnahmen sind hier Bildschirmfotos von Spielen oder extrem farbreichen Programmen. Hier kann auf JPG zurückgegriffen werden, wobei die Größenbeschränkung hier identisch gilt.

Gibt es für das im Wiki-Artikel beschriebene Programm ein charakteristisches Symbol (Icon), so kann dies zu Beginn des Artikels eingefügt werden. Die Größe des Icons sollte 64x64 Pixel bzw. bei rechteckigen Icons bzw. maximal 64 Pixel für die größere Seite nicht überschreiten. Über Wiki/Icons findet man eine fertige Auswahl mit typischen Linux-/Ubuntu-Icons.

Paketlisten¶

Zu installierende Pakete werden meistens fett gedruckt als Liste (siehe Wiki/Syntax) angegeben, wobei die Sektionen/Komponenten dahinter in Klammern kursiv stehen. Beispielsweise:

• paket1 (universe)

• paket2

Zur Hilfe für Kommandozeilenbenutzer kann man darunter noch einen speziellen Textbaustein mit der zusätzlichen Angabe der Pakete machen:

[[Vorlage(Pakete, "paket1 paket2")]]

Dies sieht dann so aus:

sudo apt-get install paket1 paket2 

sudo aptitude install paket1 paket2 

Die Verwendung ist freiwillig und optional und das Tag sollte nur an sinnvollen Stellen (nur bei mehr als einem Paket und wo wirklich alles installiert werden soll) eingesetzt werden.

Noch einfacher geht die Angabe der Paketlisten mit dem Textbaustein Paketinstallation. Damit wird die Paketliste dann automatisch formatiert und mit dem Installationsknopf versehen.

Dateianhänge¶

Für allgemeine Dateianhänge (also keine Bilder) gilt eine Beschränkung von 500 KiB pro Anhang. Sollte der Anhang doch größer sein, bitte vorher das Wikiteam kontaktieren. Generell beschränken sich die Dateianhänge auf Bilder und selbstgeschriebene Scripts u.ä. passend zum Artikel. Wichtig: Debian-Pakete (.deb) sind nicht als Anhang erlaubt!

Hervorhebungen¶

Nicht vergessen: Hervorhebungen sollen aufzeigen, was wichtig ist!

Daher sind komplette Textpassagen in Fettdruck nicht sehr hilfreich. Zusätzlich gibt es für bestimmte "Elemente" in einem Wiki-Artikel Syntax-Vorschriften, die eingehalten werden müssen, damit ein gleichmäßiges Bild bei allen Artikeln herrscht. So werden Menüeinträge wie "Aktionen -> Info" sowie sonstige grafischen Elemente wie Checkboxen oder Buttons kursiv und in Anführungszeichen gesetzt. Datei-, Ordner- und Gerätenamen dagegen werden immer fett geschrieben. Ausgenommen sind hier Programmnamen (die ja identische Dateinamen besitzen), da eine durchgehende Fettschrift die Lesbarkeit stören würde. Hervorgehobene Elemente sollten im Textfluss eingebettet sein, d.h. sie sollten nicht separat in einer eigenen Zeile stehen (Ausnahme: Paketlisten).

Unterstreichungen sollten aufgrund der Verwechslungsgefahr mit Hyperlinks möglichst nicht oder nur äußerst sparsam verwendet werden. Ebenfalls überflüssig ist eine inflationäre Verwendung von Aufrufezeichen.

Links¶

Externe Links (also nicht ins UU-Forum oder -Wiki) werden durch das zugehörige Flaggen-Tag als solche gekennzeichnet. Also z.B.

• Hier geht es zu Wikipedia - Interwiki-Link

• Python - Startseite von Python

Kategorien¶

Artikel müssen einer oder mehreren Kategorien zugeordnet werden. Dies geschieht mit Hilfe von Tags. Jeder Artikel muss mindestens einen Tag haben, damit er einer Kategorie zugeordnet werden kann.

Beispiele¶

Falsch: iPod verwenden
Richtig: iPod
Erklärung: Dass man den iPod verwenden will, ist irgendwie klar.

Falsch: Scribus installieren
Richtig: Scribus
Erklärung: Normalerweise will man Programme installieren. Das wäre teilweise richtig, wenn "Scribus" selbst mehrere Themen enthält und zu umfangreich geworden ist. Dann wird es aber in einer Subseite Scribus/Installation gegliedert.

Falsch: Zusätzliche Schriftarten installieren
Richtig: Schriftarten
Erklärung: Auch hier könnte später gegebenenfalls aufgeteilt werden.

Ausnahmen: Pakete installieren (Grundlagenartikel), Installation_auf_USB (präzisierender Zusatz)