Der Prozess der Erstellung und Bearbeitung eines Handbuchs

ÜBERBLICK.
Sobald die Zielgruppe, der Zweck und der Umfang eines Handbuchs festgelegt sind, kommen die allgemeinen Grundsätze des guten Schreibens ins Spiel. Der Verfasser sollte sich an einen für das jeweilige Thema geeigneten Stilleitfaden halten, sei es ein interner Standard oder ein extern veröffentlichter Leitfaden. Der Projektleiter sollte auch sicherstellen, dass ein angemessenes System der redaktionellen Kontrolle vorhanden ist, um Fehler im Entwicklungsprozess zu vermeiden. Dazu gehört in der Regel mindestens ein Lektoratsdurchlauf, bei dem Rechtschreibung, Grammatik, Zeichensetzung und andere grundlegende Mechanismen überprüft werden. Es ist auch von Vorteil, eine oder mehrere Personen – möglicherweise sowohl Experten als auch Laien – zu beauftragen, das Dokument und seine Abbildungen auf Klarheit, Genauigkeit und Benutzerfreundlichkeit zu überprüfen. Ein größeres Projekt zur Entwicklung eines Handbuchs, wie z. B. ein umfangreiches Nachschlagewerk für Kunden, kann auch mindestens eine Phase der Überprüfung durch die Zielgruppe erfordern, in der eine kleine Gruppe, z. B. eine fünfköpfige Fokusgruppe oder ein Gremium, aus realen (oder potenziellen) Benutzern außerhalb des Unternehmens gebeten wird, die Dokumentation zu überprüfen und zu kommentieren, solange noch Zeit für die Überarbeitung bleibt.

KOMPETENZ UND GENAUIGKEIT DES VERFASSERS.
Die vielleicht grundlegendste Überlegung zu Beginn des Prozesses der Handbucherstellung besteht darin, sicherzustellen, dass der Verfasser in der Lage ist, die beabsichtigte Dokumentation zu erstellen. Dabei ist nicht nur zu prüfen, ob die allgemeinen Fähigkeiten des Verfassers für das Projekt geeignet sind, sondern auch, ob der Verfasser über die Ressourcen und Informationen verfügt, die er für eine erfolgreiche Arbeit benötigt. Obwohl dies auf den ersten Blick offensichtlich erscheint, ist dies ein häufiges Problem bei der technischen Produktdokumentation, vor allem wenn ein neues Produkt in letzter Minute fertiggestellt wird. In diesen Fällen beginnt der Verfasser des Handbuchs oft mit seiner Arbeit, bevor das Produkt fertiggestellt ist. In anderen Fällen kann es vorkommen, dass dem Verfasser zu Beginn kein funktionierendes Modell des Produkts zur Verfügung steht, das er beobachten oder testen könnte. Ein gut durchdachter Entwicklungsprozess stellt sicher, dass der Autor bei der Implementierung von Produktänderungen ausreichend Zugang zu diesen Informationen hat, um kompetent über das Thema schreiben zu können.

KONZENTRALITÄT.
Einer der Schlüssel zum Erfolg eines Handbuchs ist die Prägnanz. Die Leser wollen nicht mehr lesen, als unbedingt notwendig ist, um zu lernen, wie man ein Verfahren durchführt, einen Vorschlag annimmt oder bewertet oder Informationen aufnimmt.

KLARHEIT UND ORGANISATION.
Der nächste Schritt ist die Klarheit. Die verwendete Sprache sollte aus allgemein gebräuchlichen Wörtern bestehen und nicht aus komplexen, selten verwendeten Wörtern, die den Leser verwirren würden. Außerdem sollten die Sätze so aufgebaut sein, dass sie möglichst gut lesbar sind. Eine häufige Beschwerde über technische Handbücher ist, dass sie zwar alle Informationen enthalten, die der Benutzer braucht, aber das Material ist schwer, wenn nicht gar unmöglich, zu verdauen. Der Autor mag zwar sachliche Genauigkeit und Vollständigkeit erreicht haben, aber wenn die Informationen in umständlichen Sätzen und unorganisierten Absätzen vergraben sind, wird der Zweck des Handbuchs verfehlt.

KONSISTENZ.
Ein weiterer zu berücksichtigender Faktor ist die Konsistenz. Handbücher sollten in Terminologie, Format und Darstellung einheitlich sein. Wenn ein Autor mit einem Nummerierungssystem für Absätze und Abschnitte beginnt, sollte dieses durchgehend befolgt werden. Wenn visuelle Hilfsmittel wie Tabellen, Schaubilder und Diagramme, die zur Verbesserung, Verdeutlichung und Ergänzung des Materials verwendet werden, nicht auf den Inhalt des Handbuchs verweisen, wirken auch sie ablenkend.

Möchten Sie Ihre gesamten Arbeitsanweisungen erstellen mit Manual Rebel? Besuchen Sie https://manualrebel.com/ direkt.