Stimme und Tonfall#

Achtet in euren Dokumenten auf eine Stimme und einen Ton, der umgangssprachlich, freundlich und respektvoll ist, ohne kumpelhaft oder frivol zu sein; eine Stimme, die zwanglos natürlich und ansprechbar ist, nicht pedantisch oder aufdringlich. Versucht, sachkundig,freundschaftlich und verständnisvoll zu klingen.

Versucht nicht genau so zu schreiben, wie ihr sprecht; ihr sprecht wahrscheinlich umgangssprachlicher und ausführlicher, als ihr schreiben solltet, zumindest für technnische Dokumentationen. Aber strebt eher einen gesprächigen Ton an, als einen formellen.

Versucht nicht, super-unterhaltsam zu sein, aber strebt auch nicht nach völliger Versachlichung. Seid menschlich, zeigt eure Persönlichkeit, seid einprägsam; ihr könnt sogar ab und zu ein wenig witzig sein. Aber denkt daran, dass der Hauptzweck des Dokuments darin besteht, Informationen für euer Zielpublikum bereitzustellen.

Denkt daran, dass für euer Publikum nicht unbedingt Deutsch die erste Sprache gewesen sein muss, dass viele von ihnen aus anderen Kulturen kommen, und dass euer Text vielleicht in andere Sprachen übersetzt wird.

Was ihr vermeiden solltet#

  • Buzzwords oder Fachjargon

  • niedlich oder albern sein wollen

  • aktuelle popkulturelle Anspielungen

  • Witze auf Kosten der Konkurrenz oder anderer Personen

  • Formulierungen, die andere verunglimpfen oder beleidigen

  • Ableistische Sprache oder Redewendungen

  • das Vermischen oder Übertreiben von Metaphern

  • Phrasen wie Bitte beachtet oder Zu diesem Zeitpunkt

  • abgehackte oder langatmige Sätze

  • alle Sätze mit der gleichen Phrase beginnen (z.B. ihr könnt)

  • Ausrufezeichen, außer in sehr seltenen, wirklich spannenden Momenten

  • Vereinnahmende Formulierungen wie Lasst uns das machen.

  • Die Verwendung von Ausdrücken wie einfach, es ist so einfach oder schnell

  • Internet-Slang oder -Abkürzungen wie tl;dr oder ymmv

Was ihr berücksichtigen solltet#

  • Wenn ihr Schwierigkeiten habt, etwas auszudrücken, tretet einen Schritt zurück und fragt euch: Was versuche ich zu sagen?

  • Wenn ihr euch bei einer Formulierung oder einem Tonfall unsicher sind, bittet ein Mitglied eures Teams, einen Blick darauf zu werfen

  • Versucht, Teile eures Dokuments laut vorzulesen oder zumindest die Wörter mit dem Mund zu sprechen. Klingt es natürlich?

    Beachtet jedoch, dass nicht alle Sätze natürlich klingen müssen; es sind schließlich schriftliche Dokumente. Aber wenn ihr auf einen Satz stoßt, der beim Sprechen unbeholfen oder verwirrend ist, überlegt, ob ihr ihn umgangssprachlicher formulieren könnt.

  • Verwendet Übergänge zwischen den Sätzen. Phrasen wie Obwohl oder So können Absätze weniger gestelzt wirken lassen.

  • Auch wenn ihr Schwierigkeiten habt, den richtigen Ton zu treffen, stellt sicher, dass ihr die nützlichen Informationen klar und direkt vermittelt; das ist der wichtigste Teil.

Seid höfflich#

Es ist schön, höflich zu sein, aber die Verwendung von bitte in einer Anweisung ist übertrieben.

  • ✅ Klickt auf Ansicht, um das Dokument anzuzeigen.

  • ❌ Um das Dokument anzusehen, klickt bitte auf Anzeigen.

  • ✅ Weitere Informationen finden Sie unter …

  • ❌ Für weitere Informationen klickt bitte auf …

Beispiele#

Beispiele für zu informelle, passende und zu formelle Sprache#

zu informell

passend

zu formell

Cool! Die API ist total genial!

Mit dieser API könnt ihr die gewünschten Daten erhalten.

Diese Dokumentation beschreibt die API vollständig.

Mit diesem Aufruf erhältst du sofort jede Telefonnummer.

Ihr könnt die Telefonnummer abfragen mit user.getPhoneNumber

Für das Abfragen der Telefonnummer wird zunächst der Wert für user benötigt. Anschließend kann die Telefonnummer mit der Methode getPhoneNumber abgefragt werden.