it-swarm.com.de

Wie soll ich ein kleines Hilfesystem für eine Windows-Anwendung entwerfen?

Kontext

Ich habe eine einfache Geschäftsanwendung geschrieben, die aus Informationen in einer Datenbank einen Bericht generiert. Die einzige erforderliche Benutzereingabe sind zwei Dateipfade - einer zu einer Liste von Elementen, über die berichtet werden soll, und ein anderer zum Schreiben des Berichts - und ein Schieberegler, der angibt, wie weit die Zeit zurückliegt, um nachzuschauen.

Die Pfade werden in Textfeldern angezeigt, die Sie bearbeiten/einfügen oder mit einem Browser im Dateimenü ändern können.

Der schwierigste Teil ist die Eingabedatei. Es handelt sich um eine Nur-Text-Datei mit einer bestimmten Trennzeichenanforderung. Wenn ein Benutzer auch nur ein wenig über Computerkenntnisse verfügt, ist dies wahrscheinlich der Teil, der die meiste Hilfe benötigt.

Die Frage

Wie soll ich diese kleine Menge an Informationen auf einem Hilfeformular organisieren? Ich habe nicht genügend verwandte Daten, um den typischen Windows-Hilfebaum zu rechtfertigen. Eine scrollbare Liste wäre etwas lang und schwer zu navigieren. Registerkarten scheinen für diese Verwendung seltsam zu sein, und ich bin mir nicht wirklich bewusst, wie ich sie auf andere Weise aufteilen kann Daten.

Haben Sie Vorschläge, wie Sie diese Menge an lose verbundenen Informationen präsentieren können? Ich habe auch eine ausführlichere externe Hilfe erstellt, aber es muss auch ein internes Hilfesystem geben.


Edit: Es scheint mir an Klarheit zu mangeln. Ich suche nach einer Möglichkeit, eine mittlere Menge an Hilfeinformationen so zu gestalten, dass sie am besten verwendet werden können. Eine Baumstruktur ist nicht geeignet, da zwischen den Themen keine eindeutigen Eltern-Kind-Beziehungen bestehen. Die einzigen anderen Layouts, an die ich denken kann, sind Registerkarten und eine Liste. Keines davon scheint mir richtig zu sein, daher suche ich eine andere Meinung dazu, wie diese Informationen präsentiert werden können.

2
William Grobman

Nun, mein Praktikum ist vorbei und die endgültige Version veröffentlicht! Trotz meiner anfänglichen Bedenken in der Frage besteht die beste Möglichkeit, diese Informationen anzuzeigen, darin, eine Liste auf der linken Seite mit einem scrollbaren, variablen Textbereich auf der rechten Seite zu verwenden, der auf der Auswahl ihrer Liste basiert. Dies entspricht am ehesten der Windows-Konvention, einen Baum an der Stelle der Liste zu verwenden, ist jedoch in diesem Fall besser, da die Informationen in einer nicht hierarchischen Form vorliegen.

Ein typischer Benutzer wird wahrscheinlich nicht einmal den subtilen Unterschied bemerken, der dem Prinzip des geringsten Erstaunens entspricht.

All dies wurde in ein modales Fenster gestellt, das eine Schaltfläche zum Schließen für Benutzer enthielt, die das X oben nicht finden konnten.

0
William Grobman

Enthält Ihre Klartextdatei Kommentare? (Das heißt, kann es Zeilen enthalten, die von Ihrer Software nicht gelesen werden?) Wenn dies der Fall ist, können Benutzer direkt in einer Beispiel- oder Starterdatendatei, in der das Format erläutert und angezeigt wird, loslegen. Wenn sie Ihre Anwendung zum ersten Mal verwenden, kopieren und bearbeiten sie diese Beispieldatei. Danach werden sie wahrscheinlich ihre eigenen früheren Dateien kopieren (oder das Format verinnerlicht haben, je nachdem wie komplex es ist).

Bearbeiten basierend auf Fragenbearbeitung: Zum Bereitstellen der Hilfeseite (die auf das Dokument in der Starterdatei verweisen oder dieses duplizieren kann) können Sie für eine mittlere Informationsmenge eine Spalte mit "Abschnitts" -Links auf einer einzelnen Seite in Betracht ziehen, z. nsere FAQ .

3
Monica Cellio

In dem von Ihnen beschriebenen Fall würde ich eine HTML-Datei "Readme" mit den Hilfeinformationen hinzufügen und eine Hilfeschaltfläche auf dem Formular bereitstellen, mit der diese Datei im Standardbrowser des Benutzers geöffnet wird.

Die Hilfedatei kann eine Beispiel-Eingabedatei mit Kommentaren und Erläuterungen zum zu verwendenden Format enthalten, wie in ihrer Antwort von @Monica vorgeschlagen.

Wenn Sie nicht mehr als die Exe verteilen möchten, kann die HTML-Datei als Ressource in die Exe aufgenommen und extrahiert werden, wenn beim ersten Klicken auf die Hilfeschaltfläche geklickt wird oder wenn die HTML-Datei nicht am erwarteten Speicherort gefunden wird. (Und machen Sie den erwarteten Speicherort nicht zum selben Ordner wie den, in dem sich die Exe befindet, wenn dieser unter Windows unter UAC-Kontrolle steht.).

0
Marjan Venema