Erstellen Sie eine effektive Anleitung, die Ihr Publikum anspricht
Veröffentlicht: 2024-10-01Wie oft unterbrechen Sie Kollegen um Hilfe?
Wussten Sie, dass 46 % der Arbeitnehmer mehr als sechs Mal am Tag unterbrochen werden? In unserer Studie zur Arbeitsplatzflexibilität berichteten diese Mitarbeiter über eine verminderte Produktivität oder mehr Stress.
Verbessern Sie die Lebensqualität aller mit ein wenig Dokumentation. Hier finden Sie alles, was Sie brauchen, um bequem und sicher Schritt-für-Schritt-Anleitungen zu erstellen.
Die Möglichkeiten, Verfahren, Erklärungen und Methoden auszutauschen, gibt es überall.
- Schulen Sie Teammitglieder in einem neuen Prozess?
- Kunden für Ihr kommerzielles Produkt oder Ihre kommerzielle Dienstleistung gewinnen?
- Erleichtern Sie die offene Einschreibung für die neue HR-Software?
- Anleitung zum Entleeren des Kaffeesatzes?
- Zur Wissensdatenbank des Kunden beitragen?
Lassen Sie uns lernen, wie man eine Anleitung erstellt.
Hören Sie auf, wiederholte Fragen zu stellen
Erstellen Sie mit Snagit anschauliche Videos und Anleitungen, sodass Sie Aufgaben nur einmal erklären müssen.
Probieren Sie es kostenlos ausSchritt-für-Schritt-Anleitungen sind Teil einer internen Wissensdatenbank
Ein Kurztutorial ist eine Schritt-für-Schritt-Anleitung zum Erledigen einer bestimmten Aufgabe.
- Klar – Leser sollten in der Lage sein, den Schritten zu folgen. Oftmals bedeutet dies, Text mit Bildern oder Videos zu kombinieren.
- Ansprechend – Organisieren Sie den Leitfaden so, dass er die Aufmerksamkeit der Leser fesselt und ihnen hilft, Zeit zu sparen.
- Relevante Informationen – Stellen Sie Kontext und Anwendungsfälle bereit, die dem Leser helfen zu verstehen, warum sie für ihn wertvoll sind.
Andere wichtige Teile einer Wissensdatenbank unterscheiden sich
- Schulungshandbuch – Versuchen Sie nicht, eine ausführliche Schulung oder einen Zertifizierungskurs zu ersetzen.
- Referenzleitfaden – Konzentrieren Sie sich auf ein bestimmtes Ziel, das Ihr Publikum erreichen kann.
- Benutzerhandbuch – Fügen Sie ein paar Tipps, Vorbehalte oder Wissenswertes hinzu, nicht für jedes Randszenario.
- Blogbeiträge – Vereinfachen Sie Inhalte für kundenorientierte Marketingstrategien und Marketingkampagnen. Oder ersetzen Sie sie durch Fallstudien oder Listen mit Aufzählungszeichen, um Kaufentscheidungen zu erleichtern.
Schritt 1: Verstehen Sie die Schwachstellen Ihrer Zielgruppe
„Zweimal messen, einmal schneiden.“ Die zusätzliche Zeit im Vorfeld lohnt sich, um das Kundenerlebnis sicherzustellen.
Identifizieren Sie ihre Schmerzpunkte
Bevor Sie beginnen, identifizieren Sie mit Ihrem Leitfaden Ihre Zielgruppe, ihre Ziele und ihre Schwachstellen oder Wissenslücken, die angegangen werden sollen. Es kann hilfreich sein:
- Führen Sie Umfragen durch
- Stöbern Sie in Online-Foren
- Holen Sie Kundenfeedback ein
Passen Sie Ihren Leitfaden an das Können und die Sichtweise Ihres Publikums an
Sie möchten auch wissen, wie gut sich Ihre Leser mit dem Thema auskennen. Unterschiedliche Zielgruppen haben unterschiedliche Fähigkeiten. Eine hervorragende Anleitung ist auf die technischen Fähigkeiten der Zielgruppe abgestimmt, egal ob Anfänger oder Experte.
Überprüfen Sie Suchbegriffe und Feedback zu vorhandenen Schulungs- oder Lehrmaterialien. Sprechen Sie mit Ihrem Kundensupport-Team, um Einblicke in das Kundenerlebnis zu erhalten. Verstehen Sie die Schlüsselwörter, die Ihre Zielgruppe verwendet – zum Beispiel bei Internetsuchen. Welche Sprache verwenden sie, um das Thema, ihre Probleme oder Unklarheiten zu beschreiben?
Schritt 2: Strukturieren Sie Ihren Leitfaden
„Einfach wie 1-2-3“ – Erstellen Sie Schritt-für-Schritt nummerierte Listen und Aufzählungspunkte
Es überrascht nicht, dass nummerierte Listen leichter zu verstehen sind als eine dichte Textwand. Teilen Sie Ihren Leitfaden in einzelne Schritte oder überschaubare Abschnitte auf.
Denken Sie daran, dass Ihr Publikum beim Lesen möglicherweise zwischen Ihrem Leitfaden und der Aufgabe hin und her wechselt. Die Nummerierung oder Beschriftung der Schritte hilft dem Publikum, mitzumachen.
Textwand? Nächste!
Snagit erleichtert eine effektivere Kommunikation mit visuellen Elementen.
Erfahren Sie mehrFolgen Sie einer Leitfadenvorlage
Wenn Ihre Organisation mehrere Leitfäden oder eine Reihe erstellt, sollten Sie die Verwendung einer Leitfadenvorlage in Betracht ziehen. Konsistente Leitfäden, die auf derselben Vorlage basieren, helfen Ihren Lesern zu wissen, was sie erwartet. Außerdem wird das Schreiben von Anweisungen und das Erstellen von Leitfäden für andere in Ihrer Organisation viel schneller und einfacher!
Erwägen Sie beispielsweise, in Ihre Vorlage eine Einleitung aufzunehmen, um Folgendes zu identifizieren:
- Die Zielgruppe des Leitfadens.
- Das Ziel des Leitfadens oder was ein Leser erwarten kann.
- Software, Tools oder Ressourcen, die zum Abschließen des Prozesses erforderlich sind.
- Kontaktinformationen oder Hilferessourcen für den Fall, dass der Leser in Schwierigkeiten gerät.
Betrachten Sie eine Schlussfolgerung in Ihrer Vorlage:
- Um den Zweck oder das Ziel des Leitfadens noch einmal zusammenzufassen: Was sollte Ihr Leser jetzt tun können?
- Nächste Schritte oder Folgeanleitungen in der Serie
- Kontaktinformationen oder Hilferessourcen
Schauen Sie sich unbedingt die vorgefertigten, professionell gestalteten Vorlagen von Snagit an. Wir haben sogar eine Kategorie von „Schritten“-Vorlagen, die darauf ausgelegt sind, 2–6 Schritte auf einer einzigen Seite unterzubringen. Diese Vorlagen können auch geändert werden, um bei Bedarf zusätzliche Schritte auf weiteren Seiten hinzuzufügen!
Schritt 3: Schreiben Sie eine Schritt-für-Schritt-Anleitung
Erstellen Sie klare und prägnante Schritte
Jetzt ist es Zeit zu schreiben!
Anstatt mich auf mein (zugegebenermaßen schlechtes) Gedächtnis zu verlassen, gehe ich die Aufgabe zunächst selbst durch und notiere dabei jeden Schritt. Gerade bei vertrauten Aufgaben, die ich regelmäßig erledige, ist es wichtig, mögliche Stolpersteine für neue Benutzer zu beachten.
Stellen Sie sicher, dass die in Ihrem Leitfaden verwendete Sprache und Begriffe mit dem übereinstimmen, was der Benutzer auf seinem Bildschirm sieht.
Achtung! Fragen Sie sich, ob es Punkte gibt, an denen sich das, was Sie sehen, von dem unterscheidet, was Ihr Publikum sieht, oder ob die Schritte variieren können. Ist es beispielsweise möglich, dass Ihr Leser eine andere Softwareversion, ein anderes Betriebssystem oder einen anderen Browser verwendet?
Bilder hinzufügen
Ich mache Screenshots oder Fotos in Echtzeit, während ich die Aufgabe durchgehe.
Bilder helfen, einen Schritt zu veranschaulichen oder einen Kontext bereitzustellen. Sie tragen dazu bei, dass Ihr Leitfaden leicht verständlich ist und dass Ihr Publikum unabhängig von seinem Kenntnisstand folgen kann.
Kommentieren Sie die Bilder mit Pfeilen, Kommentaren oder Beschriftungen. Diese Art von Bildern stellt sicher, dass Ihr Leser den Text und das Bild miteinander verbindet.
Achten Sie darauf, überflüssige Details aus den Bildern zu entfernen, die Ihren Leser verwirren oder vom Fokus ablenken könnten.
Erinnern Sie sich an die Zielgruppe, die Sie in Schritt 1 identifiziert haben, und an deren Bekanntheitsgrad? Müssen Sie erklären, wo Sie die einzelnen Elemente auf dem Bildschirm finden können?
Es kann beispielsweise hilfreich sein, wenn Sie jemandem sagen, dass er auf die Schaltfläche „Einstellungen“ klicken soll, um zu erklären, dass es wie ein Zahnrad aussieht. Möglicherweise müssen Sie auch die Positionen leicht übersehener Symbole oder doppelter Elemente auf dem Bildschirm hervorheben.
Schritt 4: Fügen Sie zusätzliche Informationen und Ressourcen hinzu
Fügen Sie relevante Links und Ressourcen hinzu
Wenn die in Ihrem Leitfaden dokumentierte Aufgabe zusätzliche Ressourcen erfordert oder durch diese ergänzt werden kann, beziehen Sie diese unbedingt mit ein. Dies können Projektquelldateien oder Links zu verwandten oder ausführlicheren Tutorials sein.
Dies kann Download-Links für andere Produkte umfassen. Ihre Anleitung sollte keine getarnte Verkaufs- oder Marketingseite sein. Wenn eine andere Software den Bedürfnissen Ihrer Zielgruppe besser entspricht, bieten Sie Beratung an, insbesondere wenn kostenlose Optionen verfügbar sind.
Geben Sie Kontext und Hintergrund an
Helfen Sie Ihren Lesern zu verstehen, warum Ihr Leitfaden für sie von Nutzen ist. Fügen Sie relevante Beispiele hinzu oder was sie tun können sollten, nachdem sie dem Leitfaden gefolgt sind.
In einem komplexen Prozess kann die Bereitstellung von Hintergrundinformationen im Leitfaden die Notwendigkeit bestimmter Schritte rechtfertigen. Dieser zusätzliche Kontext kann Benutzern helfen, den Grund für den Prozess zu verstehen, insbesondere wenn dieser unbekannt ist.
Kommentieren und bearbeiten Sie Screenshots mit Snagit
Professionelle Markup-Tools und leistungsstarke Funktionen erleichtern die Erstellung hilfreicher Bilder.
Probieren Sie es kostenlos ausSchritt 5: Testen Sie Ihre Anleitung
Stellen Sie Genauigkeit und Benutzerfreundlichkeit sicher
Sobald die schriftliche Liste der Schritte mit unterstützenden Bildern zusammengestellt ist, überprüfen Sie Ihren Leitfaden auf Richtigkeit:
- Haben Sie Schritte verpasst?
- Stimmt die Sprache mit dem überein, was die Leser sehen werden?
- Stellen Sie bei Softwarehandbüchern sicher, dass die Anweisungen für alle Versionen, die Ihre Leser möglicherweise verwenden, korrekt sind. Geben Sie alternativ die jeweilige abgedeckte Version an und geben Sie an, wo Sie Hilfe für andere Versionen erhalten.
Es ist immer eine gute Idee, Ihren Leitfaden von einer anderen Person überprüfen zu lassen – insbesondere von jemandem, der mit dem Vorgang nicht vertraut ist. Diese Person kann es für Sie testen, wie es ein tatsächlicher neuer Benutzer tun könnte. Wenn es Bereiche gibt, von denen Sie nicht sicher sind, ob sie klar sind, heben Sie diese hervor, um die besondere Aufmerksamkeit Ihres Prüfers zu erregen.
Diese Person kann Ihnen dabei helfen, sicherzustellen, dass Ihre Dokumentation nicht nur korrekt, sondern auch leicht verständlich ist:
- Ist die Sprache klar und leicht verständlich?
- Gibt es zu komplexe Schritte, die weiter aufgeschlüsselt werden sollten?
- Sind die richtigen Bilder enthalten, um Klarheit und Kontext zu schaffen?
Zu wissen, dass jemand Fehler findet oder Verbesserungen an Ihrer Dokumentation vorschlägt, kann unangenehm sein. Allerdings ist die Wahrscheinlichkeit größer, dass Ihre Leser erfolgreich sind, wenn Sie Ihr Team voll ausschöpfen, um potenzielle Probleme zu erkennen.
Wenn niemand sonst den Leitfaden überprüfen kann, gehen Sie ihn selbst durch, um Genauigkeit und Benutzerfreundlichkeit zu gewährleisten. Warten Sie ein oder zwei Tage, nachdem Sie mit dem Schreiben einer Anleitung fertig sind, bevor Sie sie durchgehen, vorausgesetzt, Sie haben keine Deadline. Dies wird Ihnen helfen, den Leitfaden aus einer neuen Perspektive zu betrachten, als wären Sie ein neuer Benutzer.
Nehmen Sie Überarbeitungen auf der Grundlage des Feedbacks vor
Und natürlich können Sie den Leitfaden je nach Bedarf auf der Grundlage von Bewertungen überarbeiten. Seien Sie darauf vorbereitet, Feedback von Ihrem Publikum zu erhalten, und seien Sie offen dafür, Ihren Leitfaden bei Bedarf zu überarbeiten.
Schritt 6: Veröffentlichen und verteilen Sie Ihren Leitfaden
Wählen Sie die richtige Plattform
Wenn es an der Zeit ist, Ihren Leitfaden zu veröffentlichen, denken Sie über den besten Standort und die beste Verteilungsmethode nach. Einige Dinge, die Sie beachten sollten:
- Wenn diese Dokumentation intern ist, kann die einfache Auffindbarkeit die Produktivität erheblich steigern.
- Muss Ihr Leitfaden, wenn er öffentlich zugänglich ist, verteilt werden? Zum Beispiel per E-Mail von Vertriebsteams oder Customer Success Managern an neue Kunden?
- Oder wie werden Ihre Zielgruppen es finden, wenn es auf Ihrer Website platziert wird?
- Wenn Sie Ihren Leitfaden einer breiten Öffentlichkeit zugänglich machen möchten, ist es besser, Online-Links zu versenden, anstatt PDFs zu verwenden oder ihn an verschiedenen Orten zu veröffentlichen. Verwalten Sie Leitfäden an einem einzigen Ort, um Aktualisierungen zu erleichtern und die Verbreitung veralteter Versionen zu verhindern.
- Haben einige Ihrer Leser Fragen, Kommentare oder Tipps, die für andere hilfreich sind? Erwägen Sie, Ihren Leitfaden auf einer Plattform mit integrierten Gesprächen wie Screencast zu veröffentlichen.
Optimieren Sie für SEO
Wie wird Ihre Zielgruppe Ihren Leitfaden finden, wenn er öffentlich veröffentlicht wird?
Stellen Sie sicher, dass Ihre Anweisungen mit dem Bildschirminhalt übereinstimmen. Die beschreibenden Abschnitte Ihres Reiseführers sollten nach Möglichkeit die Sprache Ihrer Leser widerspiegeln.
Wenn Sie in Schritt 1 Ihre Zielgruppe recherchieren, erhalten Sie Einblicke in deren Sprache. Integrieren Sie dies in Ihren Leitfaden, um den Leuten die Suche zu erleichtern.
Erwägen Sie die Verwendung von SEO-Optimierungstools wie SEMrush oder dem Yoast-Plugin für WordPress. Eine Verbesserung der Suchmaschinenoptimierung verbessert die Fähigkeit, Ihre Inhalte bei Bedarf zu finden.
Zusammenfassung: Best Practices zum Schreiben einer praktischen Anleitung
Verwenden Sie eine einfache, direkte Sprache
Der wichtigste Teil bei der Bewertung einer praktischen Anleitung besteht darin, festzustellen, ob sie leicht zu befolgen ist. Verwenden Sie eine einfache, direkte Sprache, der Ihre Benutzer folgen können, unabhängig von ihrem Kenntnisstand.
Fügen Sie Bilder hinzu, um jeden Schritt zu verdeutlichen
Vermeiden Sie Verwirrung bei Ihren Lesern. Zeigen Sie mit einem kommentierten Screenshot oder Foto für jeden Schritt, was Sie meinen.
Aktualisieren Sie Ihren Leitfaden regelmäßig
Stellen Sie sicher, dass Ihr Leitfaden korrekt bleibt, indem Sie ihn regelmäßig überprüfen und aktualisieren. Sofern online verfügbar, tragen Updates auch zur Verbesserung von SEO und Ranking bei.
Das Wichtigste dabei: Machen Sie es sich leicht
Lassen Sie nicht zu, dass die Erstellung einer Anleitung länger dauert als die Schulung selbst!
Nutzen Sie Snagit, den Marktführer für Bildschirmaufnahmesoftware. Sie werden es lieben, eine Komplettlösung für Bildschirmaufnahme, GIF-Erstellung, Anmerkungen, Vorlagen und flexible Exportoptionen zu verwenden.
Hören Sie auf, wiederholte Fragen zu stellen
Erstellen Sie mit Snagit anschauliche Videos und Anleitungen, sodass Sie Aufgaben nur einmal erklären müssen.
Probieren Sie es kostenlos aus