Highlights#

Einführung#

Der Redaktionsleitfaden deckt sehr viel Material ab, daher bietet die folgende Seite einen Überblick über die wichtigsten Punkte. Für weitere Informationen zu den Themen auf der Seite folgt den Links.

Tonfall und Inhalt#

  • Seid gesprächig und freundlich, ohne forsch zu sein

  • Macht in der Dokumentation keine Vorankündigungen

  • Verwendet beschreibenden Linktext

  • Schreibt leicht zugänglich

  • Schreibt für ein globales Publikum

Sprache und Grammatik#

  • Verwendet die zweite Person und ihr eher als wir

  • Verwendet die aktive Stimme: Macht deutlich, wer die Handlung ausführt

  • Setzt Konditionalsätze vor Anweisungen, nicht danach

  • Informationen zur Verwendung und Schreibweise bestimmter Wörter findet .hr in der Wortliste

Formatierung, Zeichensetzung und Organisation#

  • Verwendet Groß- und Kleinschreibung für Dokumententitel und Zwischenüberschriften

  • Verwendet nummerierte Listen für Sequenzen

  • Verwendet Aufzählungslisten für die meisten anderen Listen

  • Verwenden Definitionslisten für Terme und deren Beschreibung

  • Verwendet fortlaufende Kommas

  • Setzt Code in nichtproportionaler Schrift

  • Setzt UI-Elemente in serifenloser Schrift

  • Verwendet eine eindeutige Datumsformatierung

Bilder#

  • Verwendet SVG-Dateien oder PNG-Bilder in passender Größe

  • Gebt Alternativtext an

  • Stellt, wenn möglich, hochauflösende Bilder bereit