Artikelstil: Unterschied zwischen den Versionen

Aus wiki.archlinux.de
Wechseln zu: Navigation, Suche
(der Beweis dafür, dass Fehler von der Community verbessert werden :))
K (Syntax)
Zeile 100: Zeile 100:
  
 
=== Syntax ===
 
=== Syntax ===
Programme, die in Artikeln erwähnt werden, sollte man beim ersten (und nur beim ersten) Mal mit der entsprechenden Wiki-Seite oder der offiziellen Homepage verknüpfen. Alle weiteren Erwähnungen des Programms werden nicht explizit hevorgehoben.
+
Programme, die in Artikeln erwähnt werden, sollten (nur!) bei der ersten Nennung mit der entsprechenden Wiki-Seite oder der offiziellen Homepage verknüpft werden. Alle weiteren Erwähnungen des Programms werden nicht explizit hevorgehoben.
  
 
Dateinamen hebt man hervor, indem man sie in Anführungszeichen setzt. Sollte zu einer Datei ein Wiki-Artikel exisitieren, so verlinkt man den Dateinamen bei erster Nennung mit dem entsprechenden Artikel, und lässt die Anführungszeichen weg.
 
Dateinamen hebt man hervor, indem man sie in Anführungszeichen setzt. Sollte zu einer Datei ein Wiki-Artikel exisitieren, so verlinkt man den Dateinamen bei erster Nennung mit dem entsprechenden Artikel, und lässt die Anführungszeichen weg.

Version vom 4. Juli 2009, 10:33 Uhr

Dies ist ein Alternativvorschlag zum Wiki-Artikel Syntaxempfehlung, zu dem auch ein Foren-Thread existiert. Dieser Artikel soll kein Konkurrenz-Artikel zum Original-Artikel sein, sondern lediglich einen Denkanstoß in Form eines Vorschlags darstellen.



Diese Seite stellt eine Empfehlung für den Stil von Wiki-Artikeln dar. Diese Seite ist nicht verbindlich, sondern zeigt auf, was man beim Schreiben eines Wiki-Artikels berücksichtigen sollte.

Struktur

Zum Strukturieren eines Artikels verwendet man Überschriften. Diese Überschriften sollten so wenig wie möglich, aber so tief wie nötig verschachtelt werden. Im Zweifelsfall sollte man die Überschrift einfach weg lassen. Man sollte darauf achten, nicht mehr als drei Ebenen tief zu verschachteln. Besonders komplexe Artikel sollte man besser auf mehrere Einzelartikel im selben Artikel-Namensraum aufteilen.

Die erste Überschrift wird beim Erstellen der Artikel weg gelassen, da sie anhand des Artikel-Seitennamens von der Wiki-Software selbständig erstellt wird. Wenn man eine Überschrift erstellt, fängt man mit der zweiten Ebene an. Überschriften werden direkt über den ersten Absatz und mit einer zeile abstand zum vorherigen Absatz gesetzt.

[…]
Letzte Zeile des vorherigen Absatzes.

== Überschrift ==
Hier folgt der Inhalt zu dieser Überschrift
[…]

Hat man in einem Artikel mehr als fünf bis zehn Überschriften, so sollte man das Inhaltsverzeichnis an die Seite verschieben, da sonst nach dem einleitenden Absatz und dem eigentlichen Inhalt des Artikels durch das Inhaltsverzeichnis ein sehr großer, unschöner Zwischenraum entstehen würde. Zum Ausrichten den Inhaltsverzeichnisses können die Vorlage-Tags {{righttoc}} und {{lefttoc}} verwendet werden. {{righttoc}} ist vorzuziehen.

Umzunwandelde Befehls-Zeilen werden mit einem Leerzeichen jeweils vor und nach der Zeile abgesetzt, ebenso Aufzählungen.

… Text …

 befehlszeile

… Text …

Um den Lesefluss nicht zu beeinflussen, sollte ein Abschnittsende nicht „offen“ sein, nach einem Bild, einer Liste, einer Befehlszeile, o.Ä. noch mindestens ein Absatz kommen, der über mindestens eine Zeile umbricht.

Inhalte

Da jeder Artikel speziell auf die Anforderungen des beschriebenen Programms oder des Themas zugeschnitten werden sollte, kann man sich nur grob an eine Struktur halten. Diese sollte jedoch logisch aufgebaut sein.

  • Einleitender Text
  • Installation/Beschaffung
  • Grundkonfiguration oder -bedienung
  • Erweiterte Möglichkeiten oder Bedienung
  • Wiki-Links, Web-Links
  • evtl. Todo für den Artikel

Einleitender Text

Über den Einleitenden Text wird das Artikel-Thema kurz vorgestellt. Dieser Text sollte nicht länger als zwei bis drei Absätze sein, und nicht auf die Konfiguration oder die Beschaffungsmöglichkeiten eingehen, sondern lediglich umschreiben, welches Problem/Programm/Thema dem Wiki-Artikel zu Grunde liegt.

Handelt es sich um ein Programm, das beschrieben wird, bietet sich im einleitenden Text an, ein/das Alleinstellungsmerkmal dieses Programms zu nennen, um einem potentiellen Nutzer zu verdeutlichen, welche Vorteile ihm durch die Verwendung des Programms entstehen.

Handelt es sich um ein Spezialprogramm, für dessen Verwendung gewisse Voraussetzungen erfüllt sein müssen, oder um ein Thema, zu dem tieferes Wissen von Nöten ist, kann man dies im einleitenden Text ebenfalls kurz umreißen. Allerdings sollte man sich auch hier mit der Anzahl der Absätze zurückhalten.

Installation

Der Abschnitt zur Installation sollte – wenn es sich um eine Standardinstallation handelt – benennen, aus welchem Repository das Programm bezogen wird, und wie es installiert wird. Wenn es große Programme als Abhängigkeiten hat, sollten diese benannt werden.

Das Programm ''Programmname'' ist über das Paket ''paketname'' aus dem
„[[Pacman#Repositorien_und_Spiegel-Server]]“-Repository installierbar.

 pacman -Sy dasprogram

Da es sich bei Programmname um ein Qt-Programm handelt, wird Qt nebst
Abhängigkeiten ebenfalls installiert, wenn nicht bereits vorhanden.

Hier wird das Programm „programmname“ aus „extra“ installiert. Das Programm ist als „dasprogramm“ paketiert und besitzt als Abhängigkeit die Qt-Grafikbibliothek.

Sollte es sich um ein Paket aus dem AUR handeln, gibt man entsprechend den Pfad zum Programm im AUR an, und verweist darauf, dass das Programm aus dem AUR installiert werden muss. Der Hinweis auf eventuelle, große Abhängigkeiten sollte aber auch bei einem Programm aus dem AUR gegeben werden.

Das Programm [http://aur.archlinux.org/packages.php?ID=00000 Programmname]
ist im [[AUR]] verfügbar, und muss aus diesem [[AUR Installiert werden]].

[Abhängigkeitshinweis]

Müssen für das vollständige Funktionieren nach der Installation des Programms noch Schritte ausgeführt werden, so sind diese ebenfalls anzugeben. Bei Daemons sind hier zum Beispiel das Hinzufügen des Daemons in das DAEMONS-Array und das Starten des Daemons mittels /etc/rc.d/daemon start zu nennen.

Benutzung

Bei einem Artikel zu einem Programm sollte zum Einen die Grundkonfiguration erläutert werden, und zum anderen ein Beispiel mit einer etwas aufsührlicheren Konfiguration dargestellt werden. Handelt es sich um ein Programm, das ohne Konfiguration nicht lauffähig ist, so ist dieser Punkt im Artikel auf jeden Fall so ausführlich zu beschreiben, dass danach eine lauffähige Konfiguration vorhanden ist.

Wenn es sich um ein Programm handelt, dass keiner Konfiguration bedarf, so ist dessen Verwendung zu beschreiben, und zwar derart, dass einmal die Standard-Verwendung beschrieben ist, und einmal eine fortgeschrittenere Verwendung dargelegt wird.

Todo und Links

Nach dem eigentlichen Artikel sollte man noch, sofern vorhanden, auf weitere Wiki-Artikel verweisen. Zudem sollte als Weblink zumindest die Homepage des Programmierers oder des Programms angegeben werden. Bei Links zu anderen Seiten sind Sprach-Tags zu verwenden.

== Siehe auch ==
* [[Artikel 1]]
* [[Artikel 2]]

== Weblinks ==
* [http://example.com/deutsch.php Homepage von Programm] {{sprache|de}}
* [http://example.com/englisch.php Weitere Informationen] {{sprache|en}}

Sollte der Artikel unvollständig sein, oder fehlen noch wichtige Angaben, so ist dies vor dem eigentlichen Artikel mittels der Vorlage {{unvollständig}} zu markieren. Diese Vorlage erstelt einen Link auf eine Überschrift „Todo“ und verweist auf den Text. Wenn man einen unvollständigen Artikel veröffentlicht sollte man also entweder im Text darauf hinweisen, oder nach dem Artikelinhalt eine Überschrift „Todo“ setzen, unter der man auf die Unvollständigkeit eingeht, und Dinge benennt, die noch getan werden müssen, damit der Artikel vollständig ist.

Stil

Ein einheitlicher Stil ist in einer technischen Dokumentation – wie dieses Wiki eine ist – von entscheidendem Vorteil. Wenn alle Artikel identisch stukturiert sind, muss man sich nicht bei jedem Artikel aufs Neue orientieren, sondern kann sich direkt auf den Inhalt des Artikels kozentrieren.

Ansprache

Es hat sich bei technischen Dokumentationen der neutrale Aktivstil bewährt. Dies bedeutet, statt „wir“ oder „du“ oder eine passiven Schreibweise wird „man“ verwendet.

  • Inklusivstil: „Wir installieren das Programm indem wir …“
  • intimer Exklusivstil: „Du installierst das Programm indem du …“
  • neutraler Passivstil: „Das Programm wird durch … installiert.“
  • neutraler Aktivstil: „Man installiert das Programm indem man …“

Die beiden neutralen Stile kann man auch gleichzeitig im selben Artikel verwenden, ohne einen Stilbruch herbeizuführen.

Syntax

Programme, die in Artikeln erwähnt werden, sollten (nur!) bei der ersten Nennung mit der entsprechenden Wiki-Seite oder der offiziellen Homepage verknüpft werden. Alle weiteren Erwähnungen des Programms werden nicht explizit hevorgehoben.

Dateinamen hebt man hervor, indem man sie in Anführungszeichen setzt. Sollte zu einer Datei ein Wiki-Artikel exisitieren, so verlinkt man den Dateinamen bei erster Nennung mit dem entsprechenden Artikel, und lässt die Anführungszeichen weg.

Einzugebende Befehle kann man, wenn es sich nur um einen einzigen Befehl ohne Parameter handelt, direkt im Text notieren, indem man ihn in <code>-Tags einschließt. Befehlsketten oder Befehle mit Parametern rückt man ein, so dass sie von der Wiki-Software automatisch in eine Befehlszeile umgewandelt werden.

Bei der Notation von Befehlen sollte man das Eingabeprompt weg lassen. Wenn es relevant ist, kann man zwischen root und user unterscheiden, ansonsten soll sich aus dem Kontext ergeben, wie der Befehl ausgeführt werden muss.

$ dies -als --user
$ su
Passwort:
# dies --als=root
# exit
$ 

Menüpunkte gibt man direkt im Text, umschlossen von Anführungszeichen ein, und verwendet Pfeile, um die Menü-Ebenen zu unterscheiden. Nachfolgendes Beispiel beschreibt, wie man in Firefox einstellt, dass Websites keine eigenen Schriften verwenden dürfen.

Im Firefox-Hauptfenster geht man auf „Bearbeiten → Einstellungen → Inhalt“,
und klickt bei „Schriftarten & Farben“ auf „Erweitert“. In dem erscheinenden
Dialogfenster entfernt man den Haken vor „Seiten das Verwenden von …“

Sofern ohne Mehrdeutigkeit möglich, kann man lange Optionsbezeichnungen sinnvoll kürzen. Beim „Pfad“ zu der Option wird nicht zwischen Menüs, Untermenüs und Tabs unterschieden.

Grammatik und Orthographie

Niemand ist perfekt, und niemandem wird der Kopf abgerissen, wenn er nicht zu 100 Prozent perfektes Deutsch schreibt. Schließlich sind wir alle nur Menschen, dennoch sollte man darauf achten, nicht „wie Kraut und Rüben“ zu schreiben, und zumindest im Ansatz erkennen lassen, dass man beim Schreiben des Artikels über seine Worte nachgedacht hat.

Dies gilt ebenso für die Rechtschreibung. Alle gängigen Textver- und -bearbeitungprogramme haben eingebaute Rechtschreibprüfungen, auch viele Browser selbst unterstützen dies. Wirklich grobe Schnitzer sind also auf jeden Fall vermeidbar. Bei typischen „Tipp-Rechtschreib-Schwächen“ (Verb groß, Substantiv klein; „di eman“ statt „die man“ – und ähnliches), die man eher zu den Tippfehlern zählen kann, wird aber wohl niemand etwas sagen, sondern die Fehler einfach verbessern.

Hervorhebungen

Mit Hervorhebungen im Text muss sehr sparsam umgegangen werden, da sie zwar den Textsinn verdeutlichen können, aber bei zu starker Verwendung den Lesefluss stören. Sachlicher Stil zeichnet sich dadurch aus, dass er ohne spezielle Hervorhebungen verständlich ist.

Will man dennoch etwas hervorheben, so ist hierfür die Kursivschreibung (''kuriv'') der Fettschreibung ('''fett''') vorzuziehen.

Referenzen und Vermutungen

Bei einer technischen Dokumentation, wie einem Wiki, sollte man vermeiden, sich beim Schreiben auf sich selbst zu beziehen. Wenn eine solche Selbstreferenz nicht vermeidbar ist, so sollte man sie umschreiben („Der Autor hat …“ statt „Ich habe …“).

Eben so wie Referenzen sollte man auch das Anstellen von Vermutungen unterlassen und besser Beschreibungen verwenden. Wenn man einen Artikel schreibt, so sollte man das, was man schreibt, vorher oder während des Schreibens überprüfen.

  • Vermutung: „Durch einen Klick auf ‚Run!‘ sollte die Bearbeitung der Daten starten.“
  • Beschreibung: „Durch einen Klick auf ‚Run!‘ startet die Bearbeitung der Daten.“

Wenn man eine Aktion ausführt, und sie führt zu einem Resultat, dann schreibt man dies so auch in den Wiki-Artikel. Wenn beim Testen eine Aktion nicht wie erwartet funktioniert, sollte man zuerst ausschließen, ob man beim Testen einen Fehler gemacht hat (ggf. im Wiki/Forum des betroffenen Programms recherchieren), bevor man es in den Artikel schreibt.

Zeichen

Bei Auslassung von Inhalten werden von eckigen Klammern umschlossene Auslassungspunkte verwendet. Allerdings nur, wenn sich die Auslassung zwischen Inhalten befindet. Wenn sich die Auslassung vor oder nach Inhalten befindet, werden die Klammern weg gelassen

… es fehlen […] Inhalte, die unrelevant sind …

Wenn Anführungszeichen verwendet werden, sollte man den normalen deutschen Anführungszeichen den Vorrang geben.

„Dieser Text ‚steht in‘ Anführungszeichen

Die Kodierung der Anführungszeichen und der Auslassungspunkte und der für Menüpfade empfohlenen Pfeile sind in der Wikipedia nachzulesen, und man kann sie sich zur leichteren Verwendung auch mittels Xmodmap auf beliebige Tasten(kombinationen) legen.