Handbücher

Ein Handbuch, wie wir es hier definieren, ist eine Kombination aus Folgendem:

• Konzept Informationen
• Anweisung Informationen
• Referenzinformationen

alle auf ein spezifisches Thema für die Bedürfnisse eines bestimmten Publikums fokussiert. Wenn Sie einen Kurs für technisches Schreiben mit diesem Buch belegen, ist Ihr Handbuchprojekt muss einschließen in irgendeiner Form oder Weise jedes dieser drei Elemente. Darüber hinaus sollten diese Elemente eine natürliche, logische "Passform" für Ihr Handbuchprojekt sein.

Achte darauf, dir die anzusehen Beispiele.

NotebookLM-generierte Infografik dieses Kapitels

Handbuch Grundlagen

Konzepte. Konzeptionelle Informationen erklären, wie Dinge funktionieren, wie Dinge zusammengesetzt sind. Für komplexere Anweisungen müssen Sie einige Konzepte, Theorien, Hintergründe, Prinzipien kennen, um die Anweisungen auszuführen. Betrachten Sie das Beispiel der Softwarefunktion, die es Ihnen ermöglicht, Ihre eigene Farbe zu modifizieren oder zu erstellen. Mit etwas wie Photoshop, Illustrator, CorelDraw oder Paint Shop Pro zu arbeiten—die eigentlichen Tasten und Schieberegler—ist einfach. Aber zu verstehen, wie Farbton, Intensität, Helligkeit, Sättigung, Dichte, Kontrast, RGB—das ist schwer. Sie müssen die Farbtheorie für Computer kennen, um die Farbe zu erstellen, die Sie benötigen.

Betrachten Sie ein weiteres Beispiel: einfache Linux-Dateisystembefehle—ls, cd, cp, mv, pwd. Um diese Befehle zu verwenden, müssen Sie verstehen, was Dateien und Verzeichnisse sind, und wahrscheinlich auch, was ein Betriebssystem ist sowie Platzhalter. Sie können wirklich nicht verstehen, wie man diese Befehle—Anweisungen damit befolgt—es sei denn, Sie verstehen diese grundlegenden Konzepte.

Anweisungen. Wenn Sie die grundlegenden Konzepte verstehen, können Sie die Schritt-für-Schritt-Verfahren intelligent befolgen. Anleitungen sind diese vertrauten nummerierten Listen, die Sie sorgfältig durch ein Verfahren führen. Anleitungen sind überall, auf Produktverpackungen, in Benutzerhandbüchern, die mit Geräten und Computern geliefert werden.

Referenz. Die letzte Kategorie von Informationen betrifft Nachschlageinformationen oder Schnellreferenzinformationen. Wenn Sie dem oben genannten Beispiel des Dateisystems gefolgt sind, mussten Sie zuerst die Konzepte von Dateien, Verzeichnissen und Platzhaltern studieren und lernen. Dann konnten Sie den Anweisungen zum Ändern von Verzeichnissen, Kopieren, Löschen oder Verschieben von Dateien folgen und diese verstehen. Nach einer Weile benötigen Sie jedoch die Anweisungen nicht mehr, aber hin und wieder haben Sie spezielle Anforderungen, die im Anleitungsbereich nicht behandelt werden, oder Sie können sich an bestimmte Verfahren nicht erinnern, die dort erklärt wurden. Jetzt ist der Zeitpunkt, an dem Sie grundlegende Referenzinformationen benötigen: Sie gehen einfach zu diesem Abschnitt und schlagen es schnell nach.

Und so, nach einiger Zeit, brauchst du weder den Abschnitt mit den Konzepten noch den Abschnitt mit den Anweisungen: Du hast dich so an diese Verfahren gewöhnt, dass du sie auswendig kennst. Aber von Zeit zu Zeit vergisst du ein kleines Detail oder du hast eine spezielle Aufgabe, die du noch nie zuvor gemacht hast — genau dann gehst du zum Referenzabschnitt. Du könntest wahrscheinlich die Abschnitte mit den Konzepten und Anweisungen abreißen und wegwerfen. Alles, was du jemals brauchen wirst, ist der Referenzabschnitt.

Handbuchformat und -stil

In einem technischen Schreibkurs, der dieses Buch verwendet, wird von Ihnen erwartet, dass Sie die spezifischen Richtlinien für die Verwendung von Überschriften, Listen, Hinweisen, Grafiken, Tabellen, Dokumentationen und Einleitungen befolgen:

Handbuch-Prototyp. Über den folgenden Link können Sie eine Musterversion des Handbuchs herunterladen. Es enthält alle erforderlichen Seiten in gutem Format. In diesem Word-Dokument sind Absatz- und Zeichenformate enthalten, die Ihnen die Arbeit erleichtern und einige professionelle Fähigkeiten in Ihr Repertoire aufnehmen.

Handbuch-Prototyp

Inhaltsprototyp. Der Prototyp für das Inhaltsverzeichnis ist besonders nützlich: Er gibt dir die Word-Styles, um ein professionell aussehendes Inhaltsverzeichnis zu erstellen. Es ist schwierig, die links- und rechtsbündigen Ausrichtungen sowie die Führungsdots richtig hinzubekommen:

Inhaltsverzeichnis-Prototyp

Handbuch Beispiele

Hier sind einige Links zu Handbuchbeispielen. Seien Sie sich bewusst, dass es in den Beispielen einige Probleme gibt, die ich größtenteils kommentiert habe. Einige davon sind grenzwertige Handbücher. Was für mich ein Handbuch ausmacht, ist das Vorhandensein von konzeptionellen Diskussionen, Anleitungen und Referenzinformationen.

Achte darauf, die zu überprüfen Beispiele.

KI-Aufforderungen für Handbücher

Checklisten, die typischerweise ungelesen bleiben, können mit einigen Änderungen als Quelle für KI-Eingaben verwendet werden. Kopiere Folgendes, füge es in ein KI-System wie Googles Gemini ein und sieh nach, was du möglicherweise übersehen hast.

Hinweis: Alle Verweise auf den Inhalt, das Format, den Stil von Techdocs oder dessen Komponenten sind im Online-Technisches-Schreiben-Lehrbuch.

Bald verfügbar!

Ich würde Ihre Gedanken, Reaktionen und Kritiken zu diesem Kapitel schätzen: Ihre Antwort—David McMurrey.