Schreiben#

Gut geschriebene Texte ermöglichen es Menschen, unsere Informationen mit Leichtigkeit zu nutzen. Diese Richtlinien wurden anhand von Beispielen aus der Praxis entwickelt und richten sich an alle, die für Cusy technische Dokumentationen schreiben.

Cusy-Texte sind bestens wenn

  • sie schön dargestellt sind

  • sie keine impliziten Annahmen treffen

  • sie so einfach wie möglich sind

  • sie komplex werden können, aber nicht kompliziert

Themen#

Kurz

Strebt kurze und prägnante Textbeiträge an

Fokussiert

Beschränkt euch in einem Beitrag auf ein Thema. Beiträge, die mehrere Themen umfassen, sollten aufgebrochen werden.

Zugänglich

Verwendet eine möglichst einfache Sprache ohne Fachjargon. Erklärt komplizierte Konzepte, indem ihr sie aufschlüsselt.

Verweist zu öffentlich zugänglichen Artikeln um mehr Details zu eurem Thema zu erhalten oder einen alternativen Zugang zu eurem Thema zu erhalten.

Barrierefrei schreiben#

Im Abschnitt Barrierefreiheit findet ihr detaillierte Anleitungen zum barrierefreien Schreiben, vor allem zu den Themen:

  • Textalternativen für Bild- und Audioinhalte

  • Fehler und andere Meldungen

  • Beschriftungen und Eingaben für Formulare

Fragen und Feedback#

Wenn euch etwas fehlt oder ihr Erläuterungen zu einem bestimmten Anwendungsfall benötigt, könnt ihr uns gerne Fragen stellen in einer GitHub-Aufgabe.

Einführung#

Schlüsselanweisungen#

Grundlagen#

Verlinkung#

Computer-Schnittstellen#

Testen#