Beispiele¶

Falsch: IPod verwenden
Richtig: IPod
daß man ihn verwenden will ist ja wohl klar...

Falsch: Scribus installieren
Richtig: Scribus
Auch richtig, aber erst wenn "Scribus" selbst mehrere Themen enthält und zu umfangeich geworden ist: eine Subseite Scribus/Installation

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

Richtig wegen Ausnahme 1: Pakete installieren (Grundlagenartikel), Installation_auf_USB (präzisierender Zusatz)

Verständlichkeit¶

Anleitungen sollten für jeden verständlich sein, der die ["Einsteiger"]-Sektion und die im Artikel selbst verlinkten Anleitungen (s.u., "Wissens-Block") 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, außerdem sollte man auf entsprechende externe Quellen hinweisen.

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 wurde zu diesem Thema begonnen: Begriffe.

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 irgend einem Punkt Software installiert. Würde man diese Softwareinstallation nun im Artikel selbst erklären, wäre dies entweder schrecklich lang oder 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, daß der fragliche Teilaspekt auch für andere Artikel relevant sein könnte, sollte man ihn auslagern.

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 "Anwendungen hinzufügen" 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. Wie dies erreichbar ist, erfährt man unter ["Verwaltung/DE-Integration"].

Anrede¶

Direkte Anrede ist zu vermeiden.

Nicht "Du", nicht "Sie", sondern "man" ist richtig.

Abbildungen und Screenshots¶

Die Ladezeiten dürfen nicht durch riesige Abbildungen unnötig verlängert werden.

Ein Bild kann mehr als tausend Worte sagen. Tausend Bilder führen dagegen dazu, daß die Seite über langsame Verbindungen gar nicht erst geladen wird. Screenshots müssen vor dem Hochladen optimiert werden: die Bildbreite sollte durch Skalierung oder Wahl eines Ausschnitts auf maximal 500px begrenzt werden, außerdem muss der Farbraum auf eine indizierte Palette umgestellt werden (in GIMP: "Bild → Modus → indiziert", 64 oder weniger Farben genügen fast immer; die Farbrasterung sollte man meist deaktivieren). Das resultierende Bild sollte nicht größer sein als 30kB, die Gesamtgröße aller Abbildungen in einer Anleitung sollte 100kB nicht übersteigen.

Die Skalierungsfunktion des Wiki sollte nur in AUsnahmefällen für Abbildungen genutzt werden, die sich nicht sinnvoll verkleinern lassen. In dem Fall ist eine extreme Skalierung zu wählen, um die Maximalgröße von 30kB zu erreichen.

Hintergrundinformationen¶

Hintergrundinformationen dürfen nicht ablenken

Ein guter Teil der Leser will nicht in erster Linie etwas lernen sondern etwas erreichen: daß 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 Hintergrundinformationen gibt es die Box "Hinweis". (tbd: Abbildung?)

Für Hinweise auf Konsolenbefehle und Konfigurationsdateien dient die faltbare "Terminal"-Box. Die dort enthaltenen Informationen wenden sich an interessierte Leser und Fachleute, sie sind möglichst knapp zu halten. (Noch nicht verfügbar. tbd: Abbildung?)

Formulierung¶

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 statt dessen 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.