17 Punkte von Aufmerksamkeit in einem Software-Handbuch

Fordern Sie direkt ein Angebot an →

Die Erstellung eines Software-Handbuchs in 17 Schritten

Die Erstellung eines Software-Handbuchs erfordert einen anderen Ansatz als die Erstellung eines Handbuchs für ein physisches Produkt. Eine gute Kenntnis der Unterschiede trägt zur Qualität des Handbuchs bei. Die folgende Liste beschreibt kurz die wichtigsten Merkmale eines Software-Handbuchs.

Inhalt

1. Konzentrieren Sie sich auf relevante Informationen

Die Benutzer sollten sich nicht durch endlose Mengen von Papier mit „nur Informationen“ arbeiten müssen. Daher ist es wichtig, dass nur das absolute Minimum an Informationen enthalten ist, die man wissen muss. Alle Informationen, die ’nett zu wissen‘ sind, sollten aus dem Handbuch gestrichen werden, um die Aufmerksamkeit beim Erlernen der entsprechenden Fertigkeiten aufrechtzuerhalten. (Minimalismus Prinzip Nr. 1a)

2. Konzentrieren Sie sich auf Aktion

Es ist wichtig, ein Handbuch zu entwerfen, das die Benutzer eine unmittelbare Handlungsmöglichkeit bietet. Das bedeutet, dass weniger konzeptionelle Informationen gegeben werden und der Schwerpunkt mehr darauf liegt, den Benutzer grundlegende Verfahren üben zu lassen. Man möchte etwas mit einem Produkt machen und nicht darüber lesen. Eine der größten Herausforderungen besteht darin, das richtige Gleichgewicht zwischen der Unterstützung von Benutzeraktionen und der Bereitstellung konzeptioneller Informationen zu finden. (Minimalismus-Prinzip Nr. 1b)

3. Regen Sie zur Erkundung an

Die Nutzer sollten regelmäßig eingeladen werden, andere Optionen des Programms zu entdecken. Versuche Erkundungen und Innovationen zu fördern und zu unterstützen. Solche Aufforderungen an den Benutzer haben oft die Form von ‚Bitte probieren Sie es aus‘, ‚Probieren Sie es aus‘ und ‚Sehen Sie, was passiert‘ (im Gegensatz zu Aufforderungen wie ‚Sie können auch …‘ und ‚Eine andere Möglichkeit ist …‘). Solche Formulierungen führen zu 33% mehr Erkundung. Geben Sie am Ende eines Kapitels oder Abschnitts die Einladung zum Erkunden. Das optimale Gleichgewicht zwischen der Vermittlung von Kenntnissen und der Förderung von Erkundungen variiert erheblich von Projekt zu Projekt. Achten Sie jedoch stets darauf, dass die Erkundung durch den Benutzer eine angemessene Chance auf Erfolg hat und einigermaßen sicher ist. Der Benutzer sollte leicht zum Ausgangspunkt zurückkehren können. (Minimalismus-Prinzip Nr. 1c)

4. Stellen Sie konzeptionelle Informationen bereit

Stellen Sie konzeptionelle Informationen bereit, wenn der Benutzer dafür am offensten ist. Software-Nutzer sind eher daran interessiert, konzeptionelle Informationen zu lesen, nachdem sie die Dinge ausprobiert haben. (Minimalismus-Prinzip Nr. 1d)

5. Respektieren Sie die Integrität der Benutzer

Das Ziel eines Benutzers ist oft kurzfristiger und weniger anspruchsvoll als das des Designers. Achten Sie als Designer darauf, dass Sie nicht zu viele Sachen einfügen, von denen Sie glauben, dass sie für den Benutzer (auch) wichtig sind. Ein Beispiel dafür ist eine passive Hilfefunktion, die der Benutzer jederzeit einschalten kann, wenn er glaubt, dass er sie braucht. (Minimalismus-Prinzip Nr. 1e)

6. Konzentrieren Sie sich Aufgaben

Entwerfen Sie Anweisungen als echte Aufgaben. Die Nutzer ziehen es vor, Ziele und Aktivitäten zu verfolgen, die als ‚real‘ anerkannt sind. Das könnte zum Beispiel sein: Wie kann ich mein Telefon individuell anpassen oder Aufgaben in Textverarbeitungsprogrammen wie Wie kann ich ein Dokument drucken oder speichern. (Minimalismus-Prinzip Nr. 2a)

7. Achten Sie besonders auf die Überschriften

Die Struktur des Handbuchs sollte die Struktur der Aufgabe widerspiegeln (Minimalismusprinzip Nr. 2b). Die Überschriften sollten deutlich machen, welche Informationen auf der jeweiligen Seite zu finden sind. Wenn der Benutzer die Überschrift liest, sollte er wissen, warum er sich die Zeit nimmt, sie zu lesen. Arbeiten Sie themenbezogen. Jedes Kapitel oder jeder Abschnitt sollte nur eine Frage beantworten.

Die Verwendung von Überschriften wie Ihre Arbeit speichern und Ihr Dokument drucken ist besser als eine Überschrift wie Tipps zur Verwendung von Microsoft Word. Ähnlich ist die Überschrift Überprüfen Sie die Zeit auf der ganzen Welt besser als Weltzeitansicht. Versuchen Sie immer, auch in den Überschriften auf das Thema zu verweisen. Sehen Sie sich dazu das folgende Beispiel an.

8. Verringern Sie das Risiko von Fehlern

Sorgen Sie dafür, dass die Wahrscheinlichkeit, Fehler zu machen, so gering wie möglich ist (Minimalismusprinzip Nr. 3a). Benutzer machen viele Fehler und verbringen oft 25-50% ihrer Zeit damit, ihre Fehler zu beheben. Der beste Weg, Fehler zu vermeiden, ist, die Software selbst durch und durch zu testen. Denken Sie außerdem daran, einen Trainingsmodus einzustellen, in dem bestimmte Funktionen während der Trainingszeit nicht genutzt werden können. Das Handbuch kann Grundregeln für gutes Schreiben anwenden, wie zum Beispiel:

• Geben Sie sichere Aktivitäten
• Verwenden Sie kurze und einfache Sätze
• Verwenden Sie aktiven und starken Verben
• Geben Sie Signal-Aktion informativ
• Minimieren Sie Jargon (siehe Punkt 15 für eine Nuance in diesem Punkt)
• Geben Sie Hinweise

9. Führen Sie Benutzertests durch

Der Designer sollte sich die Zeit nehmen, das Software-Handbuch mit Benutzern zu testen. Auf dieser Grundlage kann das Handbuch verbessert werden und/oder es können Informationen bereitgestellt werden. Geben Sie Informationen, wenn eine auszuführende Aktion im Widerspruch zu den realen Erfahrungen des Benutzers steht oder wenn die Korrektur der Aktion schwierig ist. (Minimalismus-Prinzip Nr. 3b)

10. Beheben Sie Fehler

Verwenden Sie ein Schritt-für-Schritt-Modell zur Lösung von Problemen/Fehlern. Die Schritte in diesem Modell sind:

• Fehlersuche;
• Der Fehler ermitteln;
• Der Fehler beheben.

Erkennen und Wiederherstellen werden immer benötigt. Eine Reparatur ist nicht immer notwendig, um den Fehler tatsächlich zu beheben. Informationen über Fehler sind oft wertvolle konzeptionelle Informationen. (Minimalismus-Prinzip Nr. 3c).

11. Seien Sie kurz und bündig

Die Benutzer gehen nicht systematisch durch ein Handbuch. Normalerweise lesen sie, um etwas zu tun, aber manchmal auch, um zu studieren oder gezielt Informationen nachzuschlagen. Durch kurz und bündig zu sein und nicht alle Informationen zu geben, werden alle Lesestrategien unterstützt. Kurze Sätze, Aufgaben, Themen, Kapitel usw. vermitteln dem Benutzer den Eindruck, dass es nicht viel Mühe kostet, zum gewünschten Ergebnis zu gelangen. Dadurch, dass nicht alle Informationen angegeben werden, wird der Benutzer ermutigt, selbst zu recherchieren und zu denken. Lassen Sie auch alle Informationen weg, die den Benutzer ablenken könnten. Tipp von Manualise: Geben Sie an, wie lange es dauert, eine Aufgabe zu erledigen. Als Faustregel gilt, dass dies ohnehin nicht länger als 20 Minuten dauern sollte. (Minimalismus-Prinzip Nr. 4a)

12. Schließen Sie ein Kapitel

Ein geschlossenes Kapitel oder ein modulares Kapitel sorgt dafür, dass der Benutzer nur die Kapitel konsultieren muss, an denen er interessiert ist. Eine vollständige Modularität ist jedoch nicht immer möglich. (Minimalismus-Prinzip Nr. 4b)

13. Wählen Sie das richtige Präsentationsformat

Achten Sie auf die Präsentation. Verhindern Sie, dass ein Handbuch zu einem Telefonbuch wird. Erklären Sie den Benutzern die Benutzeroberfläche (ähnlich wie bei einem Schnellstart). Verwenden Sie ausreichend Leerraum am Rand, zwischen den Zeilen und um Bilder herum. Dadurch werden die Leseleistung und die Verständlichkeit eines Textes verbessert. Achten Sie auf die Schriftart. Wählen Sie eine serifenlose Schriftart für die Online-Veröffentlichung und eine Serifenschrift für die Veröffentlichung auf Papier.

14. Stellen Sie konsistente Informationen sicher

Stellen Sie sicher, dass das Inhaltsverzeichnis und die Produktoberfläche eine komplementäre Informationsarchitektur aufweisen. Das Handbuch strukturiert die Informationen thematisch, während die Benutzeroberfläche dies visuell tut. Wenn die thematische Struktur nicht mit der visuellen Struktur übereinstimmt, kann sie den Benutzer verwirren. Ein Beispiel dafür finden Sie im UX Magazine.

15. Vermeiden Sie Fachjargon (teilweise)

Vermeiden Sie Jargon, aber tun Sie dies auf eine nuancierte Weise. Es werden häufig einfache Sätzen verwendet und Jargon und Fachbegriffe werden vermieden. In der Regel enthält die Schnittstelle jedoch bereits Terminologie. Um konsistent zu bleiben, wird die verwendete Terminologie am besten in einem Glossar des Handbuchs erklärt.

16. Achten Sie auf die Reihenfolge der Vorgänge

Achten Sie auf die Reihenfolge der Aktionen. Ein Benutzer möchte, dass er in der Reihenfolge, in der er liest, handeln muss. Verwenden Sie z.B. „Gehe zu Datei und dann zum Drucken“ anstelle von „Drücken Sie im Menü Datei auf Drucken“.

17. Verwenden Sie Bausteine

Erwägen Sie die Verwendung von Bausteinen für verschiedene Formen von Informationen pro Thema. Sie können auch wählen, ob Sie die folgenden Blöcke mehr oder weniger standardmäßig verwenden möchten:

• Hinweise geben
• Erläuterung der Verwendung der Software/Bereitstellung der Aufgabe
• Erkennen und Beheben von Fehlern
• Bereitstellung von konzeptionellen Informationen

Bausteine sorgen für Wiedererkennung und Konsistenz

Verfahren zur Erstellung eines Software-Handbuchs

Unabhängig von der Form des Software-Handbuchs gehen wir bei der Erstellung des Handbuchs immer die folgenden Schritte durch: