ubuntuusers.de

Du betrachtest eine alte Revision dieser Wikiseite.

Referenz

Dieser Artikel gibt einen Überblick über die Grundsätze, die man bei der Arbeit im Wiki beachten sollte.

Allgemeines

Das Wiki ist eine Sammlung von Artikeln, die jeder bearbeiten kann.

Anspruch

Im Wiki gelten andere Ansprüche als in einem Forum oder im IRC. Problembeschreibungen und Lösungswege müssen stets nachvollziehbar und korrekt sein, diffuse Hinweise wie "probier doch auch mal das hier, das hat bei mir geholfen" sind eher kontraproduktiv. Die Beachtung einiger formaler Grundsätze soll Lesbarkeit, Verständlichkeit und nicht zuletzt Einbindung im "großen Ganzen" gewährleisten.

Änderungen, Konflikte

Nicht immer sind mehrere Autoren einer Meinung. Das Wiki ist aber ein denkbar schlechtes Medium für Diskussionen. Wir haben ein Forum, und dieses sollte für Diskussionen stets benutzt werden. Aus dem Wikiartikel kann man dann auf die Diskussion verweisen.

Die Liste der Änderungen eines Artikels führt auch die jeweiligen Autoren auf. Im Einzelfall kann es sinnvoll sein, einen Autor direkt anzusprechen, beispielsweise per PN.

Regeln für Wikiartikel

Jeder Autor sollte versuchen, diese Regeln zu beherzigen. Nur so können wir ein Wiki mit durchgehend hohem Qualitätsstandard erreichen.

Thema

  • Wikiartikel sollen bevorzugt Themen behandeln, die spezifisch für Ubuntu und seine Derivate sind. Wenn es zu einem Themenkomplex andere deutschsprachige Ressourcen guter Qualität gibt, sollte auf diese verwiesen und ein neuer Artikel eher dort erstellt werden.

Benennung

Die endgültigen Seitennamen werden vom Wikiteam festgelegt. Die Grundsätze dazu stehen im Anhang, gute Vorschläge unter Beachtung dieser Grundsätze sind sehr willkommen.

Erstellung

Neue Wiki-Artikel müssen grundsätzlich in der [wiki]Baustelle[/wiki] erstellt werden, damit die Wiki-Moderatoren vor dem Freischalten drüber schauen können.

Gestaltung, Formulierung, Niveau

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.

Fehlendes Makro

Das Makro „Anmerkung“ konnte nicht gefunden werden.

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, ./wissen-installation1.png

in der Anleitung selbst genügt jetzt eine allgemeine Formulierung. ./wissen-installation2.png

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"].

GUI vs. Konsole

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

Einfachkeit 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.).

Anrede

Direkte Anrede ist zu vermeiden.

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

Abbildungen und Screenshots

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

Eine Anleitung, wie man kleine Screenshots/Bilder erstellt, findet man hier.

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. Das resultierende Bild sollte nicht größer sein als 30kB, die Gesamtgröße aller Abbildungen in einer Anleitung sollte 100kB nicht übersteigen. Bilder im Format png haben bei den richtigen Einstellungen eine geringere Dateigröße als Bilder im Format jpg bei gleicher Qualität. Daher sind png-Bilder im Wiki vorzuziehen.

Die Skalierungsfunktion des Wiki für Thumbnails sollte nur in Ausnahmefällen für Abbildungen genutzt werden, die sich nicht sinnvoll verkleinern lassen. In dem Fall ist eine hohe Skalierung (meist mehr als 50%) zu wählen, um die Maximalgröße von 30kB zu erreichen. Im allgemein sehen Thumbnails mit 150-200 Pixel Breite noch gut aus.

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".

Für Hinweise auf Konsolenbefehle, Konfigurationsdateien und Manpages dient 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. ./Expertenbox.png

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.

Syntax

Die Syntax und ihre korrekte Verwendung ist unter ["Wiki/Syntax"] erläutert. Die einheitliche Einhaltung der Regeln ist äußerst wichtig für die Lesbarkeit des Wiki.

Strukurvorschlag für Software-Artikel

  1. Gültigkeitsmarkierungen (Getestet-Block) sowie Markierungen für fehlerhafte, ausbaufähige und in Bearbeitung befindliche Artikel (Syntaxelemente "Fehlerhaft", "Ausbaufhaehig", "InArbeit")

  2. Liste der vorausgesetzten Kenntnisse (Wissen-Block)

  3. Inhaltsverzeichnis (nicht bei Seiten, die auf 1024x768 nicht mehr als eineinhalb Bildschirmseiten füllen)

  4. Einführender Satz

  5. Optional: Überschrift Ebene 1: Einführung (bei Vorstellung von Programmen: Zweck, Zielgruppe, wichtige Features, Schwächen, Screenshot)

  6. Überschrift Ebene 1: Installation

  7. Überschrift Ebene 1: Einrichtung

  8. Überschrift Ebene 1: Anwendung/Anwendungsbeispiele

  9. Überschrift Ebene 1: Ressourcen (Links, Forenbeiträge, Literatur als Auflistung) mit Angabe zur Sprache der verlinkten Seite, Verweis auf Diskussionsthread (Syntaxelement "Diskussion")

  10. keine Unterschrift! (Wer für einzelne Änderungen verantwortlich ist, kann der Änderungsliste entnommen werden. Support sollte ohnehin im Forum und nicht per persönlicher Nachrichten mit dem Autor stattfinden.)

Strukturvorschlag für Hardware-Artikel

  1. Gültigkeitsmarkierungen (Getestet-Block) sowie Markierungen für fehlerhafte, ausbaufähige und in Bearbeitung befindliche Artikel (Syntaxelemente "Fehlerhaft", "Ausbaufhaehig", "InArbeit")

  2. Liste der vorausgesetzten Kenntnisse (Wissen-Block)

  3. Inhaltsverzeichnis (nicht bei Seiten, die auf 1024x768 nicht mehr als eineinhalb Bildschirmseiten füllen)

  4. Einführender Satz

  5. Optional: Überschrift Ebene 1: Vorbereitung (Test auf passende Hardware, Installation benötigter Tools)

  6. Überschrift Ebene 1: Installation

  7. Überschrift Ebene 1: Konfiguration

  8. Überschrift Ebene 1: Hinweise zur Verwendung incl. Verweise auf geeignete Software (jeweils Paketnamen und Oberfläche angeben)

  9. Optional: Überschrift 1: Problembehandlung

  10. Überschrift Ebene 1: Ressourcen (Links, Forenbeiträge, Literatur als Auflistung) mit Angabe zur Sprache der verlinkten Seite, Verweis auf Diskussionsthread (Syntaxelement "Diskussion")

  11. keine Unterschrift! (Wer für einzelne Änderungen verantwortlich ist, kann der Änderungsliste entnommen werden. Support sollte ohnehin im Forum und nicht per persönlicher Nachrichten mit dem Autor stattfinden.)

Anhang: Benennungsregeln

Seitennamen sollten kurz und sprechend sein. Mit Blick auf mögliche Erweiterungen des Artikels dürfen sie keine Einschränkungen wie "installieren" oder "mit Breezy" enthalten. Im Einzelnen:

  • Seitennamen sollten lediglich aus der Bezeichnung der Software, Hardware oder des Themas bestehen, also normalerweise aus nur einem Wort, wenn möglich ein Nomen, möglichst im Singular.

  • Eigennamen bleiben (auch bei Seitennamen) einschließlich Leerzeichen und Groß-/Kleinschreibung erhalten. Bei Hardware soll der Hersteller vorangestellt werden, abgetrennt durch ein Leerzeichen.

  • Seitennamen beginnen mit einem Großbuchstaben.

  • Zusätze wie "installieren" oder "Konfiguration" sollen nicht verwendet werden. Diese Vorgänge sollen gemeinsam auf der Seite der Software/Hardware behandelt werden, bei wachsendem Umfang können Teile in Subseiten ausgelagert werden, für die wieder ein Nomen als Name dienen muß.

  • Ausnahme 1: Seiten, die sich allgemein und ausschließlich mit einem bestimmten Vorgang befassen, ohne dessen Angabe der Titel nicht aussagekräftig ist. In diesem Fall sollte wenn möglich der Vorgang durch ein nachgestelltes Verb beschrieben werden. Ein präzisierender Zusatz kann verwendet werden, aber nur wenn es unbedingt nötig ist.

  • Ausnahme 2: Übersichtsseiten können Titel wie "Internet und Netzwerk" tragen, wenn es inhaltlich sinnvoll ist. Ansonsten gelten auch hier die obigen Regeln.

  • Wenn eine Anleitung aus Gründen der Übersichtlichkeit aufgeteilt wird, müssen dafür Subseiten verwendet werden. Außerdem sind die Bereiche für Moderation und Verwaltung in Subseiten zu organisieren. Zu anderen Zwecken, wie beispielsweise zur thematischen Einordnung, dürfen Subseiten nicht verwendet werden. Hierzu dienen Kategorien, die auch eine Mehrfachzuordnung erlauben.

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 umfangreich geworden ist: eine Subseite Scribus/Installation

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

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

Diese Revision wurde am 27. August 2006 21:39 von Dee erstellt.
Die folgenden Schlagworte wurden dem Artikel zugewiesen: Wiki, Einsteiger