Worauf ich beim Editieren achte (2019)

Woran ich beim Editieren von Texten denke

• Vermittle den Text präzise

  • Bevor man schreibt, sollte man festlegen, was man sagen will.
  • Unter Berücksichtigung von Thema, Zielgruppe usw. wird der Zweck des Textes klar definiert und am Anfang des Dokuments festgehalten.
  • Während des Schreibens und Editierens wird dieser Zweck als Maßstab genutzt, um Konsistenz zu wahren.

• Wiederhole innerhalb eines vernünftigen Rahmens

  • Damit Leser das Thema verstehen, wird es am Anfang und am Ende des Textes noch einmal bestätigt.
  • Für mehr Klarheit kann es hilfreich sein, zur Wiederholung Substantive statt Verben zu verwenden.

• Vereinfache

  • Entferne unnötige Wörter und formuliere Sätze knapp.
  • Ersetze Ausdrücke wie „Sie“ oder „Sie können“ durch kurze Imperative.
  • Teile lange Sätze in kürzere auf und setze Kommas passend ein, um das Verständnis der Leser zu erleichtern.

• Vermeide das Passiv

  • Das Passiv macht den Handelnden unklar und den Satz dadurch weniger eindeutig.
  • Im Aktiv werden Sätze klarer und leichter verständlich.

• Verwende keine Adverbien

  • Nutze statt Adverbien konkretere Verben oder ergänze eine genauere Erklärung.
  • Adverbien vermitteln Lesern oft nicht die exakte Bedeutung und lassen Unklarheit zurück.

• Setze kein Wissen voraus

  • Gib angemessene Hintergrundinformationen zu Dingen, die Leser möglicherweise nicht kennen.
  • Schreibe Abkürzungen beim ersten Auftreten aus und ergänze eine Erklärung.

• Achte auf den Ton

  • Der Ton des Textes sollte konsistent sein; ein freundlicher und ein formeller Ton sollten nicht gemischt werden.

• Vermeide Fachjargon und Klischees

  • Verwende präzise Formulierungen, damit Leser den Text leicht verstehen.
  • Fachjargon kann schwer verständlich sein, wenn Leser nicht zu einer bestimmten Gruppe gehören.

• Nutze Leerraum

  • Teile lange Absätze auf und verwende Zwischenüberschriften, Listen, Tabellen usw., um die Lesbarkeit zu erhöhen.
  • Hebe wichtige Inhalte fett hervor, damit Leser die zentralen Punkte nicht übersehen.

Fazit

• Die Grundprinzipien des Editierens bestehen darin, Bedeutung klar zu vermitteln und unnötige Wörter zu entfernen.
• Wenn man diesen Prinzipien folgt, kann man zugleich den eigenen Stil und persönliche Vorlieben weiterentwickeln.
• Das Ziel des Editierens ist es, über den Sprachgebrauch nachzudenken und passende Entscheidungen für die Vermittlung der Botschaft zu treffen.

Meinung von GN⁺

• Den Zweck eines Textes und seine Konsistenz im Editierprozess zu bewahren, ist ein wichtiger Grundsatz für jede Form des Schreibens.
• Die Verwendung des Passivs ist ein Stilmittel, das besonders in technischer Dokumentation vermieden werden sollte; der Wechsel ins Aktiv trägt zu mehr Klarheit bei.
• Auf Adverbien zu verzichten und konkrete Formulierungen zu verwenden, ist nicht nur in technischer Dokumentation, sondern in jeder Art von Text wirkungsvoll.
• Hintergrundinformationen zu geben, wenn Leser etwas möglicherweise nicht wissen, ist besonders in technischer Dokumentation wichtig; das verbessert das Verständnis und erhöht die Zugänglichkeit des Dokuments.
• Leerraum und visuelle Gliederung zu nutzen, ist ein wichtiger Faktor für die bessere Lesbarkeit von Online-Inhalten.

[GN⁺]

Hacker-News-Kommentare

• Zusammenfassung des ersten Kommentars:

  • Der Autor sagt, es sei ihm eine Ehre, dass sein Text bei vielen Menschen Anklang gefunden habe.
  • Er sei seiner Neugier gefolgt und Software Engineer geworden, habe nach einigen Jahren Arbeit aber eine stärker schreiborientierte Rolle vermisst.
  • Er suche nach einer Rolle, die technische Skills und Kommunikationsfähigkeit verbinde; erreichbar sei er über seine Website und LinkedIn.

• Zusammenfassung des zweiten Kommentars:

  • In technischen Dokumenten Abkürzungen zu verwenden, ohne sie einzuführen, sei unerquicklich.
  • Das wiederhole sich in Projektdokumentationen, und wenn sich Teammitglieder änderten, könne irgendwann niemand mehr wissen, wofür die Abkürzungen stehen.
  • Manchmal bleibe nur die Lösung, Abkürzungen wie Eigennamen zu behandeln und sie weiterhin so zu verwenden.

• Zusammenfassung des dritten Kommentars:

  • Als Gutachter technischer Dokumentation habe der Kommentator viele Guidelines verwendet.
  • Zusätzlich schlage er vor, nicht dieselbe Sache mit unterschiedlichen Namen zu bezeichnen.
  • Wenn es mehrere Autoren gebe, könnten unterschiedliche Begriffe Leser verwirren.

• Zusammenfassung des vierten Kommentars:

  • Der Kommentator stimmt dem Rat „Passiv vermeiden“ nicht zu.
  • Das Passiv sei ein Werkzeug, mit dem sich die Perspektive auf eine Handlung verändern lasse.
  • Durch das Passiv könne man wählen, ob man die Quelle einer Handlung erwähnen wolle oder nicht.

• Zusammenfassung des fünften Kommentars:

  • Es sei schwierig zu entscheiden, für wen man schreibe.
  • Man müsse verschiedene Leser berücksichtigen, etwa technische, allgemeine und nichttechnische Leser.
  • Der Kommentator ringe mit dem Konflikt zwischen dem Versuch, Texte für mehr Leser zugänglich zu machen, und dem Wunsch, sie kürzer zu halten.

• Zusammenfassung des sechsten Kommentars:

  • Der Kommentator bringt seine Leidenschaft für bessere Texte zum Ausdruck.
  • Er gibt Ratschläge zur Bedeutung von Listen und zu ihrem richtigen Einsatz.

• Zusammenfassung des siebten Kommentars:

  • Es wird vorgeschlagen, die Verwendung des Wortes "just" zu vermeiden.
  • "just" impliziere Einfachheit, auch wenn etwas in Wirklichkeit vielleicht nicht einfach sei.

• Zusammenfassung des achten Kommentars:

  • Nicht nur in technischer Dokumentation, sondern auch in Blogs, E-Mails usw. werde die Bedeutung von Leerraum betont.
  • Lange Absätze seien schwer zu lesen, und Menschen verlören dabei leicht die Aufmerksamkeit.

• Zusammenfassung des neunten Kommentars:

  • Der Kommentator habe früher bei einem MSP gearbeitet und dort die Bedeutung gut geschriebener Produktionsleitfäden erkannt.
  • Mit Erfahrungen aus der Zeitungsbranche im Hinterkopf suche er nach Guidelines, die beim Schreiben von Dokumentation helfen könnten.

• Zusammenfassung des zehnten Kommentars:

  • Es wird vorgeschlagen, den Gebrauch des Futurs zu vermeiden.
  • In Dokumentationen sei es besser, statt „wenn du dies tust, wird X passieren“ eher „wenn du dies tust, passiert X“ zu schreiben.