Prinzipien für sauberes Technical Writing

 (insight.infograb.net)
49 Punkte von ironlung 2023-04-19 | 5 Kommentare | Auf WhatsApp teilen

  1. Schreiben Sie statt in einem übertrieben förmlichen Stil lieber in einer alltagssprachlichen, gesprächsnahen Tonlage.

  2. Lesen Sie den Text laut vor und prüfen Sie, ob er sich anhört, als würde ihn ein echter Mensch sagen.

  3. Behalten Sie die Interessen der Nutzer, ihre Eigenschaften, ihr Bildungs- und Erfahrungsniveau, die Zeit und den Ort des Lesens sowie ihr Arbeitsumfeld im Blick.

  4. Wählen Sie Informationen aus, die Nutzer wahrscheinlich wissen möchten und die sie tatsächlich brauchen.

  5. Bedenken Sie, dass nicht alle Nutzer das Produkt und die zugehörigen Technologien so gut kennen wie Experten.

  6. Auch nach der Veröffentlichung des Textes sollten Begriffe, Nutzungshinweise und Funktionsänderungen rechtzeitig eingearbeitet werden.

  7. Verwenden Sie keine unnötigen Ausschmückungen.

  8. Verwenden Sie keine doppelten Passivkonstruktionen.
    Beispiel: japyeojida (→ japhida), sseuyeojida (→ sseuida), ilkhyeojida (→ ilkhida), boyeojida (→ boida), ijhyeojida (→ ijhida), jjitgyeojida (→ jjitgida)

  9. Setzen Sie nach Wörtern wie „mehrere“, „viele“, „verschiedene“ oder „alle“ keine zusätzliche Pluralmarkierung mehr.

  10. Wenn ein Fachbegriff unbedingt nötig ist, erklären Sie ihn im Text.

  11. Wenn Sie für Personen aus einer bestimmten Branche oder Berufsgruppe schreiben, verwenden Sie die dort üblichen Begriffe.

  12. Wenn der Text fertig ist, machen Sie eine Pause und lesen Sie ihn danach noch einmal.

  13. Wenn Sie den Text am Desktop geschrieben haben, lesen Sie ihn auf dem Smartphone oder Tablet. Sie können ihn auch ausdrucken und lesen.

  14. Lesen Sie den Text laut vor und prüfen Sie, wie er klingt.

  15. Überarbeiten Sie Sätze, die sich beim Sprechen unbequem anfühlen oder unnatürlich klingen.

  16. Fragen Sie Reviewer, ob der Inhalt gut verständlich ist, ob der Textfluss stimmt und ob etwas ergänzt werden sollte. Sie können auch gezielt nach den Punkten fragen, zu denen Sie Feedback brauchen.

  17. Wenn Sie im Text eine bestimmte Funktion behandelt haben, testen Sie, ob diese Funktion wie im Text beschrieben arbeitet.

  18. Prüfen Sie, ob Funktions- und Menünamen sowie Bildschirminhalte mit dem Text übereinstimmen.

  19. Prüfen Sie mit einer Rechtschreibprüfung Tippfehler und Fehler bei der Worttrennung.
    Empfohlene Tools: Rechtschreibprüfung der Pusan National University, Rechtschreibprüfung von Daum

  20. Prüfen Sie anhand der Beispiele zur Fremdwortschreibung des National Institute of Korean Language, ob es Fehler bei der Schreibweise von Fremdwörtern gibt.

Verwandte Beiträge

5 Kommentare

 
princox 2023-04-20

Fehler bei der Schreibweise von Fremdwörtern sind wirklich ein ziemliches Problem,,
Begriffe wie method und angel werden oft so geschrieben, obwohl sie eigentlich anders transkribiert werden müssten.

Das Problem ist, dass die „falsche Schreibweise“ noch häufiger verwendet wird und sogar bei SEO besser abschneidet … eine völlig absurde Situation.

Was ist denn nun die richtige Antwort..? schluchz
 
roxie 2023-04-23

Ich denke, das Problem ist eine Notation, die die Realität nicht widerspiegelt.
 
ah2dius 2023-04-21

https://meetup.nhncloud.com/posts/355

Das ist vielleicht nicht die einzig richtige Antwort, aber es lohnt sich, es als Referenz anzusehen~
 
princox 2023-04-20

Korrekt erscheint jeweils als "Methode" und "Angel".
Außerdem wird im Fall von Objekten bei Microsoft auch die bereinigte Bezeichnung "Objekt" verwendet.

Technical Writing ist wirklich sehr schwierig.
 
pugh123 2023-04-19

Vielen Dank für den guten Inhalt.