• Articles
• admin

Alrighty! Wer ist aufgeregt, über Benutzerhandbücher zu sprechen?

Hör zu, ich verstehe. Aber wenn Sie wie ich sind, dann stimmen Sie zu, dass die Dokumentation von Prozessen & Systemen für jede gemeinnützige Organisation unerlässlich ist. Es geht nur darum, die Zeit dafür zu finden.

Und warum sollten wir nicht? Die Dokumentation spart uns langfristig Zeit. Es erspart uns unnötige Besprechungen & Fehlerbehebung, indem es die Mitarbeiter befähigt, ihre eigenen Antworten zu finden.

Ganz zu schweigen davon, dass es eine verdammt gute Fähigkeit ist. Und es ist entscheidend, um Ihre Arbeit aufrechtzuerhalten, sollten Sie & Ihre Organisation trennen.

Versuchen Sie, sich dafür Zeit zu nehmen. Die folgenden Schritte sollten dazu beitragen, dies so schmerzlos wie möglich zu machen … und wenn nicht, gibt es gegen Ende ein „Freebie“, das Sie sich schnappen möchten.

Beginnen Sie mit einer Gliederung.

Bevor Sie Prozeduren und Definitionen eingeben, sollten Sie die Struktur Ihres Dokuments berücksichtigen. Was sind die Themen, die für die Mitarbeiter leicht zu verfolgen sind? Und welche Struktur wird für Sie im Laufe der Zeit leicht zu aktualisieren sein?

Spoiler: Dies wird Ihr Inhaltsverzeichnis!

Für example…my das Salesforce-Handbuch von Team wird hauptsächlich durch Objekte getrennt. Je nach Einrichtung kann es jedoch sinnvoller sein, Themen nach Abteilung oder Funktion aufzuteilen.

Fang breit an. Dann schmal.

Ihr Handbuch muss spezifische Details und Schritt-für-Schritt-Anleitungen enthalten. Im Grunde all das, was unsere Kollegen immer wieder vergessen.

Aber eine gute Dokumentation gibt auch eine hilfreiche Vogelperspektive, wie Ihr System organisiert ist & warum. Denken Sie daran, wenn Sie Ihre Gliederung in Schritt 1 planen.

ps Ich empfehle dringend, Ihr Datenmodell zu grafisch darzustellen. Sie können ein kostenloses Tool wie Google Drawings verwenden oder etwas in einem Word- oder Powerpoint-Dokument erstellen (mit shapes & -Linien). Muss nicht schick sein!

Definieren Sie alle Ihre Daten.

Jedes technische Asset in Ihrer Datenbank ist eine Manifestation einer realen „Sache“: Ob es sich um eine Person (Spender, Freiwillige usw.), eine Transaktion (Spende, Zuschuss usw.) handelt..) oder Partnerschaft (Programmbereitstellung).

Eine gute Dokumentation schließt die Lücke zwischen dem Realen und dem Technischen, indem Sie definiert, was Ihre Objekte & in der tatsächlichen Welt darstellen.

Meta, ich weiß.

Weisen Sie Ihre Benutzer an.

Ihr Benutzerhandbuch sollte zwei Dinge tun: Definieren und anweisen.

Wenn Mitarbeiter Aufgaben in Ihrer Datenbank ausführen müssen – Dateneingabe, Datenaktualisierung, sogar Suchen – helfen Sie ihnen, indem Sie Schritt-für-Schritt-Anleitungen für diese Dinge hinzufügen.

Tipp: Nummerierte Listen & kurze Sätze sind hier dein Freund.

Schreiben Sie alles einmal. Dann trimmen, wiederholt.

Wir alle kennen den Schmerz, ein Handbuch zu lesen, das langwierig, wortreich und in Text erstickt ist. Schonen Sie Ihre Kollegen. Schlagen Sie diesen ersten Entwurf aus und planen Sie, viel Zeit damit zu verbringen, ihn zu kürzen.

Warum? Denn weniger ist mehr. Und es braucht Zeit, um eine umfassende und effektive Dokumentation zusammenzustellen, die dennoch präzise ist.

p.s. Ich sage nicht, die Dinge der Kürze halber auszuschneiden. Ich sage, dass prägnante Dokumentation eine Kunst ist – eine, die nicht beim ersten Versuch landet.

Nutzen Sie White Space.

Denken Sie daran in Bezug auf UX (User Experience). So wie Sie sich um die Benutzerfreundlichkeit Ihrer Datenbank kümmern, möchten Sie auch, dass Ihr Handbuch einfach zu durchsuchen ist.

Je mehr Leerraum vorhanden ist – der Abstand zwischen / um Ihren Text – desto besser. Berücksichtigen Sie auch Ihre Schriftgröße, Zeilenhöhe und Aufzählungsabstand.

Verwenden Sie Screenshots nur dort, wo Sie müssen.

Screenshots sind fantastisch. Warum jemandem etwas erklären, wenn man es ihm auch zeigen kann?

Aber ich persönlich glaube, sie sind ein bisschen eine Falle. Zumindest wenn es um die Dokumentation geht.

Denken Sie darüber nach. Wenn sich an der Benutzeroberfläche Ihres Systems etwas ändert, müssen Sie diese Bilder erneut erfassen und ersetzen. Sie können auch von Ihren schriftlichen Anweisungen ablenken, insbesondere wenn Sie sich mitreißen lassen.

Deshalb verwende ich sie hauptsächlich, um etwas hervorzuheben, das meine Benutzer sonst möglicherweise vermissen.

🌟 Eine weitere Sache, die helfen könnte ….

Jetzt, wo wir unsere Schritte haben, ist es Zeit, mit dem Bauen zu beginnen! Um zu helfen, habe ich eine Benutzerhandbuchvorlage erstellt, die ich mit jedem teile, der sie haben möchte – für Microsoft Word oder Google Text & Tabellen!

Sie benötigen lediglich eine E-Mail-Adresse. Um es zu überprüfen und Ihre Kopie zu erhalten, Folgen Sie diesem Link.

Da dies ein Datenbank-Blog ist, eine kurze Notiz! Wenn Sie sich für den Erhalt der Vorlage anmelden, werden Sie auch zur E-Mail-Liste meines Blogs hinzugefügt (die ich niemals an Dritte weitergebe). Ich sende zweimonatliche Updates und gelegentliche Ankündigungen, von denen Sie sich jederzeit abmelden können.