Entwerfen eines Hilfesystems

Question

Ich implementiere ein Hilfesystem für eine Desktop-App (Win32) und suche nach einer Vorgehensweise zum Entwerfen.

Welche Struktur sollte ein Hilfesystem haben, was ist für den Benutzer tatsächlich hilfreich? z.B.Sollte das Hilfesystem eine große Liste von FAQs sein (die Hilfe von Office 2010 scheint so zu sein)?oder sollte es eine Funktionsliste sein, die dokumentiert und beschreibt, was alles funktioniert (Dies ist wahrscheinlich nur hilfreich, wenn der Benutzer nicht sicher ist, wie eine Funktion, die er bereits kennt, funktioniert)

Welche Kenntnisse sollte ich vom Endbenutzer erwarten?Es ist wahrscheinlich etwas erniedrigend, in die Hilfedatei zu schreiben, dass File -> Open Project das aktuelle Projekt schließt (falls vorhanden) und ein vorhandenes Projekt öffnet.

Was ich hier suche, sind einige Hinweise, eine Reihe von Funktionen, die ein gutes Hilfesystem haben sollte, und eine Methode, um die Themen so zu organisieren, dass Benutzer sie finden können.

Answer 1

"Offenes Projekt" kann auch ein guter Ort sein, um auf die Definition eines Projekts und andere allgemeinere Beschreibungen und Verfahren zum Öffnen von Projekten zu verweisen.

Im Allgemeinen wird auf die CHM-Hilfe entweder über die kontextsensitive Hilfe (die für den offenen Fall von Dateien-> typisch ist) und über das allgemeine Inhaltsverzeichnis, die Volltextsuche und die Indizes zugegriffen. Die neuesten Apps scheinen nur eine Hilfeseite pro Container zu erstellen (ein Dialog- oder Pullodwn-Menü), auf der alle Elemente auf diesem Bildschirm aufgelistet sind (z. B. durch einen kommentierten Screenshot) und kein Lemma für jedes Element (Kontrollkästchen, Menüeintrag) in die GUI. Weniger Unordnung und Navigation, und viele Punkte benötigen nur eine relativ kurze Beschreibung

Neben der kontextsensitiven Hilfe kann die Hilfe auch über das Hilfesystem durchsucht werden.

Ein CHM ähnelt einem E-Book mit einem Inhaltsverzeichnis (TOC), einem Index und optionaler Unterstützung für die Volltextsuche.

Mit der Index- und Volltextsuche kann der Benutzer nach Inhalten suchen. Der Hauptunterschied besteht darin, dass der Index besser unter Ihrer Kontrolle steht und die Volltextsuche bei Aktivierung weitgehend automatisch erfolgt.

Das Inhaltsverzeichnis ist eine Baumansicht von Knoten, die sich wie das Inhaltsverzeichnis in einem Buch verhalten und die allgemeine Struktur des "E-Books" festlegen sollten. FAQs sind normalerweise ein Anhang in diesem Inhaltsverzeichnis.

Außerdem gibt es eine Standardeintragsseite, die der Homepage einer Website ähnelt. Es sollte Benutzer zu den am häufigsten gesuchten Themen navigieren.

Seien Sie vorsichtig, wenn Sie mit Microsoft-Produkten vergleichen. Sie verwenden manchmal Systeme, die für Endbenutzer / Entwickler noch nicht verfügbar sind.

Gute Hilfe verwendet all diese Elemente.

Answer 2

Es gibt im Allgemeinen zwei Arten der Hilfe: referenzbasiert (d. h. was bedeutet dieses Kontrollkästchen?) und aufgabenbasiert (wie erreiche ich XYZ?).

Am besten erstellen Sie zuerst ein aufgabenbasiertes Tutorial, das bei Bedarf durch eine FAQ gesichert wird.