Wie schreibe ich ein Verfahrenshandbuch?

Wie schreibe ich ein Essay? Tipps, Aufbau, Gliederung, Inhalt, Sprache & Schreibstil (Juni 2024)

Wie schreibe ich ein Essay? Tipps, Aufbau, Gliederung, Inhalt, Sprache & Schreibstil (Juni 2024)

Inhaltsverzeichnis:

Anonim

Eine Prozedur ist wie ein Rezept - eine Reihe von Anweisungen, die eindeutig angeben, wer etwas tut, wann es getan werden sollte, wie es gemacht wird und wie das Ergebnis sein soll. Listen Sie jeden Schritt in der Reihenfolge auf, zu der er abgeschlossen sein muss. Stellen Sie mehrere Verfahren in einem Handbuch zusammen, das nach Jobbeschreibung, Abteilung, Funktion oder Reihenfolge sortiert ist und die Informationen für die Benutzer des Handbuchs am besten zugänglich macht. Verwechseln Sie Richtlinien nicht mit Prozeduren. Richtlinien sind Regeln oder Positionsangaben; Verfahren befolgen die Menschen, um Richtlinien umzusetzen.

Artikel, die Sie benötigen

  • Bestehende Dokumentation, die Ressourcenmaterial sein kann

  • Fachexperten, die wissen, wie die Verfahren durchzuführen sind

Legen Sie fest, welche Verfahren dokumentiert werden sollen. Es gibt zwei Methoden zur Auswahl des Inhalts Ihres Handbuchs, indem Sie potenzielle manuelle Benutzer befragen, um herauszufinden, zu welchen Aufgaben sie geklärt werden müssen, oder weitere Informationen benötigen. Alternativ können Sie auch eine Liste von betrieblichen Problemen erstellen, die Sie mit klar definierten Verfahren lösen können.

Informationen sammeln. Eine Person, die diese Aufgabe bereits ausführt, ist die beste Ressource, es sei denn, Sie erstellen Prozeduren von Grund auf. Beobachten Sie, wie die Person die Aufgabe ausführt und sich Notizen macht, oder bitten Sie die Person, alle an der Aufgabe beteiligten Schritte aufzuschreiben sowie alle durch die Erfahrung erlernten Tipps und Warnungen.

Legen Sie das Layout Ihres Handbuchs fest. Ein zweispaltiges Format macht die Abläufe klar und leicht lesbar. Benennen Sie jede Seite mit dem Namen der Prozedur, und fügen Sie unter dem Titel eine Liste oder einen Absatz von Fakten ein, die nicht in einem Schritt enthalten sind, z. B. wie häufig die Prozedur ausgeführt wird und ob Tipps oder Warnungen angezeigt werden. Die Prozedur sollte danach in einer zweispaltigen Tabelle folgen.

Schreiben Sie einen groben Entwurf. Listen Sie in der linken Spalte die für das Verfahren verantwortliche Person auf. Listen Sie in der rechten Spalte die Schritte auf, die diese Person durchführt. Wenn das Verfahren mehrere Personen umfasst, sollten alle in der Lage sein, klar zu sehen, wo sie in den Prozess passen und was sie tun müssen.

Testen Sie die Verfahren. Bitten Sie jemanden, der mit den Verfahren nicht vertraut ist, um sie nach dem Entwurf zu befolgen. Es ist wichtig, jemanden zu verwenden, der unerfahren ist, damit die Person keine gewöhnlichen Abkürzungen verwendet oder unklare Punkte beschönigt, die ein anderer Leser nicht verstehen würde.

Überarbeiten Sie den Entwurf. Schritte klären, hinzufügen, löschen und neu anordnen, bis der Benutzer das Handbuch lesen kann.

Veröffentlichen Sie das Handbuch. Fügen Sie ein Inhaltsverzeichnis hinzu, damit Leser Prozeduren schnell finden können. Fügen Sie ein Glossar hinzu, in dem Terminologie definiert wird, das für Ihre Branche ungewöhnlich oder spezifisch ist.

Tipps

  • Verwenden Sie keine eleganten Wortvariationen, um die Schrift zu beleben. Ein "Widget" ist jedes Mal ein Widget, kein "Element" oder "Gerät". Konsequente Beschreibungen mögen sich wiederholend sein, aber sie verbessern die Lesbarkeit der Leser.