Inhalte überprüfen
Eine der wichtigsten Möglichkeiten, wie Sie einen Rohentwurf überarbeiten können, besteht darin, den Inhalt zu überprüfen—wie offensichtlich ist das! Alle guten Übergänge, gute Organisation und klare Satzstruktur der Welt können einem technischen Dokument nicht helfen, das nicht den richtigen Inhalt hat. Der Inhalt eines technischen Dokuments kann "falsch" in mehreren Weisen sein:
- Es kann ganz fehlen: Stellen Sie sich zum Beispiel vor, dass jemand einen Bericht über "virtuelle Gemeinschaften" geschrieben hat, aber nie erklärt hat, was dieser Begriff bedeutet. Es wäre von Anfang an schwierig.
- Es ist da, aber nicht genug davon: Nehmen wir dasselbe Beispiel—stellen Sie sich vor, der Autor hätte nur einige vage Aussagen über virtuelle Gemeinschaften gemacht. Was benötigt wurde, war mindestens ein Absatz zu diesem Thema, wenn nicht sogar ein vollständiger 3- oder 4-seitiger Abschnitt.
- Es ist da, aber auf dem falschen Niveau für das Publikum: Es ist auch möglich, Informationen auf dem falschen Niveau in Bezug auf das Wissen, den Hintergrund oder die Bedürfnisse der Leser zu präsentieren. Stellen Sie sich vor, der Autor hätte einen 3-seitigen Abschnitt über Daten-Caching hinzugefügt, der für den Produktentwickler (ein "Experten" Publikum) geschrieben wurde, während der Bericht tatsächlich für Nichtspezialisten gedacht war.
Wenn Sie ein Gefühl dafür bekommen, wie unzureichend die Informationen in einem Rohentwurf des Berichts sind, sollten Sie gut darauf vorbereitet sein, zu wissen, was genau zu tun ist, um zu überarbeiten. Ein nützliches Brainstorming-Tool ist, in Begriffen von Typen von Inhalt.
Verwenden Sie die bereitgestellten Fragen in Dokumenteninhalt um Ihren Rohentwurf auf Arten von Informationen zu überprüfen, die hinzugefügt oder geändert werden sollen.
Überprüfen Sie die Struktur Ihrer Inhalte
Es gibt zwei Möglichkeiten, die Organisation von Informationen in einem Dokument zu betrachten:
- Einer, der im nächsten Abschnitt behandelt wird, besteht darin, die Reihenfolge der Informationsstücke zu betrachten und zu prüfen, ob sie in der richtigen Reihenfolge sind.
- Ein weiteres betrifft die Informationslevels. Man kann sich die Sätze oder Absätze in einem Rohentwurf anschauen und sehen, dass einige Sätze eine tiefere Diskussion über das Thema führen als andere. Andere Sätze dienen als das Gerüst, auf dem diese tiefergehenden Sätze basieren. Indem man die Struktur auf diese Weise betrachtet, überprüft man nicht nur die Organisation, sondern erhält auch viele gute Ideen, wie man den Inhalt des Textes verbessern kann.
Eine viel detailliertere Erklärung finden Sie unter Koordination und Subordination in Absätzen.
Überprüfen Sie die Organisation
Wenn Sie die richtigen Inhalte in einem Bericht haben, haben Sie zumindest schon einmal das ganze "richtige Zeug" für die Leser zur Verfügung. Allerdings könnte es dennoch unzureichend organisiert sein—, wie wenn Sie gerade umgezogen sind und alles ein Durcheinander oder noch in Kartons ist. Sie benötigen zwei wesentliche Fähigkeiten, um die Organisation eines Rohentwurfs zu überprüfen:
- Identifizieren Sie das Thema von Informationsstücken auf verschiedenen Ebenen. Um die Organisation einer Reihe von Absätzen zu bewerten, beginnen Sie damit, ein Wort oder eine Phrase zu finden, um das Thema jedes Absatzes—anders ausgedrückt, um einen Überblick über jeden einzelnen zu bekommen. Dann treten Sie von diesen Wörtern oder Phrasen zurück und überlegen, ob sie in der richtigen Reihenfolge sind. Das ist jedoch nur eine Ebene. Sie können auch betrachten innerhalb einen einzelnen Absatz für seine Organisation. In diesem Fall identifizieren Sie das Thema jedes Satzes und berücksichtigen die Reihenfolge dieser Sätze.
- Wählen Sie die beste Reihenfolge für Informationschunks aus. Sobald Sie das Thema jedes Informationsstücks (auf welchem Niveau auch immer Sie untersuchen) kennen, können Sie entscheiden, ob sie in der richtigen Reihenfolge sind. Diese Entscheidung beinhaltet das Wissen über die gängigen Sequenzmuster; hier sind einige Beispiele:
- Allgemein → spezifisch: Eine gängige Möglichkeit, zu organisieren, besteht darin, Inhalte von allgemein nach spezifisch anzuordnen. Zum Beispiel, das Definieren alle Solar-Collector ist eine allgemeinere Diskussion als die verschiedenen Arten von Solar-Collectoren zu besprechen. Und die Funktionsweise eines bestimmten Typs von Solar-Collector zu beschreiben, ist noch weniger allgemein. Dieses Muster wird hier veranschaulicht:
Überarbeitung mit dem allgemeinen-zum-spezifischen Organisationsmuster. Es ist eine natürlichere Vorgehensweise, zunächst zu definieren, was alle Sonnenkollektoren tun, und dann zu ihren verschiedenen Typen überzugehen. - Einfach, grundlegend → komplex: Eine weitere Möglichkeit, die Einheiten einer Diskussion anzuordnen, besteht darin, mit den einfachen, grundlegenden, fundamentalen zu beginnen und dann zu den komplexeren und technischen überzugehen.
- Ruheobjekt → Bewegungsobjekt: Ein weiteres Organisationsmuster besteht darin, zuerst das Ding zu beschreiben (als ob in einem Foto), um dann seine Funktionsweise oder den Prozess zu diskutieren (als ob in einem Video). Dieser Ansatz könnte gut funktionieren für eine Diskussion über ein Kraftstoffeinspritzsystem.
- Räumliche Bewegung: — Wenn Sie die physischen Details von etwas beschreiben, möchten Sie möglicherweise ein Muster physischer Bewegung verwenden, zum Beispiel von oben nach unten, von links nach rechts oder von außen nach innen.
- Zeitliche Bewegung: — Eines der häufigsten Muster basiert auf der Bewegung durch die Zeit; ordnen Sie die Diskussion der Ereignisse in Bezug auf die zeitliche Reihenfolge an.
- Konzept → Anwendung des Konzepts, BeispieleEin häufiges organisatorisches Muster besteht darin, ein Konzept zunächst im Allgemeinen zu besprechen und dann eine Anwendung davon zu erörtern. Zum Beispiel wird in einem anderen Kapitel dieses Buches zunächst die Konzeptualisierung von Vorschlägen behandelt und anschließend Beispiele für Vorschläge besprochen.
- Daten → Schlussfolgerungen: Ein weiteres Mittel zur Organisation von Informationen besteht darin, Daten (Beobachtungen, experimentelle Daten, Umfrageergebnisse) zu präsentieren und anschließend zu den Schlussfolgerungen überzugehen, die aus diesen Daten gezogen werden können. (Und dieses Muster wird manchmal umgekehrt: Zuerst die Schlussfolgerung präsentieren, dann die Daten, die sie unterstützen.)
- Problem, Frage → Lösung, Antwort: Sie können Informationen auch organisieren, indem Sie zunächst ein Problem diskutieren oder eine Frage aufwerfen und dann zur Lösung oder Antwort übergehen.
- Vereinfachte Version → detaillierte Version: Eine nützliche Möglichkeit, technische Angelegenheiten Nicht-Spezialisten zu erklären, besteht darin, zunächst eine vereinfachte Version des Themas zu besprechen, ein fundiertes Verständnis dafür zu schaffen und dann gleich wieder zurückzukehren, um alles noch einmal zu erklären, aber diesmal die technischen Details dick und schwer aufzutragen!
- Wichtigste → am wenigsten wichtig: Eine "rhetorische" Methode der Organisation besteht darin, mit den wichtigsten, auffälligsten und dramatischsten Informationen zu beginnen und dann zu Informationen überzugehen, die zunehmend weniger bedeutend sind. (Und dieses Muster kann umgekehrt werden: Man kann sich auf einen Höhepunkt hinarbeiten, anstatt damit zu beginnen.)
- Überzeugendste → am wenigsten überzeugend: — Ähnlich können Sie mit dem überzeugendsten Argument für Ihre Position anfangen—um die Aufmerksamkeit aller zu gewinnen—und dann zu weniger und weniger überzeugenden Argumenten übergehen. (Dieses Muster kann auch umgekehrt werden: Sie können sich zu Ihren überzeugendsten Argumenten hinarbeiten.)
- Allgemein → spezifisch: Eine gängige Möglichkeit, zu organisieren, besteht darin, Inhalte von allgemein nach spezifisch anzuordnen. Zum Beispiel, das Definieren alle Solar-Collector ist eine allgemeinere Diskussion als die verschiedenen Arten von Solar-Collectoren zu besprechen. Und die Funktionsweise eines bestimmten Typs von Solar-Collector zu beschreiben, ist noch weniger allgemein. Dieses Muster wird hier veranschaulicht:
Dies sind nur einige Möglichkeiten. Wenn das Ziel informativ ist, ordnen Sie Informationen so an, dass Sie sicherstellen, dass die Leser die Grundlagen verstehen, bevor sie zu den komplizierteren, technischen Themen übergehen. Wenn das Ziel überzeugend ist, arrangieren Sie die Inhalte, um die überzeugende Wirkung auf die Leser zu maximieren, indem Sie beispielsweise die stärksten Argumente zuerst anbringen.
Und in jedem Fall solltest du vermeiden, diese Ansätze zu vermischen—zum Beispiel, einige Daten wegzulassen, dann einige Schlussfolgerungen zu ziehen und dann in einer willkürlichen Weise hin und her zu wechseln. Halte die Äpfel von den Orangen getrennt!
Stärken Sie die Thema-Sätze und Übersichten.
Eine der besten Maßnahmen, die Sie ergreifen können, ist, durch einen Rohentwurf zurückzugehen und zu überprüfen, ob Sie an wichtigen Stellen thematische Sätze und Übersichten einfügen können. Wenn wir schreiben, sind wir normalerweise nicht genau sicher, wohin ein Absatz oder Abschnitt in Bezug auf seinen Inhalt und seine Logik führen wird. Sobald er " dorthin gelangt ist, " ist es oft notwendig, zum Anfang zurückzukehren und eine Art Übersicht hinzuzufügen oder das, was bereits vorhanden ist, zu modifizieren, um die Übersicht klarer zu machen. Leser müssen wissen, wohin sie in einem Bericht gehen, was als Nächstes kommt und, um das klarzustellen, wo sie gerade waren.
Einen Überblick in einem Bericht zu haben, ist wie eine Karte zu besitzen, wenn man in einer neuen Stadt ist. Themensätze und Übersichten bieten eine Perspektive darauf, was wo ist: das Thema, die Unterthemen, den Zweck der bevorstehenden Diskussion, ihre Beziehung zum vorherigen Abschnitt und zum Dokument als Ganzes. (Einige davon betreffen Übergänge, was das nächste zu überprüfende Element ist.)
Für eine ausführliche Behandlung dieses Themas siehe Themenüberschriften und Übersichten.
Stärken Sie die Kohärenz, Übergänge
Sie können die richtigen Informationen in einem Bericht haben und diese richtig organisieren, aber trotzdem kann etwas Wichtiges schiefgehen. Die Leser können den "Fluss"der Ideen übersehen, Schwierigkeiten haben, zu erkennen, wie die Informationshäppchen miteinander verbunden sind. Was die Leser brauchen, ist eine kontinuierliche Anleitung—, die Sie als Schriftsteller bereitstellen. Und was Sie verwenden, um diese Anleitung zu geben, nennt man Übergänge—, verschiedene Mittel, die den Lesern durch ein Dokument helfen. Es gibt (oder sollte jedenfalls geben) eine Logik, die jeden Satz in einem Dokument verbindet und eine bestimmte Reihenfolge für diese Sätze diktiert.
Siehe das Kapitel über Kohärenz und Übergänge für eine detaillierte Diskussion und Beispiele.
Überprüfen Sie die Absatzlänge.
Eine letzte Möglichkeit, deinen Entwurf auf struktureller Ebene zu überprüfen, besteht darin, zu prüfen, wie du die Absatzumbrüche definiert hast. Absätze sind seltsame Wesen—einige Schriftsteller glauben, sie existieren nicht und sind nur willkürliche Trennpunkte, die Autoren eintäuft, wann und wo sie wollen. Sorry—in technischer Schreibweise ist der Absatz ein wichtiger Akteur im Kampf um Klarheit und Verständnis. Auch wenn es nicht immer möglich ist, sollten Absätze dort auftreten, wo es einen Wechsel im Thema oder Unterthema gibt oder einen Wechsel in der Art und Weise, wie ein Thema diskutiert wird.
Auf einer einzeiligen, voll beschriebenen Seite, suche nach mindestens einem bis vier Absatzumbrüchen—es gibt nichts Magisches an diesem Durchschnitt, also behandle es nicht, als wäre es Gesetz. Sieh dir einfach die langen Absätze noch einmal an und prüfe die Möglichkeit von Absatzumbrüchen.
Ich würde Ihre Gedanken, Reaktionen und Kritiken zu diesem Kapitel schätzen: deine Antwort—David McMurrey.
