Benutzer-Werkzeuge

Webseiten-Werkzeuge


doc-team:editors-guide

Guide für Redakteure

Allgemeine Hinweise

  • alle Verzeichnisnamen (Namespaces) und Dateinamen (Pages) werden klein geschrieben
  • bei allen Verzeichnisnamen (Namespaces) und Dateinamen (Pages) werden Leerzeichen durch ein Minus (-) ersetzt
  • alle Verzeichnisnamen (Namespaces) und Dateinamen (Pages) müssen englisch sein (auch im deutschen Bereich)
    • Dies ist für die automatische Sprachumschaltung notwendig.
  • alle Verzeichnisse (Namespaces) und Dateien (Pages) haben immer den Namen der ersten Hauptüberschrift (h1)
  • die index-Seite in einem Verzeichnis hat immer den Namen "start" zum Beispiel: http://documentation.webedition.de/de/start
  • Eine Übersicht zur Syntax in diesem Wiki findet man hier: http://documentation.webedition.de/wiki/syntax
  • Links immer mit der : Schreibweise
    • zum Beispiel: [[:de:webedition:tag-reference:block|<we:block>]]

Hinweise zum Schreiben

Topic-basiertes Schreiben

  • Ein Artikel (Dokument) beantwortet eine Frage.
    Wie kann ich…? Was ist…?
  • Ein Artikel besitzt eine Überschrift.
  • Ein Artikel kann alleine stehen. Er kann in verschiedenen Zusammenhängen verwendet werden.

Gliederung

  1. Ist der Text leicht erkennbar und nachvollziehbar?
  2. Sind Überschriften Gliederungs- und Orientierungshilfen?

Layout und Typografie

  1. Ist der Gesamteindruck ausgewogen?
  2. Schriftart- und -größe angemessen?
  3. Sind die Sicherheitshinweise deutlich hervorgehoben?

Sprache

  1. Sätze kurz und präzise formulieren
  2. Geläufige Wörter verwenden
  3. Fachbegriffe erläutern
  4. Passiv und Konjunktiv vermeiden
  5. Modalverben vermeiden oder treffsicher verwenden
  6. Substantivierte Verben vermeiden
  7. Für gleiche Teile und Handlungen stets identische Bezeichnungen verwenden
  8. Bezeichnungen sprachlich richtig und eindeutig wählen
  9. produktspezifische Bezeichnungen korrekt und widerspruchsfrei verwenden
  10. eindeutiges Bezugssystem innerhalb des Textes wählen
  11. Floskeln vermeiden
  12. gleiche Grammatik- und Satzstrukturen für gleiche Sachverhalte wählen

Formatierung von Quellcode-Beispielen

Mit "Überschrift"

<box 100% round blue|**Beispiel #1 - foo bar**>
<code html>
    ...
</code>
</box>

Ohne "Überschrift"

<code html>
  ...
</code>

Statt "html" kann auch "php", "css" usw. als Sprache angegeben werden.

Tipps & Hinweise formatieren

Tipp - Syntax

<note tip>Hier steht der Text des Tipps.</note>

Tipp - Ausgabe

Hier steht der Text des Tipps.

Wichtig - Syntax

<note important>Hier steht der Text des Hinweises.</note>

Wichtig - Ausgabe

Hier steht der Text des Hinweises.
doc-team/editors-guide.txt · Zuletzt geändert: 2015/12/22 16:17 von Marc Krämer

Recent changes RSS feed