DokuWiki

It's better when it's simple

Benutzer-Werkzeuge

Webseiten-Werkzeuge


de:tips:good_style

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
de:tips:good_style [2010-12-27 11:01] – [Seitenstruktur] 93.166.96.222de:tips:good_style [2023-06-12 12:28] (aktuell) – alte Version wiederhergestellt (2023-06-12 11:55) saggi
Zeile 1: Zeile 1:
 ====== Tipps für einen guten Stil ====== ====== Tipps für einen guten Stil ======
  
-Hier finden Sie einige Tipps um eine gute Wiki Seite zu erstellen.+Hier finden Sie einige Tippsum eine gute Wiki Seite zu erstellen.
  
 ===== Seitenstruktur ===== ===== Seitenstruktur =====
-1+
   * Beginnen Sie die Seite mit einer aussagekräftigen Überschrift erster Ordnung.   * 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.   * 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. +  * Gliedern Sie Ihren Text in Absätze, die Sie durch eine Leerzeile trennen. Ein durchschnittlicher Absatz 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 [[:de:syntax#ueberschriften|Absätze]] zu gliedern, indem Sie Unterüberschriften zweiter bis fünfter Ordnung hinzufügen.+  * Sollte Ihr Text länger als ein paar (ca. 3-5) Absätze sein, ziehen Sie in Betracht, ihn in [[:de:wiki:syntax#ueberschriften|Abschnitte]] 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.   * 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 [[#Quellen|weiter unten]]).   * Falls Sie viele Links zu anderen Wiki-Seiten oder externen Ressourcen haben, fügen Sie einen eigenen Absatz mit weiterführenden Quellen hinzu (siehe [[#Quellen|weiter unten]]).
   * Falls mehrere Seiten eines [[:de:namespace|Namensraumes]] eine ähnliche Struktur haben, können Sie eine [[:namespace template|Namensraum-Vorlage]] verwenden, um jede neue Seite mit dieser Vorlage zu beginnen.   * Falls mehrere Seiten eines [[:de:namespace|Namensraumes]] eine ähnliche Struktur haben, können Sie eine [[:namespace template|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.   * Versuchen Sie, komplizierte Namensraum-Strukturen zu verhindern. Verwenden Sie stattdessen kurze, einfach zu merkende Namen für Namensräume.
 +  * Falls Sie als Wiki-Verantwortliche(r) bzw. Mitwirkende(r) weitere Unterstützung bei der Textformatierung und Seitenstrukturierung anbieten möchten, empfiehlt sich ebenfalls ein Blick auf das [[plugin:qc|Quality Check Plugin]].
 ===== Textformatierung ===== ===== 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.   * 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.   * 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 [[:de:syntax#listen|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. +  * Verwenden Sie [[:de:wiki:syntax#listen|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. 
-  * Verwenden Sie [[:de:syntax#fussnoten|Fußnoten]] nur spärlich und auch dann nur für kurze, zusätzliche Ausführungen. Wenn es mehr zu einem Thema zu sagen gibt, schreiben Sie es auf eine neue Wikiseite. Benutzen Sie [[:de:syntax#links|Links]], um auf andere, externe Quellen zu verweisen.+  * Verwenden Sie [[:de:wiki:syntax#fussnoten|Fußnoten]] nur spärlich und auch dann nur für kurze, zusätzliche Ausführungen. Wenn es mehr zu einem Thema zu sagen gibt, schreiben Sie es auf eine neue Wikiseite. Benutzen Sie [[:de:wiki:syntax#links|Links]], um auf andere, externe Quellen zu verweisen.
   * 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").   * 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.   * Lange Tabellen sind schwer zu bearbeiten. Vielleicht können Sie die Daten in einer verschachtelten Liste darstellen.
Zeile 28: Zeile 28:
   * Beginnen Sie jeden Satz mit einem Großbuchstaben und beenden Sie ihn mit einem Punkt oder anderem Satzzeichen.    * 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.   * 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.+  * 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 ein Foto 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.   * Ü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.   * 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.
Zeile 44: Zeile 44:
 ===== Bilder und andere Medien ===== ===== 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. +  * "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 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.    * 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.   * 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 [[config:fetchsize|"caching for external images"]] (englisch) ausgeschaltet ist.    * 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 [[config:fetchsize|"caching for external images"]] (englisch) ausgeschaltet ist. 
-  * Benutzen Sie einen [[:de:syntax#groesse_von_bildern|Link mit Skalierbefehlen]], um ein Miniaturbild einzufügen, wenn das eigentliche Bild größer als ein Drittel der Bildschirmseite ist.+  * Benutzen Sie einen [[:de:wiki:syntax#groesse_von_bildern|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

Falls nicht anders bezeichnet, ist der Inhalt dieses Wikis unter der folgenden Lizenz veröffentlicht: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki