Ich muss technische Dokumente wie Handbücher, Berichte und Zeitschriftenartikel schreiben.
In letzter Zeit beginne ich Sätze mit „This“ “ viel Zeit. Beispiel:
Setzen Sie eine Markierungsboje am GPS-Standort des Ankers und eine andere am GPS-Standort des Rahmens ein. Dies erleichtert die Navigation erheblich.
oder
Die Protokolldateien werden analysiert für Kalibrierungseinstellungen und andere Metadaten. Dieser Vorgang kann bei sehr großen Dateien einige Minuten dauern.
oder
Wenn neue Batterien eingelegt wurden, muss das Magnetometer neu kalibriert werden. Dieser Vorgang ähnelt der Neukalibrierung, die häufig bei Verwendung eines Smartphone-Kompasses erforderlich ist.
Sind diese Sätze in Ordnung oder gibt es andere Satzkonstruktionen, die besser lesen? Sollte ich es einfach akzeptieren und weitermachen?
Kommentare
- Technische Dokumente sollten aus Gründen der Klarheit geschrieben werden, nicht aus Gründen der Eleganz oder des höheren Stils. Ich denke, die von Ihnen angegebenen Beispiele sind klar und erfordern weniger kognitive Verarbeitung als die Alternativen. Ich sage, bleib bei ihnen und mach weiter.
- Das erleichtert die Navigation erheblich. Das würde bla machen. Das macht die Navigation bla. Wahrlich, wahrlich, ich sage Ihnen, dass dies die Navigation viel einfacher machen würde.
Antwort
Es gibt eine Ein deutlicher Vorteil, wenn Sie weiterhin das tun, was Sie bisher getan haben.
Dies ist die Wiederholung des Musters
Weisen Sie den Leser an, sofort eine Aktion auszuführen.
gefolgt von
Beschreibung / Kommentar zum Ergebnis und / oder Nutzen der Aktion,
verringert die kognitive Belastung Ihrer Leser: Sie müssen nicht ständig die zusätzliche Arbeit der Interpretation einer Sorte ausführen von Präsentationsformaten und Satzstrukturen, um die Anweisungen aus den Beschreibungen zu sortieren oder ihre gegenseitigen Beziehungen zu verstehen.
Die Art und Weise, wie Sie derzeit Informationen zum Lesen präsentieren Mit ers können sie sofort wissen, was von ihnen erwartet wird und warum.
Die Tatsache, dass ein Satz mit „Dies“ beginnt, ist tatsächlich ein nützliches Signal für Ihre Leser, dass das, was folgen wird, wahrscheinlich eine Beschreibung oder ein Kommentar zu einer Aktion ist, zu deren Ausführung Sie sie gerade aufgefordert haben.
Dieser Aspekt der Präsentation von Material ist eine wichtige Art und Weise, in der sich die technische Dokumentation von der literarischen Fiktion unterscheidet.
Je nach Stil des Fiktionsautors hängt ein Teil der Freude am Lesen von Fiktion ab Sie werden von unerwarteten Gegenüberstellungen und kleinen Rätseln überrascht, von denen einige durch Variation der Art und Weise, wie das Material dem Leser präsentiert wird, erstellt oder faszinierender werden.
In Ihrem Fall zielen Sie (oder sollten) Für das gegenteilige Ergebnis: Die Vorhersehbarkeit Ihrer Präsentation und die Klarheit des Verständnisses Ihrer Leser gehen Hand in Hand. Die relative Kürze der Sätze und die Wiederholbarkeit des Formats in Ihrer Dokumentation verringern den Spielraum für unbeabsichtigte Mehrdeutigkeiten.
Es lohnt sich, in min d Ein wichtiger Grund, um Unklarheiten in der technischen Dokumentation zu vermeiden: Es ist nicht nur ärgerlich, es kann sogar gefährlich oder schädlich sein, wenn ein Leser verwirrt ist, eine falsche Aktion auszuführen (z. B. das Einschalten eines Stromkreises, der nicht erregt werden sollte).
Kommentare
- @geometrikal – Es ‚ ist wahrscheinlich Eifersucht auf meine spitzen Ohren und meine süße kleine Nase.
- Eine ausgezeichnete Antwort @Erik Kowal. Deshalb habe ich es positiv bewertet 🙂
Antwort
Fast jedes Wort oder jede Phrase kann überbeansprucht werden, aber Das Benennen eines Themas (Agent, „Charakter“ oder Thema) in einem Satz und das anschließende Verweisen auf this im nächsten Satz ist eine hervorragende Möglichkeit, den Lesern eine Passage mit Klarheit und Leichtigkeit zu erleichtern. Es ist ein Beispiel für einen Haupttyp von Topic String , ein wichtiges Stilelement für das meiste gute Schreiben.
Es ist möglich, dass Sie manchmal eine bessere Formulierung finden, indem Sie normalerweise den vorhergehenden Satz um einen oder mehrere Sätze verlängern, aber – insbesondere wenn Sie komplexes Material behandeln – weniger lange Sätze kann Ihren Lesern helfen, zu verarbeiten. (An gut strukturierten langen Sätzen ist nichts auszusetzen, aber ich ziehe die Satzpaare in Ihren Beispielen jeder Kombination vor, die ich mir vorstellen kann.)
In der Fiktion mit viel Dialog sind wir es finden oft viele Vorkommen des Wortes gesagt. Es ist nicht automatisch besser, diese durchzugehen und zu versuchen, viele von ihnen durch alternative Verben zu ersetzen ( geweint, gemurmelt, emittiert usw.). Einige Wörter werden oft wiederholt, ohne auf Wiederholungen aufmerksam zu machen. Dies (!) Liegt daran, dass sie ihre beabsichtigten Funktionen gut und leise ausführen.
Antwort
Alle Sätze scheinen mir in Ordnung zu sein. Wenn Sie jedoch das „Dies“ am Anfang des zweiten Satzes entfernen möchten, können Sie den ersten Satz ein wenig umschreiben.
Zum Beispiel anstelle von
Setzen Sie eine Markierungsboje am GPS-Standort des Ankers und eine andere am GPS-Standort des Ankers ein Rahmen. Dies erleichtert die Navigation erheblich.
write
Bereitstellen einer Markierungsboje bei Die GPS-Position des Ankers und eine andere an der GPS-Position des Rahmens erleichtern die Navigation erheblich.
Anstelle von
Die Protokolldateien werden nach Kalibrierungseinstellungen und anderen Metadaten analysiert. Dieser Vorgang kann bei sehr großen Dateien einige Minuten dauern.
Schreiben
Das Parsen der Protokolldateien auf Kalibrierungseinstellungen und andere Metadaten kann bei sehr großen Dateien einige Minuten dauern.
Meiner Meinung nach ist das dritte Beispiel wahrscheinlich das beste links, wie Sie es zitiert haben.
Kommentare
- Wie Sie wahrscheinlich feststellen, ändern Ihre Alternativen die Bedeutung der ursprünglichen Satzpaare. Ihre erste Änderung verliert die Hauptfunktion des Originals: Anweisung zur Bereitstellung. Ihre zweite Änderung verliert die Hauptfunktion des Originals: Sie werden darüber informiert, dass eine Analyse durchgeführt wird.
- Bei der ersten können Sie die passive Sprache verwenden: Die Navigation wird durch den Vorgang vereinfacht. Allerdings nicht der größte Satz. Wie wäre es mit “ Bei sehr großen Dateien kann dieser Vorgang einige Minuten dauern. „?