de:tips:good_style
Dies ist eine alte Version des Dokuments!
Inhaltsverzeichnis
Tipps für einen guten Stil
Hier finden Sie einige Tipps um eine gute Wiki Seite zu erstellen.
Seitenstruktur
1
- Beginnen Sie die Seite mit einer aussagekräftigen Überschrift erster Ordnung.
- Verschachteln Sie die Überschriften in der richtigen Reihenfolge, Absätze auf zweiter Ebene sollten mit einer Überschrift zweiter Ordnung beginnen.
- Gliedern Sie Ihren Text in Paragraphen, die Sie durch eine Leerzeile trennen. Ein durchschnittlicher Paragraph sollte nicht länger als 10-20 Zeilen sein.
- Sollte Ihr Text länger als ein paar (ca. 3-5) Paragraphen sein, ziehen Sie in Betracht, ihn in Absätze zu gliedern, indem Sie Unterüberschriften zweiter bis fünfter Ordnung hinzufügen.
- Schreiben Sie eine kurze Zusammenfassung des Inhalts nach der ersten Überschrift, falls Ihr Text länger als zwei bis drei Bildschirmseiten wird. Erwägen Sie auch, Ihre Seite in mehrere Seiten aufzuteilen, falls Sie bedeutend länger wird.
- Falls Sie viele Links zu anderen Wiki-Seiten oder externen Ressourcen haben, fügen Sie einen eigenen Absatz mit weiterführenden Quellen hinzu (siehe weiter unten).
- Falls mehrere Seiten eines Namensraumes eine ähnliche Struktur haben, können Sie eine Namensraum-Vorlage verwenden, um jede neue Seite mit dieser Vorlage zu beginnen.
- Versuchen Sie, komplizierte Namensraum-Strukturen zu verhindern. Verwenden Sie stattdessen kurze, einfach zu merkende Namen für Namensräume.
Textformatierung
- Einzelne Wörter oder kurze Textpassagen können fett oder kursiv hervorgehoben werden. Wählen Sie eine Variante aus und wenden Sie diese konsequent an.
- Wählen Sie eine Form, um Bildschirmausgaben und Texte auf dem Bildschirm darzustellen und benutzen Sie diese durchgehend. Vielleicht ist eine Seite mit Erklärungen Ihrer Stil-Konventionen eine gute Idee.
- Verwenden Sie unsortierte Listen für Aussagen, die nicht von einander abhängig sind. Wenn Sie einen Gedankengang erarbeiten, schreiben Sie durchgehend in einer Abfolge von Sätzen.
- Tabellen können die Lesbarkeit von strukturierten Daten stark erhöhen. Verwenden Sie aussagekräftige Spaltenüberschriften und eine Beschriftung, die den Inhalt der Tabelle beschreibt (z.B. „Tabelle 1.2: Durchschnittlicher Abstand zwischen den Planeten“).
- Lange Tabellen sind schwer zu bearbeiten. Vielleicht können Sie die Daten in einer verschachtelten Liste darstellen.
Sprache
- Schreiben Sie korrekte Sätze und verwenden Sie, wenn nötig, Artikel vor Nomen.
- Beginnen Sie jeden Satz mit einem Großbuchstaben und beenden Sie ihn mit einem Punkt oder anderem Satzzeichen.
- Versuchen Sie kurze, klare Sätze zu schreiben, ohne viele Nebensätze zu benutzen. Wenn Sie denken, dass die Seite fertig ist, lesen Sie sie nochmal durch und verbessern Sie jeden Satz, der eine zu komplizierte Struktur hat.
- Entscheiden Sie sich, wie Sie Ihre Leser ansprechen. Da DokuWiki entwickelt wurde, um Dokumentationen zu schreiben, werden Sie oft Ihre Leser anweisen müssen, wie Dinge zu tun sind. Sie können die Befehlsform („Mach das!“), die wir-/Sie-Form („Dann klicken wir/Sie auf…“) oder die ich-Form („Ich füge dann Foo hinzu…“) benutzen. Mischen Sie diese Formen nicht.
- Überprüfen Sie die Seite vor dem Speichern auf Grammatik- und Rechtschreibfehler. Beinhaltet Ihr Text zu viele Fehler, wirkt sich das auf die Glaubwürdigkeit Ihrer Aussagen aus, unabhängig davon wie durchdacht sie sind.
- Entwickeln Sie Ihren eigenen Schreibstil. Zwingen Sie sich keinen Schreibstil auf, mit dem Sie sich nicht wohl fühlen. Das würde sich nur unnatürlich anhören und wäre unangenehm zu lesen.
Quellangaben
- Falls Sie auf einen Begriff stoßen, der mehr Erklärung benötigt, erstellen Sie eine neue Wikiseite und verlinken dann den Begriff darauf.
- Überprüfen Sie Ihre Seite, bevor Sie sie fertigstellen, und verlinken Sie zentrale Begriffe Ihrer Seite mit Wikiseiten, die bereits existieren.
- Verlinken Sie Begriffe nicht jedes mal, wenn sie auftreten. Machen Sie einen Link bei der ersten oder bedeutendsten Nennung des Begriffs auf Ihrer Seite. Gegebenenfalls verlinken Sie ihn auch in den Quellangaben.
- Stellen Sie Links zu den Quellen von Bildern, Daten und Zitaten bereit.
- Ziehen Sie auch eine „Siehe auch: “ Zeile am Ende der Seite in Betracht. Stellen Sie hier Links zu themenverwandten Wikiseiten ein.
- Wenn Sie Verweise zu externen Ressourcen mit weitergehenden Informationen zum Thema anhängen wollen, fügen Sie einen Absatz „Quellangaben“ oder „Weitergehende Informationen“ mit Links oder anderen Verweisen (z.B. ISBN-Nummern) am Ende hinzu. Erklären Sie hier auch die Absicht Ihres Verweises, falls das noch nicht im Haupttext geschehen ist.
- interwiki-Verknüpfungen können helfen, auf allgemeine Quellen zu verweisen.
Bilder und andere Medien
- „Ein Bild sagt mehr als tausend Worte.“ Es könnte sogar bedeuten, dass es mehr sagt, als Sie beabsichtigen zu sagen. Menschen neigen dazu, die Glaubwürdigkeit von Bildern weniger in Frage zu stellen als die Glaubwürdigkeit von Sprache. Eine kurze schriftliche Beschreibung ist besser als gar nichts oder eben ein unpassendes Bild.
- Verwenden Sie eine Beschriftung, wie auch bei den Tabellen, für die Bilder, die beschreibt was Sie mit dem Bild zeigen wollen.
- Falls Sie das Bild nicht selbst erstellt haben, nennen Sie die Quelle (wenn möglich mit einem Link) und das Copyright.
- Verlinken Sie keine Bilder von externen Seiten, außer es wurde Ihnen ausdrücklich erlaubt. Dies ist in erster Linie eine Sache des Copyright, kann aber auch ein Problem durch Stehlen von Bandbreite sein, falls "caching for external images" (englisch) ausgeschaltet ist.
- Benutzen Sie einen Link mit Skalierbefehlen, um ein Miniaturbild einzufügen, wenn das eigentliche Bild größer als ein Drittel der Bildschirmseite ist.
de/tips/good_style.1293444100.txt.gz · Zuletzt geändert: 2010-12-27 11:01 von 93.166.96.222