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 an einem technischen Schreibkurs teilnehmen, der dieses Buch verwendet, 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 darstellen.

NotebookLM-generierte Infografik zu diesem Kapitel

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 und Prinzipien kennen, um die Anweisungen auszuführen. Betrachten Sie das Beispiel der Softwarefunktion, die es Ihnen ermöglicht, Ihre eigene Farbe zu ändern oder zu erstellen. Dies mit etwas wie Photoshop, Illustrator, CorelDraw oder Paint Shop Pro zu tun—die tatsächlichen Schaltflächen und Regler—ist einfach. Aber zu verstehen, wie Farbton, Intensität, Helligkeit, Sättigung, Dichte, Kontrast, RGB—das ist schwer. Sie müssen die Farblehre des Computers kennen, um die benötigte Farbe zu erstellen.

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—Befolgen Sie die Anweisungen unter Verwendung davon—es sei denn, Sie verstehen diese grundlegenden Konzepte.

Anweisungen. Wenn Sie die grundlegenden Konzepte verstehen, können Sie den schrittweisen Verfahren intelligent folgen. 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 umfasst Nachschlageinformationen oder Schnellreferenzen. Wenn Sie dem obigen Beispiel des Dateisystems gefolgt sind, mussten Sie zuerst die Konzepte von Dateien, Verzeichnissen und Platzhaltern studieren und verstehen. Dann konnten Sie die Anweisungen zum Wechseln von Verzeichnissen, Kopieren, Löschen oder Verschieben von Dateien folgen und verstehen. Nach einer Weile benötigen Sie jedoch die Anweisungen nicht mehr, aber ab und zu haben Sie spezielle Anforderungen, die im Anweisungsbereich nicht behandelt werden, oder Sie können sich an bestimmte Verfahren, die im Anweisungsbereich behandelt wurden, nicht erinnern. Jetzt ist der Zeitpunkt, an dem Sie grundlegende Nachschlageinformationen benötigen: Sie gehen einfach zu diesem Abschnitt und schlagen es schnell nach.

Und so, nach einiger Zeit, benötigst du weder den Konzeptteil noch den Anweisungsteil: Du hast dich so an diese Verfahren gewöhnt, dass du sie auswendig kennst. Aber hin und wieder vergisst du ein kleines Detail oder hast eine spezielle Aufgabe, die du noch nie zuvor gemacht hast — dann gehst du zum Referenzteil. Du könntest wahrscheinlich die Konzepte- und Anweisungsabschnitte abreißen und wegwerfen. Alles, was du jemals brauchen wirst, ist der Referenzteil.

Handbuchformat und Stil

In einem technischen Schreibkurs, der dieses Buch verwendet, wird von Ihnen möglicherweise erwartet, dass Sie die spezifischen Richtlinien für die Verwendung von Überschriften, Listen, Mitteilungen, Grafiken, Tabellen, Dokumentationen und Einführungen beachten:

Handbuch-Prototyp. Über den folgenden Link können Sie eine Dummy-Version des Handbuchs erhalten. Es enthält alle erforderlichen Seiten in gutem Format. In diesem Word-Dokument sind Absatz- und Zeichnenstile enthalten, die Ihnen die Arbeit erleichtern und einige professionelle Fähigkeiten zu Ihrem Repertoire hinzufügen.

Handbuch-Prototyp

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

Inhaltsverzeichnis-Prototyp

KI-Aufforderungen für Handbücher

Checklisten, die normalerweise nicht gelesen werden, können mit einigen Modifikationen als Quelle für KI-Aufforderungen verwendet werden. Kopiere das Folgende, füge es in ein KI-System wie Google's Gemini ein und sieh nach, was du möglicherweise übersehen hast.

Hinweis: Alle Verweise auf den Inhalt, das Format, den Stil von Techdocs oder seinen Komponenten sind in der Online-Technikschreibbuch.

Bald erhältlich!

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