Das Erstellen eines technischen Handbuchs ist eine unkomplizierte Aufgabe, bei der die Schritte organisiert und klare, präzise Formulierungen erstellt werden. Das Ziel eines technischen Handbuchs besteht darin, Informationen dazu zu geben, wie eine Operation in möglichst wenigen Schritten und in möglichst klarer Weise ausgeführt werden kann. Technische Handbücher erfordern oft die Zusammenarbeit vieler Personen, einschließlich Fachexperten, Redakteuren und technischen Redakteuren. Da technische Handbücher auch einer ständigen Überarbeitung und Aktualisierung unterliegen, ist die Kommunikation zwischen den beteiligten Parteien für die Entwicklung eines Handbuchs von entscheidender Bedeutung.
Bestimmen Sie den Stil des technischen Handbuchs, indem Sie entweder eine vereinfachte Stilanleitung erstellen oder eine vorhandene Stilanleitung befolgen, z. B. das Microsoft Style Guide für technische Handbücher. Ein Style Guide hilft beim Erstellen des Handbuch-Skeletts und sorgt für Konsistenz.
Schreiben Sie die Schritte für die Prozedur, beginnend mit einem Verb. Wenn Konsultationen erforderlich sind, um die Schritte zu schreiben, interviewen und Fragen von Fachexperten stellen. Dadurch wird die Gültigkeit der Verfahren sichergestellt. Andernfalls sind Schritte möglicherweise nicht logisch und / oder nicht in der richtigen Reihenfolge. Schritte sollten logisch geordnet und in logische Kapitel oder Abteilungen unterteilt sein.
Fügen Sie den erforderlichen Grafiken Grafiken und Illustrationen hinzu. Denken Sie daran, zu jeder Grafik / Illustration die Nummerierung und Titel der Bilder hinzuzufügen.
Erstellen Sie ein Inhaltsverzeichnis und einen Index zum leichteren Nachschlagen.
Fügen Sie ein Änderungsprotokoll oder ein Aktualisierungsblatt hinzu, das jede Änderung aufzeichnet, und aktualisieren Sie das Handbuch für zukünftige Versionen und Releases. Technische Handbücher sollten immer von einer anderen Person als dem technischen Redakteur bearbeitet werden, vorzugsweise von einem professionellen Redakteur.
