So genial ein Erfinder, Programmierer oder Rationalisierer auch sein mag, manchmal sind seine Kreationen einfach nicht für den vorgesehenen Zweck zu verwenden. Grund dafür ist die falsch erstellte Bedienungsanleitung oder deren vollständiges Fehlen. Aber selbst geniale Erfinder schreiben manchmal solche Anleitungen, dass außer engen Spezialisten niemand diese Papiere lesen kann. Wie erstellt man ein solches notwendiges Dokument richtig?
Es ist notwendig
- - hundertprozentige Kenntnis des Geräts oder Softwareprodukts, für das das Handbuch geschrieben wird;
- - Kenntnisse auf dem Gebiet der Linguistik;
- - Schreibfähigkeiten.
Anleitung
Schritt 1
Ein Benutzerhandbuch oder mit anderen Worten eine Bedienungsanleitung ist ein Dokument, das seinen Benutzern eine Hilfestellung bei der Verwendung eines bestimmten Systems geben soll. Um ein Benutzerhandbuch zu erstellen, müssen Sie das beschriebene System hundertprozentig kennen, es aber mit den Augen eines unwissenden Studenten betrachten. Angenommen, ein Benutzerhandbuch wurde für ein Software-Dienstprogramm geschrieben, das noch keine Analoga hat. Stellen Sie sich vor, Sie verwenden dieses Programm zum ersten Mal. Wo fängst du an? Was ist als erstes zu wissen? Organisieren Sie dieses Wissen in Kategorien von Bedeutung.
Schritt 2
Indem Sie alle Informationen zu Ihrer Kreation in Gruppen aufteilen, haben Sie einen Plan für das Schreiben eines Benutzerhandbuchs erstellt. Beginnen Sie mit der Beschreibung der Arbeit in Ihrem Programm von Grund auf und lassen Sie die schwierigsten Details, wie die Neuprogrammierung von Funktionen oder den Umgang mit kritischen Fehlern, zum Schluss. Zu diesem Zeitpunkt sollten Sie den Inhalt des Benutzerhandbuchs bereithalten - einen der erforderlichen Teile dieses Dokuments.
Schritt 3
Wenn das von Ihnen erstellte Handbuch für den Einsatz in einem großen Unternehmen bestimmt ist, sollten Sie die dort verabschiedeten Unternehmensstandards beachten. In vielen russischen Unternehmen werden beispielsweise Benutzerhandbücher nicht ohne anschauliche Unterstützung akzeptiert, dh Bilder, die das Geschriebene erklären. Neben dem Inhalt sollte das Benutzerhandbuch weitere obligatorische Teile enthalten: - Anmerkung, d. h. eine Erläuterung der allgemeinen Ziele des Handbuchs und des beschriebenen Produkts; - eine Einführung, die die Dokumente zum Benutzerhandbuch beschreibt und wie zur Verwendung des Handbuchs; - Abschnitte, die die Verwendung des Produkts in verschiedenen Phasen seiner Verwendung erklären, z. B. erste Schritte, Reparatur oder Wartung; - Abschnitt mit häufig gestellten Fragen und Antworten darauf; - Glossar oder Themenverzeichnis.
Schritt 4
An der Erstellung eines Benutzerhandbuchs ist in der Regel ein technischer Redakteur beteiligt – eine Person, die über alle notwendigen Kenntnisse sowohl in der Sprache als auch in dem zu beschreibenden Produkt verfügt. Als Technischer Redakteur ohne Ausbildung gibt es einige Regeln zu beachten. Erstens dürfen Sie keine speziellen Begriffe missbrauchen, die für einen normalen Benutzer nicht verständlich sind. Zweitens muss jeder verwendete Begriff detailliert und erklärt werden. Drittens müssen Sie so klar und prägnant wie möglich schreiben. Schließlich muss ein technischer Redakteur in der Lage sein, seinen eigenen Text mit den Augen eines normalen Benutzers zu betrachten, um die Mängel seines eigenen Textes zu erkennen.
Schritt 5
Es ist gut, den fertigen Text der Bedienungsanleitung in der Praxis zu testen, indem man ihn einer Person anbietet, die mit dem beschriebenen Produkt nichts zu tun hatte. Durch gemeinsame Anstrengungen ist es möglich, alle Mängel und Fallstricke des Dokuments zu beseitigen.
