Um Technical Writing gut zu beherrschen, muss man die Erwartungen senken [Übersetzung]

1. Schreiben ist eine unverzichtbare Fähigkeit für Ingenieur:innen

   • Technisches Schreiben ist für Ingenieur:innen auf allen Ebenen unverzichtbar, von Commit-Messages bis zur Dokumentation.
   • Der Unterschied zwischen gutem und schlechtem Schreiben hat großen Einfluss auf Arbeitseffizienz und Kommunikation in der Organisation.

2. So knapp und kurz wie möglich

   • Leser:innen investieren nicht viel Zeit in einen Text.
   • Wenn du eine Idee in einem Satz vermitteln kannst, dann tu genau das.
   • Manche Details bewusst wegzulassen, ist eher ein Vorteil.
   • Wichtige Inhalte gehören an den Anfang des Textes, in den ersten Satz oder in den Titel.

3. Erwartungen realistisch setzen

   • Erwarte nicht, dass technische Texte sorgfältig gelesen und vollständig verstanden werden.
   • In Engineering-Organisationen sind Verwirrung und unterschiedliche Verständnistiefen normal, und Schreiben allein kann nicht alle auf denselben Stand bringen.
   • Wenn man die Erwartungen senkt, wird die Kommunikation paradoxerweise effektiver.

4. Das Ziel eines Textes ist die klare Vermittlung des Kerns

   • Oberstes Ziel ist es, einem breiten Team einen sehr einfachen Punkt zu vermitteln, etwa: „Zusätzliche Konfiguration ist kompliziert.“
   • Wichtiger als ein technisch vollständiges Verständnis ist es, mit minimalem Kontext Vertrauen zu schaffen.

5. Welche Wirkung man tatsächlich erwarten kann

   • Die Empfänger:innen eines Textes haben in der Regel weniger Hintergrundwissen als die Autorin oder der Autor.
   • Für ein breites Publikum ist die Vermittlung einer einfachen Botschaft möglich, für eine sehr kleine Zahl von Menschen auch die klare Vermittlung komplexer Inhalte.
   • Schon nur die Kernpunkte aufzuzeigen, macht in großen Organisationen einen großen Unterschied.

6. Klares Denken erzeugt klares Schreiben

   • Themen, die man nicht ausreichend versteht, lassen sich nur schwer verdichten.
   • Erkenne Unsicherheit an und konzentriere dich auf die Teile, die du klar erklären kannst.

7. Fehler und Empfehlungen

   • Verbeiße dich nicht darin, zu viele Details zu vermitteln.
   • Verdichte das, was du sagen willst, schrittweise auf einen Satz, einen Absatz und eine Seite, und vermittle den Kern zuerst.
   • Schon den großen Zusammenhang an Menschen mit kaum technischem Hintergrundwissen zu vermitteln, ist an sich wertvoll.

[yeobi222]

Am schwierigsten ist immer die Frage, wie zusätzliche Erklärungen eingefügt werden sollten, damit etwas verständlich wird.
Wenn die Entscheidungsträger fachfremd sind oder ...

[girr311]

Das gilt nicht nur für technische Dokumentation, sondern für die meisten Dokumente.