Die Kunst der Überarbeitung – Wie Entwickler technische Dokumentation schreiben

• Überarbeitung (推敲): Beim Schreiben einen Text mehrfach durchdenken, korrigieren und verfeinern. Oder der Vorgang selbst

• Warum Überarbeitung nötig ist

• Tipps zur Überarbeitung

→ Dem eigenen Text Fremdheit verleihen: laut vorlesen, nach einiger Zeit erneut lesen, ausdrucken und auf Papier lesen

→ Peer Review

→ Checklisten nutzen

→ Tipps zum Überarbeiten von Sätzen für bessere Lesbarkeit

① In kurze Sätze aufteilen und überarbeiten

② Unnötige Formulierungen streichen

③ In einen logisch aufgebauten Text verwandeln

[budlebee]

Das erinnert mich an Stephen Kings Grundsätze zum Schreiben. Da es sich um Romane handelt, gibt es sicher Unterschiede zum Technical Writing, aber frei aus dem Gedächtnis aufgeschrieben:

• Verwende kurze und einfache Sätze.

• Ich schreibe einen ersten Entwurf, lege ihn in die Schublade und hole ihn nach sechs Monaten wieder heraus, um ihn noch einmal zu lesen.

• In der überarbeiteten Fassung streiche ich 10 % des ersten Entwurfs.

• Wenn man den Text laut vorliest, kann man holprige Stellen im Satzbau erkennen.

• Schreibe mit einer klar definierten Zielperson vor Augen. In meinem Fall ist das meine Frau.

[xguru]

In letzter Zeit schreiben die Leute vom Technical Writing bei Kakao Enterprise viele gute Beiträge. Ich empfehle, den Blog zu abonnieren!