Guide für Redakteure

• 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>]]

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

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

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

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

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

<code html>
  ...
</code>

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