Close

Kategorien

Vorlage für einen Hilfeartikel

von Atlassian

So bringst du deinem Team fast alles bei

Vorlage verwenden
Vorlage für einen Hilfeartikel

Bei der Arbeit erledigen wir jeden Tag Hunderte kleine (und große) Aufgaben, die meist so sehr Routine sind, dass wir gar nicht mehr darüber nachdenken. Was für dich reine Routine ist, kann aber für Kollegen durchaus eine Herausforderung darstellen. Genau dafür haben wir die Vorlage für Hilfeartikel erstellt: Du kannst darin festhalten, wie man einen Blog verfasst und veröffentlicht, ein Passwort ändert, Unternehmensleistungen beantragt und viele andere typische Aufgaben in deinem Unternehmen durchführt. Die Vorlage spart deinen Kollegen Zeit und vermittelt ihnen wichtige Kenntnisse.

So nutzt du diese Vorlage

Schritt 1: Die Grundlagen klären

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.)

Schritt 2: Eine Gliederung erstellen

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. Versuche, dabei so detailliert wie möglich vorzugehen, 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. 

Schritt 3: Abbildungen, Grafiken und Screenshots zusammenstellen

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. Anderenfalls 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.

Schritt 3: Abbildungen, Grafiken und Screenshots zusammenstellen

Schritt 4: Zweit- und Drittmeinung einholen

Your outline is robust and includes all the steps you think make sense. Now’s the time to see if you missed anything or if any step needs more clarification. Run your outline by someone who is familiar with the process to see if they can add anything.

Flesh out your outline into a legit how-to piece using the Confluence template. Once you feel good about the draft, run it by someone who has no clue how this process works and ask them to go through it. Was it smooth sailing or did they hit a snag? And where? Clean up the instructions where your reviewer got stuck. 

Schritt 5: Veröffentlichen und auf Feedback warten

Auf die Plätze, fertig, veröffentlichen! Dein Hilfeartikel ist jetzt für alle zugänglich, bietet Kollegen Orientierung und erspart dir das zeitaufwendige Beantworten der immer gleichen Fragen. Auch wenn du beim Zusammenstellen der Fakten und beim Prüfen der Anleitung noch so gründlich warst, tauchen möglicherweise weitere Fragen oder Verständnisprobleme im Unternehmen auf.

Der Vorteil von Confluence ist, dass die Inhalte für alle offen sind: Jeder kann einen Kommentar hinterlassen, wenn er weitere Informationen benötigt. Außerdem kannst du die Dokumente in Confluence immer wieder bearbeiten, ändern und anpassen, wenn sich die Anforderungen und Vorgehensweisen deines Teams ändern.


Atlassian ist ein Enterprise-Software-Unternehmen, das Produkte für Softwareentwickler, Projektmanager und das Content Management herstellt.

  • AWS architecture diagram template

    Lucidchart

    AWS-Architekturdiagramm

    Visualisiere deine Infrastruktur, um Schwächen besser erkennen zu können und Verbesserungsmöglichkeiten zu finden.

  • DevOps runbook template

    Atlassian

    DevOps-Runbook

    Unterstütze dein Operations-Team dabei, auf Systemwarnungen und -ausfälle zu reagieren.

  • DevOps change management template

    Atlassian

    DevOps-Änderungsmanagement

    Anhand dieser Vorlage kannst du eure Leistung beim Änderungsmanagement beurteilen und Risiken mindern.