Was ist der Deal mit helpfiles in diesen Tagen?

Question

Ich habe this question at SuperUser für die Benutzerperspektive hinzugefügt.

Also ich eine Anwendung in Delphi oder .NET erstellen, die auf einem Desktop-System ausgeführt wird. Einige nette GUI mit allen Arten von Funktionalität und netten Funktionen. Es funktioniert gut, Tests sagen mir, es ist fast fehlerfrei und ich bin dabei, es zu implementieren ...

warten! Es benötigt eine Hilfedatei, damit Benutzer kontextsensitive Hilfe von der Anwendung aufrufen können!

Oder nicht? Sind Helpfiles heutzutage wirklich eine Voraussetzung für Desktop-Anwendungen? Und müssen sie wirklich kontextsensitiv sein, indem sie die Hände des Benutzers halten, um ihnen zu sagen, dass sie ihren Geburtstag in diesem Feld mit der Aufschrift "Tag der Geburt" eintragen müssen? Oder werden Hilfedateien etwas altmodisch?

Das ist etwas worüber ich mich wundere und das ist ein bisschen subjektiv, also werde ich stattdessen etwas anderes fragen, an alle, die Desktop-Anwendungen entwickeln: Liefern Sie (noch) kontextsensitive Hilfedateien?

Ja, oder nein, bitte. Zögern Sie nicht, einige subjektive Texte hinzuzufügen, aber für mich ist es wichtig zu wissen, ob moderne Entwickler ihren GUI-Anwendungen noch kontextsensitive Hilfe hinzufügen.

(Btw, ich habe nicht auf den Kontext von PDF-Dateien verschoben, die als Handbuch ausgedruckt werden können. Es ist viel einfacher ist, zu halten.)

Answer 1

Ja, das tue ich.

Grund: Ich kann einfach nicht erwarten, dass der Benutzer weiß, wie das Programm funktioniert. Ok, zu beschreiben, was in ein Feld "Tag der Geburt" eingefügt werden muss, ist ein bisschen extrem, aber es gibt normalerweise komplexere Sachen in einem Softwaresystem. Ich musste erst heute eine Hilfedatei für unser Kostenrechnungssystem schreiben, in der beschrieben wird, wie das System zur Bestimmung des Preises, das für die Berechnung verwendet werden soll, funktioniert. Ich glaube nicht, dass ein Benutzer das System ohne diese Hilfedatei konfigurieren könnte.

Answer 2

Wir derzeit nicht, aber wir schreiben nicht viel von Windows-Apps. Die meisten sind webbasiert. Die meisten unserer Windows-Apps sind außerhalb einer Hilfedatei relativ klein und gut dokumentiert.

Auch haben wir die Endbenutzer schreiben die Dokumentation während des Entwicklungsprozesses, so dass die Dokumentation ist etwas, das sie verstehen werden.

Wenn ich jedoch eine große App für viele Benutzer (keine interne App) schreiben würde, würde ich eine kontextsensitive Hilfedatei hinzufügen. Ich habe es in der Vergangenheit für einige unserer größeren Apps getan, und in einer nicht-internen Situation ist es sehr hilfreich.

Eigentlich haben wir jetzt unsere Website so gestaltet, dass sie eine kontextsensitive Funktion "Hilfe benötigen" enthält, und die Funktion wurde gut aufgenommen. Wir integrieren es jetzt in alle unsere Web-Entwicklung, ob für unsere Unternehmenswebsite oder intern.

Answer 3

Ich habe nie kontextsensitive Hilfe in einer Anwendung zur Verfügung gestellt, noch habe ich gesehen, dass es in einer anderen Anwendung gut genug implementiert wurde, um es jemals selbst zu verwenden. Meiner Meinung nach übersteigt der Aufwand, um es gut zu machen, den Nutzen.

Bei der letzten Anwendung, an der ich beteiligt war, wo diese Entscheidung getroffen werden musste, verwendeten wir Tooltip-Ballons in der Anwendung, die einen Textballon zeigten, wenn der Benutzer über jedem Steuerelement schwebte. Wir haben auch ein konventionelles Handbuch zur Verfügung gestellt, das hauptsächlich aus Walkthroughs mit vielen Schritt-für-Schritt-Screenshots bestand.

Nach einer Weile hatten die Benutzer genug von den Luftballons und haben sie mit einer Checkbox ausgeschaltet, die wir zur Verfügung gestellt hatten, aber es schien den Anfängern zu helfen, damit anzufangen.

Answer 4

Ich gebe Ihnen eine persönliche Meinung, nicht durch andere Tatsache, dass mein persönlicher Geschmack unterstützt.

Das Schreiben von Hilfedateien war in der Vergangenheit nützlich, wo alles neu war und Online-Ressourcen knapp waren. Heute lernen die meisten Computerbenutzer durch direkte Erkundung. Kontextuelle Hilfe in Form von Tooltips ist großartig und stark erwünscht: Sie gibt Hinweise für dieses explorative Lernen.

Was ist mit Hilfe-Dokumentation mit vielen Links zu klicken? Nun, es ist anscheinend toll, aber sehr selten verwendet, denke ich. In den meisten Fällen kann der Benutzer Antworten mit einer richtigen Google-Suche erhalten. Darüber hinaus ist diese Art der Dokumentation teuer. Es kann nicht von einem Entwickler geschrieben werden. Sie müssen bestimmte Leute dafür einstellen oder zuweisen, mit technischem Schreiben und Klarheit als relevanten Fähigkeiten.

Wenn ich diese Entscheidung zu verwalten hätte, würde ich vollständige Dokumente nur für diejenigen Features zur Verfügung stellen, die sehr esoterisch und speziell (ich würde sagen einzigartig) für Ihre Anwendung. Ich würde in jedem Fall zu einem Online-Tutorial anstelle von kontextbezogenen Hilfedateien neigen. Dies hat den zusätzlichen Vorteil, Informationen darüber zu liefern, wie schwierig es ist, Ihre Anwendung zu verwenden und welche Hotspots am häufigsten angefordert werden (indem Sie die Treffer und Referrer-Suchanfragen für Ihre Online-Dokumente auswerten).

Answer 5

In einer aktuellen Anwendung haben wir keine kontextsensitive Hilfe bereitgestellt. Dies hatte technische Gründe und nicht alles andere (die Hilfedatei ist im Wesentlichen eine mehrsprachige Docbook-Datei, die theoretisch kontextsensitive Hilfe unterstützt, aber nicht gut funktionierte). Es hat eine Seite für jedes Fenster/Dialogfeld in der Anwendung, mit allen Steuerelementen erklärt. Jedes Steuerelement verfügt jedoch über einen relativ umfangreichen Tooltip, wodurch zusätzliche Hilfe meist nicht erforderlich ist. Jeder Dialog hat eine Hilfe-Schaltfläche, um die dialogspezifische Seite aufzurufen. In der Vergangenheit konnten Sie den Tooltip-Text in der Hilfedatei speichern, aber das scheint nicht mit neueren Hilfesystemen zu funktionieren. Und sie sind sowieso in Ressourcen gespeichert.

Aber dann ist es keine Anwendung für alle. Da das Netzwerksystem, das mit der Anwendung verwaltet werden kann, ein komplexes Thema ist, gibt es trotzdem eine spezielle Schulung für die Benutzer, und die Anwendung wurde so konzipiert, dass Sie die Anwendung kennen, wenn Sie das Netzwerksystem kennen. Mit anderen Worten, das Anwendungsmodell stimmt so gut mit dem Benutzermodell überein, dass umfassende Hilfefunktionen nicht benötigt werden. Dies sollte das Ziel jeder Anwendungsentwicklung sein.

Die meisten Informationen in den Hilfedateien zu den Steuerelementen sind nicht wirklich mehr als das, was bereits im Tooltip ist, da niemand mehr benötigt.

Office und Visual Studio lösten das Problem ziemlich ähnlich - das Drücken der Hilfe öffnet die Hilfeseite für den gesamten Dialog, nicht für die einzelne Steuerung.

Wenn Sie einen Teil eines Dialogs haben, der so kompliziert ist, dass er zusätzliche Erklärungen benötigt (und Sie ihn nicht umgestalten können, um es einfacher zu machen), können Sie die Erklärung direkt neben das Steuerelement setzen. Dies wird in vielen Anwendungen für spezielle Fälle verwendet, so dass der Arbeitsablauf nicht unterbrochen wird, weil der Benutzer z.B. wie ein bestimmter Text geschrieben werden muss.

Answer 6

Sprechen als ein Benutzer, kein Entwickler - ja, ich möchte eine kontextsensitive Hilfedatei.

Zum Beispiel - Ich werte zur Zeit 3rd Party Controls für die Aufnahme in ein neues Projekt. Die Steuerelemente mit guter kontextsensitiver Hilfe (z.Sie können eine Eigenschaft im Eigenschaftsfenster oder ein Schlüsselwort im Code auswählen und F1 drücken, um direkt zum Hilfethema zu gelangen) sind viel einfacher zu erlernen und zu benutzen.

Answer 7

Alle unsere Anwendungen haben kontextsensitive Hilfe in Form von Tooltips (ähnlich den Office 2007-Tipps) für alle kritischen Funktionen der Anwendung.

Obwohl wir die traditionelle, vollständige Hilfedatei nicht anbieten, haben wir definitiv eine Wissensbasis, die wir regelmäßig aktualisieren. Dies ist eine Sammlung aller Hilfe, die den Kunden per Telefon, E-Mail usw. zu allen Fragen zur Verfügung gestellt wird, richtig kategorisiert und leicht durchsuchbar. Dies endet schließlich als die beste Hilfe, die mehr oder weniger enthält, was die Kunden suchen, anstatt, was sie zunächst brauchen.

Während einige Kunden uns immer wieder kontaktieren, ohne einen Blick auf die Knowledge Base zu werfen, hilft es uns immer noch, das Rad immer wieder neu zu erfinden.

Answer 8

Mit Tooltips und einer allgemein erhöhten Computerfähigkeit bei Benutzern funktionieren einige Anwendungen problemlos ohne Hilfedateien. Einige Anwendungen benötigen jedoch Hilfedateien, sowohl für allgemeine Themeninformationen als auch für die Anwendungsnutzung. In einer Foto-App können Sie beispielsweise die JPEG-Komprimierung erklären und einige Beispiele in die Hilfedatei einfügen, auch wenn die Benutzeroperation offensichtlich ist.

Es scheint mir, dass Microsoft einen Beitrag zum Rückgang der kontextsensitiven Hilfe leistet, im Guten wie im Schlechten. Erstens sind die Hilfesysteme in Visual Studio, um es milde auszudrücken, ein Schmerz zu benutzen. Zweitens ist die Benutzerfreundlichkeit des Hilfesystems von Visual Studio deutlich gesunken. Ich werde die Rant weglassen, aber es genügt zu sagen, dass es viele mehr Klicks und Scrolls dauert, um relevante Informationen in der VS2008 Hilfe zu erhalten. Dies neigt dazu, einen niedrigeren Standard für Hilfesysteme in Anwendungen festzulegen.

Answer 9

Keine Hilfe? Das ist gut für Leute, die technisch geneigt sind und gerne mit neuer Software spielen. Aber wenn Ihre Software von Leuten benutzt wird, die nicht technisch versiert sind, ist Hilfe wichtig. Nehmen Sie ein Beispiel für Daten. Wenn Sie einen internationalen Markt haben, schreiben Sie besser, was das Programm braucht. Amerikaner verwenden ein MM/TT/JJJJ-Format, aber die meisten internationalen Benutzer verwenden DD/MM/YYYY; Sie müssen angeben, was das Programm benötigt.

Ich habe mit vielen Entwicklern gearbeitet, die absolut keine Ahnung von ihren Endbenutzern und ihrer Arbeitsweise hatten. Ein CTO, der auf seine neue Firma bestanden hat, sollte beispielsweise auf druckbare Dokumentation verzichten, ohne zu wissen, dass seine Kunden bei jeder Aktualisierung alle PDFs und die meisten Hilfethemen gedruckt haben. Sie müssen Ihren Endbenutzer und Ihren Markt kennen. Leider leben zu viele Entwickler in einer Blase, umgeben von anderen Entwicklern.

Sollten Entwickler Hilfe schreiben? Wahrscheinlich nicht. Wenn Sie nicht wirklich wie ein normaler Endbenutzer denken können, können Sie sich Notizen machen, aber ein technischer Redakteur kann die technischen Informationen auf das Niveau reduzieren, das der Endbenutzer benötigt.