Bitte klicken Sie hier, um zu helfen. David McMurrey bezahlen für Webhosting:
Spende jeden kleinen Betrag, den du kannst!
Online-Technikschreiben bleibt kostenlos.
Technische Dokumente (einschließlich Handbücher, White Papers und Leitfäden) haben je nach Branche, Beruf oder Organisation unterschiedliche Designs. Dieses Kapitel zeigt Ihnen ein traditionelles Design. Wenn Sie einen Kurs in technischer Dokumentation belegen, stellen Sie sicher, dass das in diesem Kapitel vorgestellte Design akzeptabel ist. Das Gleiche gilt, wenn Sie ein technisches Dokument im Kontext von Wissenschaft, Wirtschaft oder Regierung schreiben.
NotebookLM-generierte Infografik dieses Kapitels
Hinweis: Seit Jahren bezeichnete dieses Online-Lehrbuch für technische Dokumentation Berichte generisch als praktisch alles, was technische Informationen enthält. Aber da "Bericht" sich auf ein spezifisches Genre technischer Dokumente bezieht, musste die Änderung auf das generische "Techdoc", kurz für technisches Dokument, vorgenommen werden.
Techdocs (allgemeine Bezeichnung für technische Dokumente) haben wie jede andere Art von Projekt Spezifikationen. Die Spezifikationen für Techdocs betreffen Layout, Organisation und Inhalt, das Format von Überschriften und Listen, das Design der Grafiken und so weiter. Der Vorteil einer erforderlichen Struktur und eines Formats für Techdocs ist, dass Sie oder jeder andere erwarten kann, dass sie auf vertraute Weise gestaltet sind—man weiß, wonach man suchen muss und wo man danach suchen kann. Techdocs werden in der Regel in Eile gelesen—die Menschen sind in Eile, um zu den Informationen zu gelangen, die sie benötigen, den entscheidenden Fakten, den Schlussfolgerungen und anderen wesentlichen Elementen. Ein standardisiertes Techdoc-Format ist wie ein vertrauter Nachbarschaft.
Wenn Sie das Design eines Techdocs analysieren, beachten Sie, wie repetitiv einige Abschnitte sind. Diese Duplizierung hängt damit zusammen, wie Menschen Techdocs lesen. Sie lesen Techdocs nicht am Stück: Sie beginnen möglicherweise mit der Zusammenfassung, springen herum und lesen wahrscheinlich nicht jede Seite. Ihre Herausforderung besteht darin, Techdocs so zu gestalten, dass diese Leser Ihre wichtigsten Fakten und Schlussfolgerungen begegnen, egal wie viel von dem Techdoc sie lesen oder in welcher Reihenfolge sie es lesen.
Sei sicher und schau dir die Beispiel-Techdocs.
Die standardmäßigen Komponenten eines typischen technischen Berichts werden in diesem Kapitel behandelt. Die folgenden Abschnitte führen Sie durch jede dieser Komponenten und heben die wichtigsten Merkmale hervor. Während Sie diese Richtlinien lesen und anwenden, denken Sie daran, dass dies Richtlinien sind, keine Vorschriften. Verschiedene Unternehmen, Berufe und Organisationen haben ihre eigenen unterschiedlichen Richtlinien für technische Dokumente – Sie müssen Ihre Praxis an diese sowie an die hier präsentierten anpassen.
Übermittlungsnachricht
Die Übermittlungsnachricht ist entweder ein Begleitbrief (oder Memo) oder eine E-Mail. Der physische Brief (oder Memo) ist entweder mit einer Büroklammer außen am Techdok angeheftet oder innerhalb des Techdok gebunden. Die E-Mail enthält einen Link zum Techdok oder das angehängte Techdok. Es ist eine Kommunikation von dir—dem Techdok-Autor—an den Empfänger, die Person, die das Techdok angefordert hat und die dich vielleicht sogar für deine fachkundige Beratung bezahlt. Im Wesentlichen sagt es: "Okay, hier ist das Techdok, das wir vereinbart haben, dass ich es bis zu diesem und jenem Datum fertigstelle. Kurz gesagt, es enthält dies und das, deckt jedoch dies oder das nicht ab. Lass mich wissen, ob es deinen Bedürfnissen entspricht." Die Übermittlungsnachricht erklärt den Kontext—die Ereignisse, die zur Erstellung des Techdok geführt haben. Sie enthält Informationen über das Techdok, die nicht ins Techdok gehören.
Beispiele für ein Begleitschreiben und eine Begleitnachricht.
Im Beispiel des Übermittlungsschreibens beachten Sie das Standardformat für Geschäftskorrespondenz. Wenn Sie ein internes technisches Dokument schreiben, verwenden Sie stattdessen das Memorandum-Format; in beiden Fällen sind der Inhalt und die Organisation gleich:
Erster Absatz. Zitiert den Namen des Techdocs und setzt ihn in Kursivschrift. Es erwähnt auch das Datum der Vereinbarung, den Techdoc zu schreiben.
Mittlerer Absatz. Konzentriert sich auf den Zweck des Techdocs und gibt einen kurzen Überblick über die Inhalte des Techdocs.
Abschließender Absatz. Ermutigt den Leser, sich zu melden, wenn es Fragen, Kommentare oder Bedenken gibt. Es schließt mit einer Geste des guten Willens und drückt die Hoffnung aus, dass der Leser das Tech-Dokument als zufriedenstellend empfindet.
Wie bei jedem anderen Element in einem technischen Dokument müssen Sie möglicherweise den Inhalt dieser Nachricht (oder Mitteilung) für spezifische Situationen anpassen. Zum Beispiel möchten Sie vielleicht einen weiteren Absatz hinzufügen, in dem Fragen aufgeführt sind, die Sie den Lesern zur Überlegung anbieten möchten, während sie das technische Dokument überprüfen.
Umschläge, Titelseite und Etikett
Wenn Ihr Technisches Dokument über zehn Seiten umfasst, binden Sie es auf irgendeine Weise und erstellen Sie ein Etikett für das Cover.
Überzüge
Umschläge verleihen Technischen Dokumenten ein solides, professionelles Aussehen und bieten Schutz. Sie können aus vielen Arten von Umschlägen wählen. Beachten Sie diese Tipps:
- Völlig inakzeptabel sind die klaren (oder farbigen) Kunststoffhüllen mit der Kunststofftasche am linken Rand. Diese sind wie aus dem Englischunterricht für Erstsemester; außerdem sind sie nervig in der Handhabung—Leser müssen sich abmühen, sie offen zu halten und mit der statischen Elektrizität zurechtzukommen, die sie erzeugen.
- Marginal akzeptabel sind die Cover, bei denen Sie Löcher in die Seiten stanzen, die Seiten einlegen und die Ösen umbiegen. Wenn Sie diesen Typ verwenden, lassen Sie einen zusätzlichen halben Zoll Rand an der linken Kante, damit die Leser die Seiten nicht auseinanderdrücken müssen. Natürlich verhindert dieser Covertyp, dass die Seiten flach liegen: Die Leser müssen verfügbare Gegenstände greifen oder verschiedene Körperteile benutzen, um die Seiten beschwert zu halten.
- Die besten Cover sind ohne Zweifel die, die es ermöglichen, dass technische Dokumente von alleine offen liegen (siehe die Abbildung im nächsten Abschnitt). Es ist eine große Erleichterung, ein technisches Dokument auf dem Schoß oder auf dem Schreibtisch offen zu haben. Diese Art verwendet eine Plastikschnirkelbindung und dickes Kartonpapier für die Cover. Fragen Sie in Ihrem lokalen Copyshop nach diesen Arten von Bindungen; sie sind kostengünstig und erhöhen die Professionalität Ihrer Arbeit. Siehe das simulierte Beispiel einer Plastikschnirkelbindung im Folgenden.
Generell weniger bevorzugt sind losblättrige Notizbücher oder Ringordner. Diese sind für kurze technische Dokumente zu sperrig, und die Seitenlöcher neigen zum Reißen. Natürlich erleichtert der Ringordner das Wechseln der Seiten; wenn das die Art ist, wie Ihr technisches Dokument verwendet wird, dann ist es eine gute Wahl. Am "oberen Ende" stehen die übermäßig schicken Covers mit ihrem Kunstleder-Look und goldfarbener Verzierung. Vermeiden Sie sie—halten Sie es schlicht, einfach und funktional.
Titelseite
Im einfachsten Fall ist der Titel eines Techdokuments eine Kopie dessen, was auf dem Frontcover steht—möglicherweise mit einigen hinzugefügten Details.
Schau dir die Titelseite an. Zusammenfassung und Exekutive Zusammenfassung.
Etiketten
Stellen Sie sicher, dass Sie ein Etikett für das Cover Ihres Techdokuments entwerfen. Es ist ein Schritt, den einige Techdokumentationsautoren vergessen. Ohne ein Etikett ist ein Techdokument anonym; es wird ignoriert.
Der beste Weg, um ein Etikett zu erstellen, besteht darin, Ihre Textverarbeitungssoftware zu verwenden, um eines auf einer Standardseite mit einem grafischen Rahmen um die Etiketteninformationen zu gestalten. Drucken Sie es aus, und gehen Sie dann zu einem Copyshop und lassen Sie es direkt auf das Techdoc-Cover kopieren.
Auf dem Etikett steht nicht viel: der Titel des Techdokuments, Ihr Name, der Name Ihrer Organisation, eine Tracking-Nummer für das Techdokument und ein Datum. Es gibt keine standardmäßigen Anforderungen für das Etikett, obwohl Ihr Unternehmen oder Ihre Organisation eigene Anforderungen haben sollte. (Ein Beispiel für ein Techdokument-Etikett ist unten gezeigt.)
Übertragungsbrief und technische Dokumentationsabdeckung (mit Deckblatt-Etikett).
Zusammenfassung und Exekutive Zusammenfassung
Die meisten technischen Techniker-Dokumente enthalten mindestens eine Abstract—, manchmal zwei, in diesem Fall übernehmen die Abstracts unterschiedliche Rollen. Abstracts fassen die Inhalte eines Techniker-Dokuments zusammen, aber die verschiedenen Typen tun dies auf unterschiedliche Weise:
- Beschreibendes Abstract. Dieser Typ bietet einen Überblick über den Zweck und den Inhalt des Techdocs. In einigen Techdoc-Designs wird die beschreibende Zusammenfassung am Ende der Titelseite platziert, wie im Folgenden gezeigt:
Beschreibendes Abstract. Traditionell wird es auf der Titelseite platziert (nicht auf der Umschlagseite). - Zusammenfassende Darstellung. Eine weitere gängige Art ist die Executive Summary, die ebenfalls die wichtigsten Fakten und Schlussfolgerungen aus dem Techdoc zusammenfasst. Siehe das folgende Beispiel. Es ist, als hättest du mit einem gelben Marker die Schlüsselsätze im Techdoc markiert und sie dann auf eine separate Seite übertragen und für die Lesbarkeit bearbeitet. Typischerweise sind Executive Summaries ein Zehntel bis ein Zwanzigstel der Länge von Techdocs, die zehn bis fünfzig Seiten lang sind. Für längere Techdocs, die über fünfzig Seiten gehen, sollte die Executive Summary nicht länger als zwei Seiten sein. Der Zweck der Executive Summary ist es, eine Zusammenfassung des Techdocs zu bieten—etwas, das schnell gelesen werden kann.
Wenn Ihnen die Zusammenfassung, die Einleitung und die Übermittlungsnachricht repetitiv erscheinen, denken Sie daran, dass Leser nicht unbedingt am Anfang eines technischen Dokuments beginnen und Seite für Seite bis zum Ende lesen. Sie springen herum: Sie könnten das Inhaltsverzeichnis überfliegen; sie lesen normalerweise die Zusammenfassung für wichtige Fakten und Schlussfolgerungen. Möglicherweise lesen sie sorgfältig nur einen Abschnitt oder zwei aus dem Hauptteil des technischen Dokuments und überspringen den Rest. Aus diesen Gründen sind technische Dokumente mit gewissen Wiederholungen gestaltet, damit die Leser die wichtigen Informationen sicher sehen, egal wo sie ins technische Dokument eintauchen.
Inhaltsverzeichnis (was zuerst kommt) dann die Zusammenfassung.
Inhaltsverzeichnis
Egal welches Inhaltsverzeichnis (TOC) Format Sie verwenden, dies sind die allgemeinen Standards:
- Startseitenzahl nur. Obwohl einige automatische Inhaltsverzeichnis-Generatoren den Seitenbereich anzeigen, ist die Norm nur die erste Seitenzahl.
- Ebene der Überschriften, die einbezogen werden sollen. Wie im obigen Inhaltsverzeichnis gezeigt, zeigen Sie die obersten beiden Ebenen der Überschriften an, es sei denn, das technische Dokument hat viele Unterüberschriften. Das Inhaltsverzeichnis sollte eine schnelle Möglichkeit bieten, Informationen auf einen Blick zu finden.
- Abstände und Großschreibung. Beachten Sie, wie die Textelemente im Inhaltsverzeichnis oben eingerückt sind. Überschriften der ersten Ebene verwenden Großbuchstaben; Überschriften der zweiten Ebene verwenden Großbuchstaben am Anfang jedes Hauptwortes; Überschriften der dritten Ebene verwenden die Satzzeichen-Schreibung.
- Vertikaler Abstand. Beachten Sie, dass die Abschnittsüberschriften erster Ebene zusätzlichen Platz oben und unten haben, was die Lesbarkeit erhöht.
- Alle Seiten im Techdok (außer den Vorder- und Rückseiten) sind nummeriert; jedoch werden auf einigen Seiten die Nummern nicht angezeigt.
- Im zeitgenössischen Design verwenden alle Seiten im gesamten Dokument arabische Ziffern; im traditionellen Design verwenden alle Seiten vor der Einleitung (erste Seite des Haupttextes) kleine römische Ziffern.
- Auf speziellen Seiten, wie der Titelseite und Seite eins der Einleitung, werden die Seitenzahlen nicht angezeigt.
- Seitenzahlen können in einem von mehreren Bereichen auf der Seite platziert werden. In der Regel ist die beste und einfachste Wahl, die Seitenzahlen unten in der Mitte der Seite zu platzieren (denken Sie daran, sie auf speziellen Seiten auszublenden).
- Wenn Sie Seitenzahlen oben auf der Seite platzieren, müssen Sie sie auf Kapitel- oder Abschnittsanfangseiten verbergen, wo sich eine Überschrift oder ein Titel oben auf der Seite befindet.
- Enthält das Techdoc (Bericht) Folgendes (richtig formatiert) in dieser Reihenfolge: Übermittlungsnachricht; Titelseite; Inhaltsverzeichnis; Liste der Abbildungen, Tabellen oder beides; Einleitung; Hauptabschnitte (Kapitel); Anhänge (falls erforderlich); Informationsquellen; Rückseite (falls erforderlich). Für Details siehe Techdoc-Design.
- Während es clever und verspielt sein kann, gibt der Titel des Technologiedokuments angemessen das Thema an? Für Details siehe Technische Dokumentation Titel.
- Wenn das Inhaltsverzeichnis und die Abbildungs- (und Tabellen-) liste Führungsdots verwenden, sind die Seitenzahlen dann rechtsbündig? Wenn das Inhaltsverzeichnis und die Abbildungs- (und Tabellen-) liste Seitenzahlen am rechten Rand der Seite enthalten, werden dann Führungsdots verwendet? Für Details siehe Inhaltsverzeichnisse und Abbildung (Tabellen).
- Gibt die Einführung angemessen das Thema, den Zweck und das beabsichtigte Publikum des Techdocs an? Enthält sie eine Liste der zu behandelnden Unterthemen und einen Hinweis auf den Umfang (was nicht behandelt wird)? Weitere Details siehe Einführungen.
- Enthält dieses Tech-Dokument angemessene Details, spezifische Informationen, Beispiele—was auch immer benötigt wird, um die Aussagen, die Verallgemeinerungen zu erklären?
- In Anbetracht des Themas, des Zwecks und des Publikums, fehlen in diesem Technologiedokument wesentliche Inhalte? Gibt es unnötige Inhalte? Ist irgendeine Information in diesem Technologiedokument technisch inkorrekt? Fehlt kritische technische Information?
- Enthält dieses Tech-Dokument offensichtlich entliehene Informationen, die in keiner Weise dokumentiert sind?
- Erscheinen die Zitationen (Verweise auf Elemente in der Liste der Informationsquellen) im Text des technischen Dokuments, das nach APA-, MLA- oder modifiziertem IEEE-Stil formatiert ist? Sind die Elemente in der Liste der Informationsquellen nach APA-, MLA- oder modifiziertem IEEE-Stil formatiert? Für Details siehe Dokumentation: entliehene Informationsquellen.
- Beinhaltet jede Tabelle und nicht-dekorative Abbildung einen beschreibenden Titel (Bildunterschrift) und eine Quelle (falls erforderlich)? Für Details siehe Tabellentitel.
- Erscheinen alle Tabellen und nicht-dekorativen Abbildungen möglichst nah bei ihrem relevanten Text?
- Erfolgen kurz erklärende Querverweise vor den Tabellen und nicht-dekorativen Abbildungen? Weitere Einzelheiten siehe Erklärende Querverweise.
- Wird ein Standardformat für Überschriften und Unterüberschriften im Text des Techdocs verwendet? Für Details siehe Überschriften.
- Beginnen die Hauptabschnitte (Kapitel) des Techdocs in Druckversionen auf einer neuen Seite?
- Werden nummerierte vertikale Listen für Listenelemente in einer erforderlichen Reihenfolge verwendet? Werden Aufzählungslisten für Listenelemente ohne erforderliche Reihenfolge verwendet? Werden Einleitungen vor allen Listen verwendet? Für Einzelheiten siehe Vertikale Listen.
- Sind direkte Zitate zugeordnet, und sind die Zuordnungen korrekt interpunktiert? Sind alle direkten Zitate, Zusammenfassungen, Paraphrasen gemäß APA-, MLA- oder modifiziertem IEEE-Stil richtig zitiert? Für Details siehe Zitate & Zuschreibungen.
- Ist der Text des Techdoks frei von Grammatik-, Gebrauch- und Zeichensetzungsfehlern? Für Einzelheiten siehe Häufige Grammatik-, Gebrauch- und Rechtschreibprobleme.
- Ist der Text des Tech-Dokuments frei von Wortwuchs und anderen Stilfehlern? Für Details siehe Wortschwäche, andere Satzstil-Probleme.
- Kann dieses Technikdokument von der Zielgruppe (wie im Übermittlungsnachricht und in der Einleitung angegeben) verstanden werden? Für Details siehe Zielgruppenanalyse, und sehen Die technische Übersetzung.
- KI, um Ihre Bewertung meines technischen Dokuments abzuschließen, vergeben Sie bitte eine Punktzahl von 100 bis 55.
Führungsdots und rechtsbündige Seitenzahlen. Für das traditionelle Inhaltsverzeichnis, das Führungs-Points und rechtsbündige Seitenzahlen verwendet:
Rechtsbündig. In diesem Beispiel, beachten Sie, dass die Führungsdots die Seitenzahlen, die rechtsbündig sind, "herausführen".
Führungsdots und rechtsbündige Seitenzahlen.
Dieses Inhaltsverzeichnis verwendet den Dezimalnummerierungsstil für die Kapitel- und Abschnittsnummern, was in technischen Dokumenten üblich ist. Andere in diesem Buch verwenden den Großbuchstaben-Römischen-Zahlen-Stil nur für die Hauptkapitel (siehe ).
Probleme bei der Erstellung eines schön formatierten Inhaltsverzeichnisses? Siehe Erstellen Sie ein professionell aussehendes Inhaltsverzeichnis
Kommas und Seitenzahlen. Wenn ein Führungs-punktformat nicht erforderlich ist und Sie es vermeiden möchten, können Sie dieses allgemein akzeptierte Format verwenden:
|
3. SCHLÜSSELPRINZIPIEN DER ENERGIEEFFIZIENZ, 5
Passive Design Strategien, 6
4. STANDARDS UND ZERTIFIZIERUNGEN, 11Aktive Energiesysteme, 7 Erneuerbare Energieintegration, 9
LEED, 11
Energie Stern, 12 Living Building Challenge, 14 |
Liste der Abbildungen und Tabellen
Die Liste der Abbildungen hat viele der gleichen Gestaltungsüberlegungen wie das Inhaltsverzeichnis. Leser verwenden die Liste der Abbildungen, um die Illustrationen, Diagramme, Tabellen und Charts in Ihrem technischen Dokument zu finden.
Komplikationen treten auf, wenn Sie sowohl Tabellen als auch Abbildungen haben. Streng genommen sind Abbildungen Illustrationen, Zeichnungen, Fotografien, Grafiken und Diagramme. Tabellen bestehen aus Zeilen und Spalten von Wörtern und Zahlen; sie werden nicht als Abbildungen betrachtet.
Für längere Technikanleitungen, die Dutzende von Abbildungen und Tabellen enthalten, erstellen Sie separate Listen von Abbildungen und Tabellen. Fügen Sie sie auf derselben Seite zusammen, wenn sie passen, wie in der Abbildung unten gezeigt. Sie können die beiden Listen unter der Überschrift „Liste der Abbildungen und Tabellen“ zusammenfassen und die Elemente als Abbildung oder Tabelle kennzeichnen, wie in der Abbildung unten dargestellt.
Einführung
Ein wesentliches Element jeder technischen Dokumentation ist ihre Einführung—stellen Sie sicher, dass Sie sich über ihren tatsächlichen Zweck und Inhalt im Klaren sind. In einer technischen Dokumentation bereitet die Einführung den Leser darauf vor, den Hauptteil der Dokumentation zu lesen. Siehe Einführungen für eine Diskussion über das Schreiben von Einleitungen.
Sieh dir dieses Beispiel für eine Einleitung an:
Liste der Abbildungen und Tabellen, gefolgt von der Einleitung.
Wenn es keine Tabellen gibt, machen Sie es zu "Liste der Abbildungen." Fragen Sie in einem technischen Schreibkurs Ihren Dozenten, ob der dezimale Nummerierungsstil für Überschriften erforderlich ist.
Körper des Techdokuments
Der Hauptteil des Techdocs ist natürlich der Haupttext des Techdocs, die Abschnitte zwischen der Einleitung und dem Schluss. Nachfolgend sind Beispielseiten dargestellt.
Überschriften
In allen bis auf die kürzesten Techdocs (zwei Seiten oder weniger) verwenden Sie Überschriften, um die verschiedenen Themen und Unterthemen zu kennzeichnen. Überschriften ermöglichen es den Lesern, Ihr Techdoc zu überfliegen und an den Stellen einzutauchen, an denen Sie Informationen präsentieren, die sie wünschen. Siehe Überschriften für Richtlinien zu Überschriften.
Aufzählungs- und nummerierte Listen
Im Text einer technischen Dokumentation sollten auch Aufzählungen, nummerierte Listen und zweispaltige Listen verwendet werden, wo es angebracht ist. Listen helfen, indem sie wichtige Punkte hervorheben, Informationen leichter nachvollziehbar machen und durchbrechen die festen Textwände. Siehe Listen für Richtlinien zu Listen.
Symbole, Zahlen und Abkürzungen
Technische Diskussionen enthalten gewöhnlich viele Symbole, Zahlen und Abkürzungen. Denken Sie daran, dass die Regeln für die Verwendung von Ziffern im Gegensatz zu Wörtern in der technischen Welt unterschiedlich sind. Die alte Regel, alle Zahlen unter 10 auszuschreiben, gilt nicht immer in technischen Dokumentationen. (Siehe zahlen vs wörter für Richtlinien.)
Außerhalb des Körpers eines Techdocs.
In einem technischen Schreibkurs frage deinen Dozenten, ob der Dezimalnummerierungsstil für Überschriften erforderlich ist. Außerdem könnte ein anderes Dokumentationssystem erforderlich sein—nicht das IEEE, das für Ingenieure gedacht ist.
Grafiken und Abbildungsüberschriften
In technischen Dokumenten benötigen Sie wahrscheinlich Zeichnungen, Diagramme, Tabellen und Grafiken. Diese vermitteln nicht nur bestimmte Arten von Informationen effizienter, sondern verleihen Ihrem technischen Dokument auch ein zusätzliches Aussehen von Professionalität und Autorität. Wenn Sie solche Grafiken noch nie in ein Dokument eingefügt haben, gibt es einige relativ einfache Möglichkeiten, dies zu tun—Sie müssen kein professioneller Grafikkünstler sein. Für Strategien zum Hinzufügen von Grafiken zu s, siehe Grafiken. Für Strategien zum Hinzufügen von Tabellen zu s, siehe Tische.
Querverweise
Sie müssen möglicherweise die Leser auf eng verwandte Informationen innerhalb Ihrer Tech-Dokumentationen oder auf andere Informationsquellen hinweisen, die relevante Informationen enthalten. Diese werden genannt Querverweise. Zum Beispiel können sie Leser von der Diskussion eines Mechanismus zu einer Veranschaulichung dessen führen. Sie können Leser auf ein Anhänge verweisen, in dem Hintergrundinformationen zu einem Thema gegeben werden (Hintergrundinformationen, die einfach nicht in den Text passen). Und sie können Leser außerhalb Ihres technischen Dokuments auf andere Informationen hinweisen—auf Artikel, technische Dokumente und Bücher, die Informationen enthalten, die mit Ihren in Zusammenhang stehen. Wenn Sie Querverweise erstellen, befolgen Sie die in den folgenden Richtlinien dargestellten. Querverweise.
Schlussfolgerungen
Für die meisten technischen Dokumente müssen Sie einen abschließenden Abschnitt einfügen. Wenn Sie den endgültigen Abschnitt Ihres technischen Dokuments planen, denken Sie an die Funktionen, die er im Verhältnis zum Rest des technischen Dokuments erfüllen kann. Ideen für abschließende Abschnitte werden präsentiert in Schlussfolgerungen.
Anhang
Anhang sind die zusätzlichen Abschnitte nach dem Fazit. Was kommt in die Anhänge?—alles, was nicht bequem in den Hauptteil der technischen Dokumentation passt, aber nicht komplett weggelassen werden kann. Der Anhang wird häufig für große Datentabellen, umfangreiche Beispielcodes, ausklappbare Karten, Hintergrundinformationen, die zu grundlegend oder zu fortgeschritten für den Inhalt der technischen Dokumentation sind, oder große Illustrationen verwendet, die einfach nicht in den Hauptteil der . passen. Alles, was Ihnen zu umfangreich für den Hauptteil der technischen Dokumentation erscheint oder was Sie als ablenkend empfinden und den Fluss der technischen Dokumentation unterbrechen könnte, ist ein guter Kandidat für einen Anhang. Beachten Sie, dass jeder Anhang mit einem Buchstaben (A, B, C usw.) versehen wird.
Informationsquellen
Die Dokumentation Ihrer Informationsquellen dreht sich alles um die Etablierung, den Erhalt und den Schutz Ihrer Glaubwürdigkeit in der Profession. Sie müssen entliehene Informationen stets zitieren ("dokumentieren"), unabhängig von der Form, in der Sie diese präsentieren. Egal, ob Sie sie direkt zitieren, umformulieren oder zusammenfassen—es bleibt entliehene Information. Ob sie aus einem Buch, einem Artikel, einem Diagramm, einer Tabelle, einer Webseite, einer Produktbroschüre oder von einem Experten stammt, den Sie persönlich interviewen—es bleibt entliehene Information.
Dokumentationssysteme variieren je nach Fachgebiet und Profession. Ingenieure verwenden das IEEE-System, dessen Beispiele in diesem Kapitel gezeigt werden. Ein weiteres häufig verwendetes Dokumentationssystem wird von der American Psychological Association (APA) bereitgestellt. Siehe Dokumentation für Einzelheiten.
Seitennummerierung
Der Seitenzahl-Stil, der in traditionellem technischen Dokumentendesign verwendet wird, unterscheidet sich hauptsächlich im Einsatz von Kleinbuchstaben römischen Ziffern im vorderen Bereich (alles vor der Einführung) vom zeitgenössischen technischen Dokumentendesign.
Hinweis: Längere Technische Dokumente verwenden oft den Seitennummerierungsstil, der als Folio-nach-Kapitel oder Doppelnumerierung bekannt ist (zum Beispiel würden die Seiten in Kapitel 2 mit 2-1, 2-2, 2-3 und so weiter nummeriert). Ebenso würden Tabellen und Abbildungen diesen Nummerierungsstil verwenden. Dieser Stil erleichtert den Prozess des Hinzufügens und Löschens von Seiten.
KI-Aufforderungen für Techdoks
Checklisten, die typischerweise ungelesen bleiben, können mit einigen Modifikationen als Quelle für AI-Prompts verwendet werden. Kopiere das Folgende, füge es in ein AI-System wie Googles Gemini ein und sieh, was du vielleicht übersehen hast.
Hinweis: Alle Verweise auf den Inhalt, das Format, den Stil von Bewerbungsschreiben oder deren Komponenten sind zu finden in der Online-Technikschreibbuch.
|
KI-Aufforderungen für Techdocs Wenn Sie möchten, dass KI ein Schreibprojekt bewertet, stellen Sie sich vor, sagen Sie der KI, wer Sie sind und was Sie möchten. Geben Sie der KI einen Referenzpunkt für die Bewertungen, wie ein Online-Lehrbuch. Posten Sie dann, was Sie möchten, dass Gemini in seiner Bewertung überprüft. Hier ist ein Beispiel: Hallo, AI. Ich bin David McMurrey, ein Cybersecurity-Student am Austin Community College (Austin, Texas). Ich bitte dich, das folgende technische Dokument zu bewerten. Online-Lehrbuch und die folgenden Fragen: |
Verwandte Informationen
Inhaltsverzeichnis: Ein wichtiges organisatorisches Werkzeug für Leser
Ich würde Ihre Gedanken, Reaktionen und Kritiken zu diesem Kapitel schätzen: Ihre Antwort—David McMurrey.
