Verwenden Sie diese Vorlage
Ein großartiger Software-User-Guide ist kürzer, schärfer und stärker auf Aufgaben ausgerichtet als ein vollständiges Handbuch – und ist oft sogar nützlicher. Mit Trupeer können Sie Stunden beim Schreiben von User Guides sparen, indem Sie mit einer kostenlosen Vorlage für einen Software-User-Guide starten, sie mit Ihren Brand-Richtlinien anpassen und mit unserem KI-Manual-Ersteller Produkt-Durchläufe in ansprechende Video-Guides verwandeln.
Was ist eine kostenlose Vorlage für einen Software-User-Guide?
Eine kostenlose Vorlage für einen Software-User-Guide ist eine wiederverwendbare Struktur für die Dokumentation, die Ihre Endnutzer lesen: wie man die Dinge erledigt, für die die Software gedacht ist – geschrieben für die Person, die sie nutzt, nicht für die Person, die sie erstellt oder betreibt.
Sie ist ein Mitglied einer größeren Familie. Referenzdokumentation, Architekturaufzeichnungen, Betriebs-Runbooks und Release Notes richten sich an unterschiedliche Leser, und die Seite zur Software-Dokumentation erklärt, wie diese sich aufteilen. Diese Seite geht um die, die Ihre Kunden tatsächlich öffnen.
Die Vorlage ist nicht der Guide. Die Abschnittsliste braucht zwanzig Minuten zum Schreiben. Was entscheidet, ob ein User Guide funktioniert, ist eine strukturelle Annahme, die die meisten Vorlagen übernehmen, ohne es zu merken – und sie ist falsch.
Das Format folgt der Nutzung. Eine Word-Datei für eine kostenlose Vorlage für einen Software-User-Guide passt zu einem Guide, der als Dokument bereitgestellt wird – heute die Minderheit, aber immer noch üblich bei On-Premise-Software und regulierten Produkten. Und eine Word-Vorlage für ein User Manual ist dieselbe Tradition unter einem älteren Namen. Eine kostenlose Word-Vorlage für einen Schritt-für-Schritt-User-Guide mit freiem Layout ist der nächstliegende gemeinsame Startpunkt. Ein kostenloses PPT-Layout für einen Software-User-Guide eignet sich für Trainingsmaterial, das aus dem Guide abgeleitet ist, statt für den Guide selbst. Und eine kostenlose Excel-Datei für einen Software-User-Guide passt zum Content-Inventar statt zum Guide. Die meisten Software-User-Guides leben heute auf einer Help-Site, und das verändert die Struktur erheblich – aus dem unten genannten Grund.
Niemand liest einen User Guide von Anfang an
Schauen Sie sich die Analysen für irgendeine Online-Help-Site an, und eine Zahl beendet die Diskussion.
Der Anteil der Besuche, die auf der Startseite oder der Inhaltsseite beginnen, ist gering. Die meisten Nutzer landen direkt auf einer tiefen Seite – über eine Websuche oder über einen Help-Link innerhalb des Produkts – und bringen eine konkrete Frage mit.
Sie haben die Einleitung nicht gelesen. Sie wissen nicht, in welchem Kapitel sie sich befinden. Sie haben den Abschnitt zu den Begriffen nicht gesehen, die Setup-Anweisungen nicht, und auch nicht den Hinweis in Kapitel zwei, der erklärt, dass alles danach ein konfiguriertes Konto voraussetzt.
Und dennoch ist fast jeder User Guide wie ein Buch strukturiert: eine Inhaltsseite, Kapitel in logischer Reihenfolge und Seiten, die davon ausgehen, dass der Leser die vorherigen bereits durchgegangen ist. Diese Struktur wurde aus gedruckten Handbüchern übernommen, wo sie korrekt war, und sie überlebt in der Online-Help – obwohl sie dort nicht passt.
Das Ergebnis ist ein Dokument, das für seinen Autor stimmig ist, aber für den tatsächlichen Leser „kaputt“. Eine Seite, die mit „Weiter geht es mit dem vorherigen Abschnitt“ beginnt, ist eine Sackgasse für die siebzig Prozent der Menschen, die nicht aus dem vorherigen Abschnitt gekommen sind.
So passen Sie diese Vorlage in Trupeer an
Schritt 1: Öffnen Sie den Bereich „Vorlagen“
Gehen Sie im Hauptmenü zum Bereich „Vorlagen“.
Schritt 2: Wählen und öffnen Sie eine Vorlage
Klicken Sie auf eine beliebige Vorlage, mit der Sie arbeiten möchten, um sie zu öffnen.
Schritt 3: Ansicht der Vorlage erweitern
Falls nötig, erweitern Sie die Vorlagenansicht, um das vollständige Layout und die Details klar zu sehen.
Schritt 4: Bearbeiten Sie die Vorlage
Klicken Sie auf „Bearbeiten“, um mit der Anpassung der ausgewählten Vorlage zu beginnen.
Im Editor können Sie:
Neue Abschnitte hinzufügen
Formatierungsregeln definieren oder aktualisieren
Ein Logo hinzufügen und Position sowie zugehörige Einstellungen anpassen
Schritt 5: Speichern Sie Ihre angepasste Vorlage
Nachdem Sie alle notwendigen Änderungen vorgenommen haben, klicken Sie auf „Speichern“, um die aktualisierte Vorlage als Ihre eigene zu sichern.
Schritt 6: Vorschau ansehen und die Vorlage feinjustieren
Wenn Sie sehen möchten, wie Ihre angepasste Vorlage aussieht, öffnen Sie die Vorschau.
Ausgehend vom Vorschau-Bildschirm können Sie bei Bedarf direkt weitere Anpassungen vornehmen und so sicherstellen, dass die Vorlage genau so erscheint, wie Sie es möchten.
Mit einer Software-User-Guide-Vorlage können Sie:
Stunden beim Schreiben sparen: Überspringen Sie die leere Seite mit einer Struktur, die für User Guides entwickelt wurde.
Support-Tickets reduzieren: Klare Guides helfen Nutzern beim Self-Service.
Im Brand bleiben: Nutzen Sie Ihr Logo, Ihre Schriftarten und Farben mit Trupeer's Brand Kit.
Adoption verbessern: Aufgabenorientierte Guides helfen Nutzern, schneller einen Mehrwert zu erzielen.
Video-Durchläufe hinzufügen: Betten Sie Videos für Schritte ein, die sich im Text schwer erklären lassen.
Globale Nutzer erreichen: Übersetzen Sie User Guides mit einem Klick in 65+ Sprachen.
Jede Seite ist Seite eins
Die Design-Regel folgt direkt. Schreiben Sie jede Seite so, als wäre sie die einzige Seite, die der Leser jemals sehen wird – denn für die meisten ist sie das.
Sechs Konsequenzen, und alle sind günstig.
Benennen Sie auf der Seite, was die Seite voraussetzt. Nicht im Vorwort. Wenn die Aufgabe eine Admin-Rolle, eine konfigurierte Integration oder einen abgeschlossenen Setup-Schritt erfordert, sagen Sie das in den ersten zwei Zeilen – dort, wo jemand erkennen kann, dass er an der falschen Stelle ist, bevor er fünf Minuten damit verbringt, herauszufinden, was los ist.
Wiederholen statt auf Querverweise setzen. Drei Zeilen wiederholter Voraussetzungen sind günstiger als ein Link, dem ein Leser folgen, den er lesen und von dem er zurückkommen muss. Wiederholung stört Autoren und hilft Lesern – und der Leser ist die Person, für die Sie schreiben.
Entfernen Sie jeden Hinweis auf Positionen. Wie oben im vorherigen Abschnitt beschrieben, verwenden Sie die Methode aus 5.2. Jede dieser Annahmen setzt eine Lesereihenfolge voraus, der die meisten Leser nicht gefolgt sind. Ersetzen Sie das entweder durch die tatsächliche Anweisung oder durch einen benannten Link.
Titulieren Sie die Seite als Frage, nicht als Feature. Weiter unten wird darauf eingegangen, weil es der Unterschied zwischen „gefunden werden“ und „nicht gefunden werden“ ist.
Schließen Sie mit einem oder zwei ausgewählten nächsten Schritten ab. Kein Navigationsbaum. Der Leser hat etwas abgeschlossen und es gibt normalerweise genau eine offensichtliche nächste Sache – nennen Sie sie.
Fügen Sie jede Seite zusammen, die nicht für sich allein stehen kann. Wenn eine Seite ohne eine andere wirklich keinen Sinn ergibt, sind es im Grunde zwei Seiten, die nur aus Bequemlichkeit für den Autor getrennt wurden.
Die beste kostenlose Vorlage für einen Software-User-Guide ist daher diejenige, die es Ihnen ermöglicht, auf diese Weise zu schreiben. Der Test dauert Sekunden. Öffnen Sie irgendeine Seite in Ihrem Guide „kalt“, als wären Sie über eine Suche dorthin gekommen, und fragen Sie sich, ob Sie die Aufgabe abschließen könnten. Die meisten Guides scheitern daran auf der Mehrheit ihrer Seiten, und die Probleme konzentrieren sich in den mittleren Kapiteln, in denen Autoren am meisten Kontext im Kopf hatten.
Was eine Seite in einem Software-User-Guide enthalten muss
Bausteine für eine einzelne Seite – denn die Seite statt das Buch ist die Einheit.
Komponente | Wofür sie sorgt |
|---|---|
Titel als Frage des Nutzers | Was sie eintippen oder fragen würden – nicht wie das Feature intern heißt. |
Wofür diese Seite gedacht ist | Eine Zeile. Was Sie am Ende erreicht haben werden. |
Was sie voraussetzt | Rolle, Berechtigungen, vorheriges Setup, vorheriger Zustand. Klar benannt, nicht verlinkt. |
Nummerierte Schritte | Jeweils eine Aktion, in der Reihenfolge, in der sie ausgeführt wird. |
Was Sie sehen sollten | Pro Schritt, wenn das Ergebnis nicht offensichtlich ist – damit ein Leser weiß, ob er weitermachen soll. |
Screenshot oder kurzes Video, bei dem Erkennen besser ist als Beschreiben | Nur dort, wo es seinen Platz verdient – aus den unten beschriebenen Gründen. |
Häufige Probleme | Zwei oder drei, aus Support-Tickets statt ausgedacht. |
Nächste Schritte | Einer oder zwei, bewusst ausgewählt. |
Letztes Verifizierungsdatum und Version | Wann jemand diese Schritte zuletzt ausgeführt hat und welche Produktversion. |
Über das Set als Ganzes hinaus brauchen Sie außerdem eine funktionierende Suche, eine Möglichkeit für Leser, zu melden, dass eine Seite falsch ist, und einen Verantwortlichen. Der Melde-Link ist der günstigste Qualitätsmechanismus, der verfügbar ist – und fast niemand hat ihn.
Kostenlose Software-User-Guide-Vorlage: die Struktur zum Kopieren
Mit einem echten Beispiel statt Platzhaltern. Die Software ist eine Praxisverwaltungssoftware für Tierarztpraxen.
Kopieren Sie von hier.
Titel. So erstatten Sie einem Kunden Geld zurück. Nicht: Verarbeitung der Stornierung einer Gutschrift.
Wofür diese Seite gedacht ist. Geld an einen Kunden zurückgeben – für eine Rechnung, die er bereits bezahlt hat – und es korrekt den Konten der Praxis zuordnen.
Was sie voraussetzt. Sie haben die Berechtigung „Abrechnung“. Praxen im Standard-Tarif haben diese standardmäßig nur für Praxismanager. Die Rechnung wurde bezahlt und abgeglichen. Wenn sie nicht bezahlt wurde, suchen Sie nach dem Stornieren einer Rechnung – das ist eine andere Seite und ist am Ende verlinkt.
Schritte.
Öffnen Sie den Datensatz des Kunden und wählen Sie den Tab „Abrechnung“. Sie sollten eine Liste der Rechnungen sehen, jeweils mit einem Status.
Finden Sie die bezahlte Rechnung. Bezahlt-Rechnungen zeigen ein grünes Häkchen. Wenn stattdessen eine bernsteinfarbene Uhr angezeigt wird, wurde sie noch nicht abgeglichen – dann müssen Sie auf den Abgleich warten, bevor Sie erstatten.
Wählen Sie die Rechnung und dann „Erstattung“. Es öffnet sich ein Erstattungs-Panel, das den vollständigen Betrag anzeigt.
Geben Sie den Erstattungsbetrag ein. Teil-Erstattungen sind zulässig. Der Betrag darf den bezahlten Gesamtbetrag nicht überschreiten.
Wählen Sie einen Grund aus der Liste. Dieser erscheint im Kontoauszug des Kunden – wählen Sie also denjenigen, den Sie möchten, dass er liest.
Wählen Sie „Erstattung verarbeiten“. Sie sollten eine Bestätigung sehen, mit einer Erstattungsreferenz, die mit REF beginnt.
Was Sie danach sehen sollten. Der Status der Rechnung ändert sich zu „Erstattet“ oder „Teilweise erstattet“. Die Erstattung erscheint innerhalb von fünfzehn Minuten im Tagebuch.
Häufige Probleme.
Die Schaltfläche „Erstattung“ ist ausgegraut – das bedeutet normalerweise, dass die Rechnung noch nicht abgeglichen wurde. Warten Sie und aktualisieren Sie.
Die Erstattung erscheint nicht im Tagebuch – das bedeutet normalerweise, dass sie nach dem Cut-off des Tagebuchs verarbeitet wurde und morgen angezeigt wird.
Sie können den Tab „Abrechnung“ überhaupt nicht sehen – das bedeutet, dass Sie nicht über die Berechtigung „Abrechnung“ verfügen. Ihr Praxismanager kann sie Ihnen geben.
Nächste Schritte. Nur zwei: Eine unbezahlte Rechnung stornieren. Einen Kontoauszug für den Kunden erstellen.
Zuletzt verifiziert. 7. Mai, in Version 14.2, durch ein Mitglied des Support-Teams, das diese Schritte von Anfang an durchgeführt hat.
Kopieren Sie hierher.
Beachten Sie, dass der Abschnitt „Annahmen“ Informationen dupliziert, die auch auf der Seite „Berechtigungen“ stehen. Diese Duplizierung ist beabsichtigt und genau der Punkt.
User-Guide-Beispiel: hundert und zwölf Seiten, die noch eine weitere Seite brauchten
Marlbury Systems liefert Praxisverwaltungssoftware an etwa viereinhalbtausend Tierarztpraxen. Der User Guide umfasste hundertachtzig Seiten, wurde online veröffentlicht und war als Handbuch strukturiert: Einstieg, Kunden und Patienten, Termine, klinische Inhalte, Abrechnung, Berichte, Administration.
Er war gründlich, korrekt und gut geschrieben. Er wurde von einem technischen Autor erstellt, der das Produkt wirklich kannte.
Zwei Zahlen aus den Analysen starteten die Untersuchung. 78 Prozent der Besuche kamen direkt auf eine tiefe Seite – über eine Suchmaschine oder über den Help-Link im Produkt. Und die durchschnittliche Zeit auf der Seite betrug vierzehn Sekunden.
Vierzehn Sekunden ist kein Lesen. Es ist Ankommen, Scannen und wieder Gehen.
Das Support-Team lieferte die andere Hälfte des Bildes. Die fünf am häufigsten besuchten Help-Seiten erzeugten mehr Tickets als alle anderen – das ist das Gegenteil dessen, wofür eine Help-Seite gedacht ist.
Jemand prüfte den Guide anhand einer einzigen Frage: Kann ein Leser, der „kalt“ auf diese Seite kommt, die Aufgabe abschließen?
Hundert und zwölf der hundertachtzig Seiten enthielten mindestens einen Verweis, der eine weitere Seite erforderte. Wie oben beschrieben. Weiter geht es mit dem vorherigen Abschnitt. Mit der Methode aus 5.2. Sobald Sie das Setup in Kapitel eins abgeschlossen haben.
Die Erstattungsseite, eine der meistbesuchten im gesamten Guide, begann mit einem Satz, der den Leser auf den vorherigen Abschnitt verwies, um eine Rechnung zu finden. Die meisten Menschen, die sie lasen, hatten den vorherigen Abschnitt nie gesehen und hatten keinen Grund zu wissen, dass er existiert.
Die Überarbeitung änderte keine Fakten. Voraussetzungen wurden auf jeder Seite neu formuliert, statt verlinkt zu werden. Positionsbezogene Verweise wurden durch konkrete Anweisungen ersetzt. Die Seitentitel wurden anhand des eigenen Suchprotokolls der Website neu geschrieben – dort war zu sehen, dass Nutzer nach „Erstattung“ suchten, während die Seite „Verarbeitung der Stornierung einer Gutschrift“ als Titel trug. Jede Seite erhielt einen kurzen Abschnitt mit Annahmen und zwei bewusst ausgewählte nächste Schritte.
Vier Monate später war die Zeit auf der Seite von vierzehn Sekunden auf einundsiebzig gesunken. Tickets, die sich auf die Top-zwanzig-Themen bezogen, waren um etwa einundvierzig Prozent zurückgegangen. Der Anteil der Nutzer, die in der In-Product-Help öffneten und sich danach nicht an den Support wandten, stieg von vierunddreißig Prozent auf achtundfünfzig.
Der Guide wurde länger, weil wiederholte Voraussetzungen Platz brauchen. Er wurde aber auch tatsächlich genutzt.
So schreiben Sie einen Software-User-Guide in sechs Schritten
Holen Sie sich die Liste der Seiten aus Support- und Suchdaten, nicht aus der Menüstruktur des Produkts. Die Tickets zeigen Ihnen, was Menschen nicht können, und das Suchprotokoll zeigt Ihnen, welche Wörter sie verwenden.
Schreiben Sie eine Seite pro Aufgabe, betitelt als Frage. Wenn ein Titel einen Feature-Namen enthält, den Ihre Nutzer nicht laut aussprechen würden, ändern Sie ihn.
Schreiben Sie zuerst den Abschnitt „Annahmen“, bevor Sie die Schritte schreiben. Dieser Abschnitt verhindert, dass jemand fünf Minuten auf der falschen Seite verschwendet.
Schreiben Sie die Schritte, indem Sie sie ausführen, nicht aus dem Gedächtnis. Alles, was Sie automatisch tun, würde sonst fehlen.
Nehmen Sie häufige Probleme aus der Ticket-Warteschlange. Drei echte sind besser als zehn ausgedachte.
Testen Sie, indem Sie „kalt“ ankommen. Öffnen Sie die Seite, als wären Sie ein Fremder, und versuchen Sie, die Aufgabe abzuschließen, ohne etwas anderes zu öffnen.
Schritt eins ist das, was einen Guide, der um Nutzer organisiert ist, von einem unterscheidet, der um die Software organisiert ist. Die Menüstruktur des Produkts ist eine Karte, wie die Software gebaut wurde. Sie ist keine Karte dessen, was Menschen versuchen zu tun.
Seiten so benennen, dass Menschen sie finden
Titel sind in einem User Guide wichtiger als in fast jedem anderen Dokument, weil die Suche der primäre Einstiegspunkt ist und der Titel den größten Teil des passenden Gewichts trägt.
Drei Regeln.
Nutzen Sie das Wort des Nutzers, nicht Ihres. Wenn Ihr Suchprotokoll zeigt, dass Menschen „Erstattung“ eintippen und Ihre Seite „Stornierung einer Gutschrift“ sagt, ist die Seite für sie unsichtbar. Prüfen Sie das Protokoll. Es ist die günstigste verfügbare Recherche – und die meisten Teams öffnen es nie.
Beginnen Sie mit dem Verb. So erstatten Sie einem Kunden Geld zurück. Nicht: Kunden-Erstattungen, Überblick über. Das Verb passt zuerst dazu, wie Menschen fragen, und liest sich schneller in einer Liste von Suchergebnissen.
Eine Aufgabe pro Titel. Eine Seite mit dem Titel „Abrechnung verwalten“ deckt alles ab und trifft nichts. Teilen Sie sie.
Wenn ein interner Begriff wirklich der richtige ist, weil er in der Oberfläche vorkommt, setzen Sie das Wort des Nutzers in die erste Zeile der Seite, damit es weiterhin auffindbar bleibt. Sie optimieren gleichzeitig für zwei Zielgruppen: die Suchmaschine und die Person, die Ergebnisse überfliegt.
Screenshots und das Wartungsproblem
Screenshots helfen am meisten dort, wo Erkennen besser ist als Beschreiben: wenn es darum geht, eine bestimmte Steuerung unter vielen zu identifizieren, einen ungewohnten Bildschirm zu zeigen oder zu bestätigen, wie ein erfolgreiches Ergebnis aussieht.
Sie sind aber auch die größte einzelne Wartungsbelastung in einem User Guide. Ein Guide mit zweihundert Screenshots ist ein Guide mit zweihundert Dingen, die beim nächsten Interface-Update still kaputtgehen – und Interfaces ändern sich alle paar Wochen.
Drei Regeln halten die Kosten im Verhältnis.
Nutzen Sie sie dort, wo das Benennen schwer ist, und lassen Sie sie weg, wenn die Anweisung für sich klar ist. Ein Screenshot einer Schaltfläche mit der Beschriftung „Speichern“ fügt nichts hinzu.
Kommentieren Sie direkt, statt zu beschreiben, wo im Text man hinschauen soll. Ein nicht markierter Screenshot eines vollen Bildschirms ist ein Rätsel.
Datieren Sie sie und wissen Sie, welche Produktversion sie zeigen, damit ein Leser erkennen kann, ob das, was er sieht, noch existiert.
Die ehrliche Position ist, dass die meisten Teams mit guten Absichten zur visuellen Dokumentation starten und am Ende bei Text landen – weil die Kosten, um nach jeder Veröffentlichung erneut zu erfassen, die verfügbare Zeit übersteigen. Das ist ein Produktionsproblem statt ein Problem der Bereitschaft, und darauf wird weiter unten eingegangen.
User Guide, User Manual oder How-to-Guide?
Drei sich überschneidende Begriffe – und die Unterschiede sind hilfreich, wenn Sie eine Struktur auswählen.
Ein User Guide deckt ein Softwareprodukt über die Aufgaben ab, die seine Nutzer ausführen. Mehrere Seiten, die an jedem Punkt betreten werden können, werden kontinuierlich gepflegt.
Ein User Manual ist dasselbe in der älteren, dokumentenorientierten Tradition – und der Begriff ist weiterhin Standard für physische Produkte und für Software, die On-Premise bereitgestellt wird. Wenn ein Manual physische Geräte begleitet, tragen Sicherheitsinhalte und die Platzierung von Warnhinweisen Verpflichtungen, die Software-Guides nicht haben. Und die Instruction-Manual-Tradition deckt genau diesen Bereich ab.
Ein How-to-Guide ist eine einzelne Aufgabe, steht für sich und ist im Grunde eine einzelne Seite aus einem User Guide, die für sich allein veröffentlicht wurde.
Die praktische Konsequenz ist: Wenn Sie jede Seite so schreiben, dass sie für sich allein steht, wie oben argumentiert, ist Ihr User Guide bereits eine Sammlung von How-to-Guides mit einer darüberliegenden Navigation – und das ist die richtige Architektur für Online-Help.
Ein Quick-Reference-Guide ist wiederum etwas anderes: ein Nachschlageblatt für jemanden, der bereits geschult ist – abgedeckt auf der Seite zum Quick-Reference-Guide.
Was eine kostenlose Vorlage für einen Software-User-Guide nicht beheben kann
Ein Guide, der um das Produkt herum strukturiert ist. Keine Vorlage kann einen feature-orientierten Guide in einen task-orientierten umwandeln. Dafür braucht es Support- und Suchdaten.
Seiten, die niemand finden kann. Eine gut geschriebene Seite mit dem falschen Titel ist unsichtbar. Titel sind das günstigste, um sie zu beheben – und werden am seltensten wieder aufgegriffen.
Screenshots, die niemand wartet. Kein kostenloser Download einer Vorlage für einen Software-User-Guide und kein kostenloser Download einer User-Manual-Vorlage wird nach einem Redesign zweihundert Bilder erneut erfassen.
Ein Produkt, das so viel Anleitung erfordert. Wenn eine Aufgabe wirklich vierzehn Schritte und drei Warnhinweise braucht, dann leistet die Dokumentation Arbeit, die eigentlich die Oberfläche leisten sollte. Schreiben Sie es trotzdem – und geben Sie die Beobachtung an die Person weiter, die das Produkt verantwortet.
Zeigen Sie die Aufgabe statt sie zu beschreiben
Ein User Guide ist der Dokumenttyp mit dem höchsten Bildbedarf und den höchsten Kosten für die Bildwartung – und genau diese beiden Fakten erklären, warum so viele Guides schlechter sind als ihre Autoren es beabsichtigt hatten.
Die Rechnung ist unerbittlich. Ein hundertseitiger Guide mit drei Bildern pro Seite sind dreihundert Erfassungen, Zuschnitte, Annotationen und Platzierungen. Nach einem Redesign sind es wieder dreihundert. Niemand hat diese Zeit in einer Release-Woche, also werden die Bilder veraltet – und veraltete Bilder sind schlimmer als gar keine, weil Leser ihnen vertrauen.
Trupeer AI verändert die Kostenbasis. Jemand führt die Aufgabe einmal aus, während er aufzeichnet, und das Ergebnis ist eine geschriebene Schritt-für-Schritt-Seite mit Screenshots, die bereits erfasst, annotiert und platziert sind – zusammen mit einem kurzen Video in Ihrer eigenen Markenwelt. Eine Seite, die einen Nachmittag gedauert hat, dauert Minuten. Und das erneute Erfassen nach einem Redesign bedeutet nicht neu filmen, sondern neu aufzeichnen.
Aufzeichnen. Gebrandet. Übersetzen. Trupeer-n.
Zwei weitere Punkte sind speziell für User Guides wichtig. Das Video sitzt auf der Seite neben den geschriebenen Schritten – das hilft sowohl dem Leser, der scannen möchte, als auch dem Leser, der zuschauen möchte. Und das sind tatsächlich unterschiedliche Menschen, nicht dieselbe Person zu verschiedenen Zeiten. Und wenn Ihre Nutzer mehrere Sprachen abdecken, erzeugt dieselbe Aufzeichnung dieselbe Seite in jeder Sprache – ein einmal übersetzter Guide driftet also nicht vom Produkt weg, während die englische Version Schritt hält.
Das Material liegt in Ihrer Knowledge Base und dient gleichzeitig als Training für Support-Mitarbeiter, die häufig die stärksten Nutzer eines User Guides sind. Konsistenz über Ihre Dokumente hinweg ist eine Frage, den Brand Kit einmal festzulegen – und das Setup wird im Setup-Guide für Dokumentvorlagen behandelt.
Häufig gestellte Fragen
Gibt es eine kostenlose Vorlage für einen Software-User-Guide als Word-Version?
Word eignet sich für einen Guide, der als Dokument bereitgestellt wird – das gilt für On-Premise-Software, für regulierte Produkte, bei denen ein versioniertes Manual erforderlich ist, und für alles, was vertraglich übergeben wird. Eine Word-Datei für eine Software-User-Guide-Vorlage funktioniert gut für diese Fälle.
Für Software mit einer Help-Site funktioniert es schlecht. Nutzer kommen über die Suche, sie brauchen jede Seite direkt adressierbar, und ein Word-Dokument erzeugt eine einzige lange Datei ohne Einstiegspunkt pro Seite. Wenn Sie online veröffentlichen, verwenden Sie ein Dokumentationssystem und behalten Sie Word für das versionierte Deliverable.
Gibt es eine kostenlose Vorlage für einen Schritt-für-Schritt-User-Guide als Word-Version?
Ja, und die Struktur oben lässt sich direkt einfügen. Erstellen Sie das Schritt-für-Schritt-User-Guide-Template Word-Free-Layout mit einer Aufgabe pro Abschnitt, nummerierten Schritten mit jeweils einer Aktion und einer Annahmen-Zeile oben in jedem Abschnitt.
Halten Sie Abschnitte kurz genug, um für sich allein zu stehen. Der häufigste Fehler in einem Word-basierten Guide ist ein Abschnitt, der nur nach dem vorherigen Sinn ergibt – das ist in einem Dokument unsichtbar und fatal, sobald derselbe Content online veröffentlicht wird.
Gibt es eine kostenlose Vorlage für einen Software-User-Guide als PPT-Version?
Folien eignen sich für Trainingsmaterial, das aus einem Guide abgeleitet ist – nicht für den Guide selbst. Ein kostenloses PPT-Deck für einen Software-User-Guide ist ein sinnvoller Formfaktor für eine Walkthrough-Session oder ein Onboarding-Webinar.
Verwenden Sie es nicht als Referenz. Folien sind nicht so durchsuchbar, wie Nutzer es brauchen, sie können nicht aus dem Produkt heraus verlinkt werden, und wenn man ein Deck nur liest, fehlt die Erzählung, die den Großteil seiner Bedeutung trägt.
Gibt es eine kostenlose Vorlage für einen Software-User-Guide als Excel-Version?
Excel ist kein Guide-Format und ist tatsächlich sinnvoll – neben einem Guide. Eine kostenlose Excel-Datei für einen Software-User-Guide funktioniert gut als Content-Inventar: eine Zeile pro Seite, mit Titel, Verantwortlichem, letztem Verifizierungsdatum, Produktversion, monatlichen Views und zugehörigem Ticketvolumen.
Dieses Inventar sagt Ihnen, welche Seiten Sie zuerst fixen sollten. Seiten mit hohem Traffic und hohem zugehörigem Ticketvolumen sind diejenigen, die scheitern – und ohne das Inventar werden Sie die Seite bearbeiten, über die sich jemand zuletzt am meisten beschwert hat.
Lohnt sich ein kostenloser Download einer Vorlage für einen Software-User-Guide?
Die Seitenstruktur braucht zwanzig Minuten zum Erstellen – daher spart ein kostenloser Download einer Vorlage für einen Software-User-Guide wenig, und die meisten veröffentlichten Vorlagen sind wie Bücher aufgebaut: mit einer Inhaltsseite und nummerierten Kapiteln.
Diese Form zu übernehmen ist der Fehler, gegen den diese Seite argumentiert. Wenn Sie sie verwenden, entfernen Sie die Kapitelnummerierung und machen Sie jede Seite für sich allein – das ist eine Änderung daran, wie Sie schreiben, nicht an der Datei.
Ist eine User-Manual-Vorlage als Word-Datei dasselbe?
Im Großen und Ganzen ja – mit einem Unterschied in der Tradition statt im Inhalt. Eine User-Manual-Vorlage als Word-Datei stammt aus der Linie des gedruckten Manuals, daher setzt sie sequentielles Lesen voraus, eine Inhaltsseite und Seitenzahlen.
Das funktioniert für ein Dokument, das wirklich als Dokument gelesen wird – einschließlich regulierter Deliverables und Manuals, die physische Geräte begleiten. Für Online-Software-Help sind die Annahmen dahinter die Quelle des Problems, das auf dieser Seite beschrieben wird.
Wo kann ich einen User-Manual-Template-Free-Download bekommen?
Breit verfügbar und größtenteils austauschbar, weil eine nummerierte Aufgabenliste kein schwieriges Layout ist. Ein User-Manual-Template-Free-Download liefert Ihnen eine Inhaltsseite, Kapitelüberschriften und eine Seitenstruktur.
Die zwei Änderungen, die sich bei allen lohnen, sind ein Abschnitt mit Annahmen oben in jedem Abschnitt und das Entfernen jeder positionsbezogenen Querverweisung. Diese beiden Anpassungen dauern bei einem bestehenden Guide etwa eine Stunde und sind mehr wert als das Ändern der Vorlage.
Was ist die beste kostenlose Vorlage für einen Software-User-Guide?
Die beste kostenlose Vorlage für einen Software-User-Guide ist diejenige, die die Seite statt das Buch als Einheit behandelt – und fast keine tun das.
Wenn Sie Optionen vergleichen, prüfen Sie eine Sache: Hat die Vorlage auf jeder Seite einen Platz, um festzuhalten, was der Leser bereits getan haben soll? Dieses eine Feld ist es, das dafür sorgt, dass eine Seite überlebt, wenn man über eine Suche dorthin gelangt – so werden die große Mehrheit Ihrer Leser dorthin kommen.
