ubuntuusers.de

Du betrachtest eine alte Revision dieser Wikiseite.

Referenz

Dieser Artikel gibt einen Überblick über die grundsätzlichen Regeln, die man bei der Arbeit im Wiki beachten sollte. Wir bitten darum, diese vor dem Bearbeiten oder Erstellen einer Seite durchzulesen und zu verinnerlichen.

Die Seite Wiki/Schnelleinstieg erklärt die Verwendung dieser Regeln im Zuge einer Seitenerstellung. So hat man Vorlage, Referenz und Syntax beisammen.

Allgemeines

Das Wiki ist eine Sammlung von Artikeln, die jeder bearbeiten kann. In manchen Fällen ist eine Bearbeitung nicht erlaubt, weil die Seite ein von uns reguliertes Aussehen oder bestimmte Information hat (siehe z.B. bei der Startseite).

Anspruch

Im Wiki gelten andere, höhere 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, Rechtschreibung und nicht zuletzt Einbindung im "großen Ganzen" gewährleisten.

Änderungen und 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 mit Hilfe der "Diskussion"-Box auf das Thema verweisen: ./Diskussionsbox.png

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

Regeln für Wikiartikel

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

Vorüberlegungen

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, 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 müssen grundsätzlich in der Baustelle erstellt werden.

Dies stellt sicher, daß die Benutzer und speziell die Wiki-Moderatoren vor dem Freischalten drüber schauen können. Auf der Baustellenseite einfach nur einen neuen Seitenamen eintragen und auf "Seite hinzufügen" klicken. Es wird dann die Standardvorlage gewählt. ./Baustelle.png

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 und ggf. die Fortgeschritten-Box zu benutzen.

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: 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 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, 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.).

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 Hinweis-Box. ./Hinweisbox.png

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

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, der zitierte Text kursiv und am Ende ein Link (oder zumindest ein Name), woher das Zitat stammt.

Natürlich sollen keine ganzen Artikel "zitiert" werden. Ausnahmen sind hierbei Übersetzungen andersprachiger 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.

Anmerkung: Das Zitat oben wurde gewählt, weil es etwas über Zitate im allgemeinen aussagt: Wenn es schon jemand vor dir gut beschrieben hat, dann ist es meist besser von diesem zu zitieren, um sich damit einen guten Eindruck zu verschaffen (sehr frei übersetzt).

Gestaltung

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.

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

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.

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 Artikel herrscht. So werden Menüeinträge wie "Aktionen → Info", soweit sonstige grafischen Elemente, wie Checkboxen oder Buttons kursiv und in Anführungszeichen gesetzt. Datei-, Ordner- und Gerätename dagegen werden immer kursiv geschrieben. Ausgenommen sind hier Programmnamen (die ja identische Dateinamen besitzen), da eine durchgehende Fettschrift die Lesbarkeit stören würde.

Die Diskussionsbox zur Verlinkung auf einen zugehörigen Forenthread gehört normalerweise ans Ende eines Artikel zu den Links. Externe Links (also nicht ins UU-Forum oder -Wiki) sollten durch das zugehörige Flaggen-Tag als solche gekennzeichnet werden. ./ExterneLinks.png

Wichtig ist die Benutzung des Anchor-Tags, wenn man innerhalb einer Seite oder innerhalb des Wikis auf bestimmte Seitenabschnitte verlinken möchte. Ein Verlinkung direkt auf die Überschriften mittels #head... sollte vermieden werden.

Syntax

Die einheitliche Einhaltung der Syntax-Regeln ist äußerst wichtig für die Lesbarkeit des Wiki.

Die Syntax und ihre korrekte Verwendung ist unter Wiki/Syntax erläutert.

⚓︎

Anhang

Bennungsregeln

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.

  • Ansonsten beginnen Seitennamen 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 sollte.

  • 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. 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
Erklärung: Daß man den IPod verwenden will, ist irgendwie klar.

Falsch: Scribus installieren
Richtig: Scribus
Erklärung: Normalerweise will man Programme installieren. Des 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)


Diese Revision wurde am 3. Oktober 2006 18:02 von Dee erstellt.
Die folgenden Schlagworte wurden dem Artikel zugewiesen: Wiki, Einsteiger