Hilfeartikel-Vorlage

Der von dir erstellte Hilfeartikel soll für deine Teamkollegen – und das gesamte Unternehmen – die Grundlage bilden, um Aufgaben zu bewältigen, Schwierigkeiten zu überwinden und Projekte schneller abzuschließen. Natürlich bist du selbst Experte für die entsprechenden Aufgaben, aber es lohnt sich dennoch, Kollegen nach ihrem Prozess dafür zu fragen und eure Vorgehensweisen zu vergleichen. Vielleicht kannst du sogar Best Practices von ihnen übernehmen und in deinem Dokument festhalten? 

Berücksichtige auch Fragen, die dir häufig zu dieser Aufgabe gestellt werden. Welche davon kannst du in deinem Artikel gleich beantworten, um Missverständnisse bei den Lesern zu vermeiden und dir selbst wiederholte mündliche Erklärungen zu ersparen? Nehmen wir als Beispiel einen Hilfeartikel zum Aktualisieren der Bankverbindung im Portal für die Gehaltsabrechnung: Welche Fragen stellen sich gleich zu Anfang? ("Wie lange dauert die Verarbeitung?") Welchen Schritt müssen Mitarbeiter zuerst ausführen? (Sich für das Portal registrieren und sich dann einloggen.) Wie können sie Zeit sparen? (BIC und IBAN bereithalten, da im Portal nach 10 Minuten Inaktivität eine Zeitüberschreitung auftritt.)

Hast du alle Fakten und die cleversten Vorgehensweisen notiert? Dann wird es Zeit, eine Gliederung zu erstellen, d. h. eine Liste aller Schritte, die ein Mitarbeiter durchführen muss, um die Aufgabe zu erledigen. Dabei solltest du so detailliert wie möglich vorgehen, um dir die anschließende Erstellung des Hilfeartikels zu erleichtern. Beschränke dich aber auf 3 bis 5 Schritte, damit bei den Lesern nicht der Eindruck entsteht, es handele sich um einen sehr zeitintensiven Vorgang.

Denke daran, dass es verschiedene Lerntypen gibt: Manche Menschen nehmen Informationen am besten durch Lesen auf, andere durch visuelle Inhalte, wieder andere durch Hören – und es sind auch Kombinationen möglich. Beim Erstellen deiner Gliederung solltest du also auch Hinweise zu Abbildungen, Grafiken, Videos oder Screenshots notieren, die du bereits vorliegen hast oder noch erstellen musst, um deine Anleitung lebendiger zu gestalten.

Visuelle Elemente machen deine Anleitung "greifbarer" und erleichtern das Verständnis. Wenn du bereits eine Bibliothek mit passenden Ressourcen hast, ist dieser Schritt leicht umzusetzen. Andernfalls solltest du Rücksprache mit eurem Kreativ-Team, mit Drittanbietern oder anderen Personen halten, die dir beim Anfertigen und Zusammenstellen der benötigten Materialien helfen können. Profitipp: Es gibt zahlreiche kostenlose Browser-Plug-ins für Screenshots und praktische Online-Designtools, mit denen du die entsprechenden Ressourcen selbst erstellen kannst. 

Sammle auch Links zu Inhalten, die zwar nicht Teil des Prozessablaufs, aber dennoch für den Prozess relevant sind (z. B. Überweisungstermine) und für Leser hilfreich sein könnten.

Deine Gliederung ist sorgfältig ausgearbeitet und enthält alle Schritte, die deiner Meinung nach wichtig sind. Jetzt solltest du überprüfen, ob du etwas vergessen hast oder ob vielleicht ein Schritt noch genauer beschrieben werden muss. Zeige deine Gliederung jemandem, der sich mit dem Prozess auskennt, und bitte diese Person um Feedback.

Erweitere deine Gliederung nun mithilfe der Confluence-Vorlage zu einem vollständigen Hilfeartikel. Wenn du mit dem Entwurf zufrieden bist, bitte einen Kollegen, der keine Ahnung von diesem Prozess hat, deine Anleitung zu befolgen. Fällt es ihm leicht oder gibt es Stolpersteine? Wo genau? Überarbeite die Anweisungen an den entsprechenden Stellen. 

Auf die Plätze, fertig, veröffentlichen! Deine Anleitung ist jetzt öffentlich für Benutzer verfügbar und erspart dir, die gleichen Fragen immer und immer wieder beantworten zu müssen. Auch wenn du beim Fakten sammeln und beim Testen gründlich bist, können Personen in deinem Unternehmen noch Fragen haben.

Das Tolle an der Arbeit mit Confluence: die Inhalte sind für alle zugänglich und alle Benutzer können Kommentare hinterlassen, wenn sie weitere Hilfe benötigen. Außerdem kannst du mit Confluence so viele Änderungen vornehmen, wie du möchtest. Das macht jedes Dokument lebendig und aktuell. Wenn sich die Anforderungen und Abläufe deines Teams ändern, kannst du deine Inhalte entsprechend anpassen oder die Dokumentation aktualisieren.