Technical Writing Essentials

Deskriptives technisches Schreiben verwendet eine Kombination aus Bildern und Text, um dem Leser die zu vermittelnden Informationen sowohl zu „zeigen“ als auch zu „erzählen“. Wie kreativere Beschreibungen greifen auch technische Beschreibungen manchmal auf die „fünf Sinne“ und metaphorische Vergleiche (Analogien) zurück, um dem Leser zu ermöglichen, sich das Beschriebene vollständig vorzustellen. Häufiger jedoch stützen sie sich auf konkrete, messbare Deskriptoren. Technische Beschreibungen können viele Formen annehmen, je nach Zweck und Zielgruppe. Beschreibungen können von einem kurzen Satz bis zu einem Absatz, einem ganzen Abschnitt eines Berichts oder einem ganzen Handbuch reichen. Schlecht geschriebene technische Beschreibungen können Verwirrung stiften, Zeit verschwenden und sogar zu einer Katastrophe führen! Technische Produktbeschreibungen sind oft gesetzlich vorgeschrieben, um Sicherheit und Konformität zu gewährleisten. Die Liebe zum Detail ist entscheidend.

Produktspezifikationen erfordern detaillierte Beschreibungen von Konstruktionsmerkmalen; Anleitungen erfordern oft spezifische beschreibende Details, um dem Leser zu „zeigen“, was zu tun ist. Zu den allgemeinen Kategorien technischer Beschreibungen gehören die folgenden:

• Mechanismusbeschreibungen: bieten einen detaillierten Überblick über die physikalischen Aspekte eines Werkzeugs, einer Maschine oder eines anderen mechanischen Geräts mit beweglichen Teilen, das für eine bestimmte Funktion ausgelegt ist. Dabei kann es sich um Produktbeschreibungen für den Verkauf oder die Herstellung, die Dokumentation von Konstruktionsspezifikationen, Infografiken usw. handeln.
• Prozessbeschreibungen: beschreiben eine Reihe von Ereignissen (natürliche/biologische/ökologische, mechanische, soziale oder psychologische Phänomene), die in einer bestimmten Reihenfolge ablaufen, um ein bestimmtes Ergebnis zu erzielen. Diese können in nicht-unterrichtliche Prozesse (z. B. eine Prozessanalyse der Funktionsweise eines Verbrennungsmotors oder natürliche Prozesse wie die Photosynthese) und in unterrichtliche Prozesse (z. B. empfohlene/erforderliche Verfahren und explizite Schritt-für-Schritt-Anweisungen, die zu befolgen sind) unterteilt werden. (Ausführliche Informationen über das Verfassen von Anleitungen finden Sie in Abschnitt 7.7).
• Definitionen: klären die spezifische Bedeutung, oft bezogen auf einen bestimmten Kontext, oder drücken das Wesen der definierten Begriffe aus. Sie können von einem einfachen klärenden Satz bis zu einem mehrseitigen Dokument reichen. Definitionen enthalten oft detaillierte Beschreibungen und Bilder zur Veranschaulichung von Ideen. Klicken Sie auf den unten stehenden Link, um eine PowerPoint-Präsentation für Schüler zu sehen, die zeigt, wie man effektive Definitionen für technische Zwecke verfasst. Diese Präsentation wurde mit ausdrücklicher Genehmigung des Schülers aufgenommen.

Definitionen in technischen Texten – Musterpräsentation eines Schülers (.pdf)

Beschreibungen von Mechanismen sollten ein klares Verständnis des beschriebenen Objekts vermitteln, einschließlich

• Allgemeines Aussehen und physikalische Eigenschaften
• Gesamtfunktion/Zweck
• Bestandteile
• Wie die Teile zusammenwirken, um ein funktionierendes Ganzes zu bilden.

Der Leser sollte in der Lage sein, sich ein klares Bild von dem beschriebenen Objekt zu machen und somit zu verstehen, was es tut und wie es funktioniert.

Um diese Klarheit für den Leser zu erreichen, muss der Autor wichtige Details auswählen und die Informationen logisch gliedern. Wähle Details, die präzise und messbar beschrieben werden können, wie

Abhängig von den Bedürfnissen des Lesers kann die Beschreibung von einem allgemeinen Überblick, der nur wenige Sätze erfordert, bis zu einem Handbuch mit mehreren Kapiteln reichen, in dem jeder Aspekt der Teile und Funktionen des Mechanismus detailliert beschrieben wird, um technische Probleme zu beheben und Reparaturen durchzuführen. Ein unterhaltsames Beispiel für Letzteres ist das Star Trek: The Next Generation: Technical Manual (Umschlag in Abbildung 7.4.1), das detaillierte Beschreibungen aller an Bord der fiktiven U.S.S. Enterprise-D verwendeten Geräte und Technologien enthält.

Bevor Sie mit dem Entwurf Ihrer Beschreibung beginnen, müssen Sie sich Gedanken über Ihren Zweck und Ihre Zielgruppe machen: Warum braucht Ihr Publikum diese Beschreibung? Wofür wird sie verwendet? Beschreiben Sie verschiedene Arten von Solarmodulen für den Durchschnittsverbraucher, um ihm bei der Auswahl des für seine Bedürfnisse am besten geeigneten Moduls zu helfen? Geben Sie Technikern und Installateuren Schaltpläne an die Hand?

Wenn Sie Ihren Zweck und Ihre Zielgruppe klar vor Augen haben, entwerfen Sie eine Beschreibung, die die folgenden Elemente enthält:

1. Definition: Worum handelt es sich, und was ist sein Hauptzweck?
2. Überblick: Beschreiben Sie das allgemeine Erscheinungsbild des Mechanismus („big picture“).
3. Komponenten: Beschreiben Sie die Hauptbestandteile in beschrifteten Abschnitten; achten Sie dabei sorgfältig auf die Reihenfolge der Informationen. Stelle eine logische Verbindung zwischen den einzelnen beschriebenen Komponenten her.
4. Erläuterung: Wie arbeiten die Teile zusammen, um die Funktion zu erfüllen? Welche Grundprinzipien bestimmen seine Funktionsweise? Überlegen Sie, wie viele Details hier für Ihr Zielpublikum notwendig sind.
5. Visuelles: Fügen Sie Grafiken ein, die den Mechanismus und/oder seine Teile klar illustrieren. Zeigen Sie das Gerät als Ganzes; erwägen Sie, bestimmte Details in erweiterten Ansichten, Ausschnitten oder beschrifteten Diagrammen zu zeigen. Sie können sogar Videos einbetten oder verlinken, die das Gerät in Aktion zeigen.
6. Fazit: Je nach Zweck können Sie die Geschichte des Produkts, die Verfügbarkeit, die Herstellung, die Kosten, die Warnhinweise usw. erläutern.
7. Referenzen: Quellen, die Sie in Ihrer Beschreibung verwendet haben, oder zusätzliche verfügbare Informationsquellen (falls relevant).

Sie können eine Vorlage verwenden, wie z. B. die nachstehende Vorlage für eine technische Beschreibung, wobei Sie bedenken sollten, dass Vorlagen zwar hilfreiche Leitfäden sein können, aber nicht viel Flexibilität bieten und möglicherweise nicht für alle Situationen geeignet sind.

Beispielbeschreibungen

Untersuchen Sie die Beschreibung der „Up Goer Five“ in Abbildung 7.4.2 (für eine größere Version auf das Bild klicken). Wer könnte die Zielgruppe sein?

Vergleiche die Beschreibung in Abbildung 7.4.2 mit den Informationen auf der NASA-Website über den Mars Curiosity Rover.

Beachte die Unterschiede im Detailgrad, im Wortschatz und im allgemeinen Zweck der Beschreibungen. Wenn Sie die Informationen auf der NASA-Website verwenden, um die Vorlage für die technische Beschreibung auszufüllen, könnten Sie am Ende so etwas wie die folgende Tabelle erhalten. Ziele

Es kann sein, dass einige dieser Elemente nicht notwendig sind; auch hier sollten Sie bedenken, was Ihre Zielgruppe bereits weiß. Achten Sie darauf, dass Sie nicht unnötigerweise das Offensichtliche erklären oder fälschlicherweise annehmen, dass Ihre Leser über Kenntnisse verfügen, die ihnen fehlen.

Beim Verfeinern der Details Ihrer Beschreibung und ihrer Bestandteile sollten Sie Folgendes beachten:

• Organisation: Verwenden Sie ein logisches Prinzip, um Ihre Beschreibung zu gliedern
  • von oben nach unten (oder von unten nach oben)
  • von links nach rechts (oder von rechts nach links)
  • von innen nach außen (oder von außen nach innen)
  • von den wichtigsten zu den unwichtigsten Merkmalen
  • von der zentralen Komponente zur Peripherie
  • von den Materialeigenschaften usw.
• Sprache: Verwenden Sie spezifische, präzise, konkrete Begriffe – vermeiden Sie vage oder übermäßig allgemeine Begriffe
  • Verwenden Sie eine korrekte Terminologie – definieren Sie die Begriffe so, wie es für Ihr Publikum notwendig ist
  • Verwenden Sie Analogien, um eine unbekannte Sache mit Hilfe einer bekannten Sache zu beschreiben
  • Verwenden Sie eine objektive Sprache – keine „ad speak“ oder subjektive Begriffe
  • Verwenden Sie Präsens, aktive Verben, um zu beschreiben, wie das Gerät aussieht und was es tut
  • Verwenden Sie Wörter, die lebendige und spezifische Bilder im Kopf des Lesers erzeugen.

Wählen Sie einen gewöhnlichen, alltäglichen Gegenstand (z. B. einen der Gegenstände in Abbildung 7.4.3) und verfassen Sie eine technische Beschreibung für ein Publikum, das mit diesem Gegenstand nicht vertraut ist. Beginnen Sie damit, sich eine Zielgruppe und einen Zweck vorzustellen, und versuchen Sie dann, die Vorlage für die technische Beschreibung mit detaillierten Informationen auszufüllen. Erstellen Sie anhand der Informationen in Ihrer Vorlage eine kurze Beschreibung von 1-2 Absätzen und fügen Sie Bildmaterial mit korrekten Untertiteln hinzu.