Software-Benutzerhandbücher, die häufig mit Jargon, Akronymen und Anweisungen gefüllt sind, die einen Doktortitel zum Verstehen erfordern, werden manchmal aus der Sicht eines Entwicklers und nicht eines Benutzers geschrieben. Infolgedessen kann der Leitfaden Annahmen über den Kenntnisstand des Lesers treffen, die oft falsch sind. Der erste Schritt beim Schreiben eines guten Benutzerhandbuchs besteht darin, den eigentlichen Schreibvorgang so weit wie möglich von den Ingenieuren zu entfernen.
Der Softwareentwickler weiß mehr als jeder andere, was die Software zum Funktionieren bringt, aber das bedeutet nicht, dass der Entwickler die Anleitung schreiben sollte. Im Gegenteil, es ist ein deutlicher Nachteil. Wichtiger als ein tiefes Verständnis der inneren Funktionsweise der Software ist ein Verständnis darüber, wer der Endbenutzer sein wird, wie sein Bildungsniveau ist und wie dieser Endbenutzer die Software verwendet. In den meisten Fällen müssen Endbenutzer nicht die Feinheiten der Programmierung und die Back-End-Funktionen der Software kennen. Sie müssen lediglich wissen, wie sie damit arbeiten, um ihre Arbeit zu erleichtern.
Benutzertest
Das Benutzerhandbuch sollte weitgehend aufgabenorientiert und nicht stark beschreibend sein. Da das Handbuch so geschrieben ist, dass Benutzer verstehen, wie bestimmte Aufgaben ausgeführt werden, muss der Verfasser auch diese Aufgaben verstehen. Daher ist es absolut wichtig, jeden einzelnen Schritt der einzelnen Funktionen durchzuarbeiten. Der Autor muss nicht unbedingt wissen, wie das Programm aus Sicht des Designs oder der Entwicklung erstellt wurde. Es ist jedoch unerlässlich, dass Sie über umfassende Kenntnisse über alle seine Funktionen verfügen. Nehmen Sie sich bei der Ausführung der einzelnen Aufgaben Zeit, um jeden einzelnen Schritt, einschließlich Klicks, Dropdown-Menüs und andere Aktionen, aufzuschreiben.
Der Interviewprozess
Obwohl der Entwickler nicht derjenige sein sollte, der das Handbuch verfasst, ist er dennoch eine wertvolle Ressource für den Verfasser. Planen Sie vor Beginn des Schreibvorgangs ein Kick-Off-Treffen zwischen dem Verfasser, Entwickler und Ingenieuren sowie potenziellen Endbenutzern, um die Benutzer darüber zu informieren Schriftsteller Arbeit von Anfang an. Interviews mit Fachexperten und Ingenieuren sollten aufgezeichnet werden, mit Transkripten zum späteren Nachschlagen.
Bilder
Eine Bedienungsanleitung sollte nicht zu textlastig sein. Verwenden Sie stattdessen eine großzügige Verwendung von Grafiken und Bildschirmclips. Die Beschreibung einer Aktion ist mit textbasierten Anweisungen und einem Bildschirmclip, der diese Richtung deutlich veranschaulicht, viel klarer. Fügen Sie sowohl Vorher- als auch Nachher-Ansichten ein, um zu zeigen, wie der Bildschirm vor jeder Aktion aussieht und was nach der Aktion geschieht. Ein einfaches Screen-Capture-Programm wie das in Microsoft Windows enthaltene Snipping-Tool eignet sich gut zum Erfassen dieser Bilder. Stellen Sie sicher, dass jedes Bild nummeriert wird und fügen Sie eine Beschriftung hinzu, die es kurz beschreibt. Zentrieren Sie es unmittelbar unter dem Absatz, der zuerst das im Bild dargestellte Konzept einführt.
Formatierung
Die klare Kommunikation in einem technischen Dokument erfordert die Planung und sorgfältige Einhaltung der Standards im gesamten Leitfaden. Standards in Präsentation, Sprache und Nomenklatur helfen, Verwirrung zu vermeiden. Vorlagen sind verfügbar und können ein guter Ausgangspunkt für die Einheitlichkeit sein, obwohl sie sicherlich an die jeweilige Situation angepasst werden können. Die Verwendung eines Ein-Zoll-Randes mit einer einzelnen Spalte eignet sich am besten für das Hinzufügen von Grafiken. Eine zweispaltige Einstellung erscheint möglicherweise zu überfüllt und kann die Platzierung von Bildern verwirren.
Versionierung und Tracking
Mehr als jede andere Art von Dokument durchläuft ein Software-Benutzerhandbuch wahrscheinlich mehrere Iterationen, bevor es abgeschlossen ist, und es wird wahrscheinlich einen Überprüfungsprozess durch mehrere Stakeholder durchlaufen. Mit der Funktion "Änderungen verfolgen" in Microsoft Word können Sie auf einfache Weise die Kommentare und Änderungen der einzelnen Personen verfolgen. Das Erstellen mehrerer Versionen nach jedem Überprüfungszyklus, von denen jede einen anderen Dateinamen hat, hilft auch dem Prozess und stellt sicher, dass alle Beteiligten mit dem Endergebnis zufrieden sind.
