it-swarm.com.de

Best / Standard Practices zum Erstellen und Erstellen von Hilfedateien für Endbenutzer

Kennt jemand Best- oder Standardmethoden zum Erstellen von Hilfedateien/Handbüchern für Software für den Endbenutzer?

Dies ist eine Software mit vielen Funktionen und Optionen, bei denen der Benutzer sehen muss, wie er diese Funktionen nutzen und auf sie zugreifen kann, um sie zu implementieren.

Jede Hilfe oder Anleitung dabei wäre dankbar.

8
Karin

Abhängig von der Komplexität Ihrer Software und Ihrer Benutzergruppe kann es erforderlich sein, auf verschiedene Weise Hilfe anzubieten.

  1. Zunächst müssen Sie sicherstellen, dass Ihre Workflows intuitiv sind. Mehr Arbeit wird dazu führen, dass weniger Menschen Hilfe benötigen und die Benutzer zufriedener sind.
  2. Inline-Hilfe neben Formularen, in denen Personen möglicherweise ausgelöst werden.
  3. Ein spezieller Hilfeabschnitt mit Tutorials und/oder einem Glossar. Sie können auf den Anwendungsseiten auch Links zu entsprechenden Tutorials anbieten.
  4. Wenn Ihre Benutzergemeinschaft groß und aktiv ist, können Sie ein Forum verwenden, in dem sie sich gegenseitig helfen können.

Wie die Hilfe präsentiert wird, hängt vom Standort ab. Die Inline-Hilfe sollte kurz und bündig sein, während die Tutorial-Abschnitte ausführlicher sein sollten.

Videos sind sehr hilfreich, aber versuchen Sie, sie kurz zu halten und sich darauf zu beschränken, eine bestimmte Aktion auszuführen oder ein bestimmtes Konzept zu lernen.

Einige Leute drucken gerne Anweisungen aus, stellen Sie also sicher, dass Sie auch Text haben.

5
bendur

Videos. Ja, eine gründliche und durchsuchbare textbasierte Dokumentation ist ebenfalls wichtig, aber für komplizierte Software sind Videos sehr, sehr nützlich. In einigen Fällen können Sie dieselben Videos verwenden, um Ihr Produkt auf Ihrer Website, auf YouTube, Facebook usw. zu vermarkten.

Um diese Videos zu erstellen, würde ich Screenflow empfehlen, wenn Sie auf einem Mac arbeiten: http://www.telestream.net/screen-flow/overview.htm

Screencast-o-matic ist auch ein anständiges Programm, das universell (und kostenlos!) Ist: http://www.screencast-o-matic.com/

Eine der häufigsten (und meiner Meinung nach besten) Möglichkeiten, Hilfe zu implementieren, ist ein Fragezeichen in der oberen Ecke jedes Bildschirms. Wenn Sie darauf klicken, wird eine kontextsensitive Dokumentation angezeigt (Hilfeinformationen für den angezeigten Bildschirm), links jedoch auch eine Liste anderer verwandter Themen. Setzen Sie eine Suchleiste oben in die Liste, und Sie können loslegen.

Wie Ben vorgeschlagen hat, ist Inline-Hilfe auch gut. Verwenden Sie es jedoch sparsam, da sonst die Benutzeroberfläche unübersichtlich wird. Wenn Sie es überbeanspruchen, ignorieren Benutzer es in der Regel. Eine gute Verwendung für die Inline-Hilfe wäre eine Feldbezeichnung, die möglicherweise einer zusätzlichen Erläuterung bedarf.

3
Baa