Laden...

Ideen für neues Online Handbuch

Erstellt von BerndFfm vor 12 Jahren Letzter Beitrag vor 8 Jahren 5.117 Views
BerndFfm Themenstarter:in
3.825 Beiträge seit 2006
vor 12 Jahren
Ideen für neues Online Handbuch

Hallo Leute,

das Benutzer-Handbuch für meine Software möchte ich gerne überarbeiten, sowohl inhaltlich als auch von der Erscheinung.

Bisher verwende ich HTML-Help und erstelle eine CHM-Datei. Inzwischen gefällt mir das aber nicht mehr.

Wer hat eine Idee für ein Online Handbuch ?

Es sollte moderner aussehen als die CHM-Hilfe, vielleicht ähnlich wie ein Buch.
Benutzt wird es von Benutzern die sehr wenig Ahnung haben, also super einfache intuitive Bedienung muss sein.

Ich benutze in der Hilfe :

  • Inhaltsverzeichnis
  • Index (Stichwortverzeichnis)
  • Überschriften
  • Verweise
  • Grafiken (Bildschirm-PrintScreens)
  • Tabellen

Kontextsensitive Hilfe soll natürlich funktionieren : Bei F1 (Hilfe) soll man an der Stelle im Handbuch landen die den aktuellen Kontext beschreibt.

Ausdruck der Hilfetexte ist nicht so wichtig.

PDF ist mir zu träge und zu langsam.

Die neueren Hilfesysteme Microsoft Help 2.x und 3.0 (Microsoft Help Viewer 1.0) gefallen mir auch nicht viel besser. Hier ein guter Vergleich zwischen WinHelp, HTML Help 1.x und MS Help 2.x : http://www.codeproject.com/KB/dotnet/helpexplorer.aspx

Umblättereffekt wäre ein schöner Gimmick, muss natürlich nicht sein : http://www.turnpages.de/

Mein jetziges Handbuch als Plain HTML : http://sevenc.quasarshop.de/handbuch/

Touch-Bedienung wäre angenehm, muss aber auch nicht sein.

Ob fertige Help-Viewer oder Ideen / Vorlagen für einen selbstgebauten, ist beides willkommen 😉

Grüße Bernd

Workshop : Datenbanken mit ADO.NET
Xamarin Mobile App : Finderwille Einsatz App
Unternehmenssoftware : Quasar-3

49.485 Beiträge seit 2005
vor 12 Jahren

Hallo BerndFfm,

Benutzt wird es von Benutzern die sehr wenig Ahnung haben, also super einfache intuitive Bedienung muss sein.

ist die Bedienung von Windows und von Windows Programmen wirklich intuitiv? Vielleicht nicht so sehr, wie man denkt. Es ist wohl mehr die Gewohnheit als die Intuition, die die Benutzung einfach macht. Insofern hat es also durchaus seinen Wert, die gängigen Hilfesystem einzusetzen.

Dabei bietet es sich natürlich an, eines der neueren zu nehmen, also z.B. besser MS Help 2.x als WinHelp.

Inzwischen gefällt mir das aber nicht mehr.

Aus deiner Beschreibung ist mir nicht ganz klar geworden, was dir nicht gefällt. Wenn ich mir dein "Plain HTML"-Handbuch anschaue, dann passt das doch sehr gut zu dem, was die Standard-MS-Hilfesysteme können und bieten. Kontextsensitive Hilfe ist damit auch kein Problem. Vielleicht überzeugt dich das, diesen Systemen eine Chance zu geben. Wenn nicht, schreibt mal bitte genau, warum nicht.

herbivore

BerndFfm Themenstarter:in
3.825 Beiträge seit 2006
vor 12 Jahren

Hallo herbivore,

ist die Bedienung von Windows und von Windows Programmen wirklich intuitiv?

nein, finde ich nicht.

Auf den Kreis unten links klicken um den Rechner herunterzufahren oder auf die Alt-Taste zu drücken um zu sehen welche Tastatur-Hotkeys es gibt, das finde ich nicht she intuitiv.

Es ist wohl mehr die Gewohnheit als die Intuition, die die Benutzung einfach macht.

Ja, finde ich auch, frei nach dem Motto "man gewöhnt sich an alles". Mein neues Online Handbuch soll aber auch für Leute bedienbar sein, die den Umgang mit Windows nicht gewohnt sind.

Das neueste Hilfesystem vom MS, MS Help 3.0 aka MS Help Viewer 1.1 wäre eine Möglichkeit. Einfach mal F1 im Visual Studio 2010 drücken, dann sieht man den Help Viewer.

Leider muss man hier seine Hilfe im System registrieren, was mir schon mal nicht passt. Das Online Handbuch soll von CD-ROM ohne Installation von Komponenten aufrufbar sein.

Was mir an der aktuellen Hilfe nicht gefällt ?

Die Hilfe sollte moderner aussehen (Liegt natürlich auch an meinem HTML-Code). Vielleicht eher einem herkömmlichen Buch angelehnt.

Im Anhang ein PrintScreen des jetziges Online Handbuches auf CHM-Basis.

Grüße Bernd

Workshop : Datenbanken mit ADO.NET
Xamarin Mobile App : Finderwille Einsatz App
Unternehmenssoftware : Quasar-3

T
25 Beiträge seit 2011
vor 12 Jahren

Hallo Bernd,

Was mir an der aktuellen Hilfe nicht gefällt ?

Die Hilfe sollte moderner aussehen (Liegt natürlich auch an meinem HTML-Code). Vielleicht eher einem herkömmlichen Buch angelehnt.

Persönlich finde ich die Hilfe im HTML-Format sehr gut. Es bietet die nötigen Informationen und ist schlicht gehalten. Bei "Moderne Layouts" verliert man meist die eigentliche Bedeutung einer Hilfe aus den Augen. Hauptsache es sieht gut aus. Nach diesem Motto wird viel entwickelt. Man sieht auf dem Markt, was dabei raus kommt.
Zudem finde ich ein Layout eher hinderlich. Optische Elemente verwischen den Inhalt, was letztendlich das Suchen nach Informationen erschwert. Zudem muss eine Arbeitssoftware keinen Schönheitspreis gewinnen.

Was ich persönlich von Matlab aus kenne und sehr schätze ist die F1-Taste. Wenn man eine geziehlte Hilfe möchte, dann könnte man sich an der Position der Maus oder des Coursers orientieren und an dieser Stelle einen kleinen Dialog mit der nötigen Hilfe aufmachen (z.B. im HTML-Format). Wenn die Inhalte der Dialoge nicht zu groß und dennoch die gewünschten Informationen enthalten ist dies eine gute Möglichkeit den Benutzer zu unterstützen.

MfG, Thomas

BerndFfm Themenstarter:in
3.825 Beiträge seit 2006
vor 12 Jahren

Ein moderneres Layout sollte natürlich in Bedienung und Funktion einfach gehalten sein. Ich finde schlichter oft besser.

Die F1-Taste geht in meinem Programm überall. Man öffnet damit das Online-Handbuch und steht an der Stelle im Text die das aktuelle Feld, das aktuelle Menü oder den aktuellen Dialog beschreibt.

So Mini-Hilfen, die nur das aktuelle Feld beschreiben, gefallen mir nicht. Wie soll man dann die Hilfe aufrufen für Felder, die man nicht betreten kann ?

Grüße Bernd

Workshop : Datenbanken mit ADO.NET
Xamarin Mobile App : Finderwille Einsatz App
Unternehmenssoftware : Quasar-3

BerndFfm Themenstarter:in
3.825 Beiträge seit 2006
vor 12 Jahren

In VS 2011 kommt der Help Viewer 2.0, der wird dann auch im Windows 8 benutzt :

Announcing Microsoft Help Viewer 2.0 Developer Preview

MS Help Viewer 2.0

Ich habe es immer noch nicht hinbekommen den Helpviewer 1.0 von CD-ROM zu starten. Wenn das nicht geht kann ich den leider nicht nehmen.

Folgendes Szenario :

Interessent bekommt CD-ROM mit Testversion. Will sich nur das Handbuch angucken, das muss mit Klick auf ein Button geöffnet werden. Wenn das nicht klappt oder man erst 100 Pakete installieren muss dann wandert die CD-ROM gleich in den Müll.

Grüße Bernd

Workshop : Datenbanken mit ADO.NET
Xamarin Mobile App : Finderwille Einsatz App
Unternehmenssoftware : Quasar-3

5.657 Beiträge seit 2006
vor 12 Jahren

Hi Bernd,

also der neue Help Viewer sieht ja sehr vielversprechend aus, aber für mich sieht das so aus, als wäre das ein neues Feature von Windows 8. Benutzer von Vista und Windows 7 müssen sicherlich etwas installieren.

Was spricht eigentlich gegen eine HTML-Seite als zentrale Hilfequelle? Heutzutage hat doch jeder eine Internetverbindung und man muß sich nicht CHMs oder PDFs rumärgern. Kontext-sensitive Hilfe ist auch möglich und selbst einen eigenen HelpViewer kann man sehr einfach mit dem WebBrowserControl erstellen. Der größte Vorteil wäre aber: Es sieht gut aus, und du kannst es jederzeit für alle Benutzer anpassen oder Fehler berichtigen. Außerdem hast du gleich eine Statistik, wie deine Benutzer die Hilfe verwenden.

Christian

Weeks of programming can save you hours of planning

49.485 Beiträge seit 2005
vor 12 Jahren

Hallo MrSparkle,

den Vorteil von Online-Hilfe, dass etwaiger Fehler zentral korrigiert werden können und die Hilfe somit immer aktuell ist, sehe ich wohl, aber ansonsten bin ich überhaupt kein Fan davon.

Mal angesehen davon, dass gerade im industriellen Umfeld, aber nicht nur da, aus Sicherheitsgründen sicher weit mehr Arbeitsplätze ohne Internetverbindung existieren, als man gemeinhin annimmt. Und gerade bei größeren Firmen gibt es vermutlich kaum noch Internetzugänge ohne Filtersysteme. Wenn eine Online-Hilfe dann z.B. auf Facebook oder auf einem anderen Server liegt, der als "böse" eingestuft wird, oder die eingebundenen Videos auf z.B. Youtube abgelegt werden, verhindert der Filter einen Zugriff. Ob die Administration bereit oder in der Lage ist, die Filterregeln anzupassen, steht in den Sternen.

Auch wenn der Hersteller pleite geht und den Server abschaltet, steht man ohne Hilfe da. Und schon vorher besteht die Gefahr, dass der Hersteller nur die Hilfe für die jeweils aktuellste Programmversion anbietet, so dass die Hilfe nicht passt, wenn man eine ältere Version einsetzt.

Auch fehlen einer "plain-HTML"-Online-Hilfe oft wichtige Funktionen, die für eine Hilfe für einen Help-Viewer selbstverständlich sind: z.B. Volltextsuche, Index und manchmal sogar ein Inhaltsverzeichnis. Und obwohl dies zu verhindert natürlich in Macht des Herstellers liegt, ist es in der Praxis eben doch oft so, wie ichs beschrieben habe. Wogegen z.B. eine Volltextsuche bei alle aktuellen und gängigen Help-Viewern automatisch zur Verfügung steht und somit weder vergessen noch aus Aufwandsgründen weggelassen werden kann.

Ob die Auswertung der Nutzungsgewohnheiten, zum Vorteil der Nutzer geschieht oder gegen ihre Interessen, hängt natürlich den der Fairness des Herstellers ab. Die Gefahr des Missbrauchs ist jedenfalls nicht ausgeschlossen.

Egal, ob nun ein einzelnes Argument nicht überzeugt, in der Summe überwiegen die Nachteile für den Nutzer gegenüber den wenigen Vorteilen.

Ich habe nichts dagegen, wenn es zusätzlich eine Online-Hilfe gibt, sofern eine lokale Version zur Verfügung steht und diese standardmäßig genutzt wird.

herbivore

BerndFfm Themenstarter:in
3.825 Beiträge seit 2006
vor 8 Jahren

Nach vielen Forschungen im Internet und im realen Leben habe ich nun folgendes gemacht :

Ein eigenes Online Handbuch programmiert, das kann folgendes :

  • Resize und Vollbild
  • Kontext-sensitiv
  • Kann wie ein E-Book oder ein echtes Buch Kapitel für Kapitel gelesen werden
  • Inhaltsverzeichnis mit 3 Ebenen
  • Stichwortverzeichnis
  • Suche
  • Verweise im Text auf andere Textstellen möglich
  • Bildschirm-Printscreens können einfach eingebunden werden

Das Design ist praktikabel konservativ wie meine Software halt so ist.

Der Test selbst wird mit einer Textverarbeitung erstellt wie Word, Wordpad oder TextControl.

Die Texte werden zur Zeit Online geladen, eine lokale Version die von CD oder Festplatte läuft ist möglich.

Könnte man sowas einzeln verkaufen ? Gefunden habe ich sowas nicht.

Grüße Bernd

Workshop : Datenbanken mit ADO.NET
Xamarin Mobile App : Finderwille Einsatz App
Unternehmenssoftware : Quasar-3

16.807 Beiträge seit 2008
vor 8 Jahren

Wenn es nur um das Verkaufen geht: ein guter Verkäufer kann alles verkaufen 😃

BerndFfm Themenstarter:in
3.825 Beiträge seit 2006
vor 8 Jahren

Ich bin kein guter Verkäufer.

Ich kann nur die Sachen verkaufen von denen ich selber zu 100% überzeugt bin.

Die Killer-Funktion wäre es den Handbuchtext auf Knopfdruck zu erzeugen 😉

Grüße Bernd

Workshop : Datenbanken mit ADO.NET
Xamarin Mobile App : Finderwille Einsatz App
Unternehmenssoftware : Quasar-3

49.485 Beiträge seit 2005
vor 8 Jahren

Hallo BerndFfm,

grundsätzlich finde ich sowas cool. Ich persönlich würde jedoch nur ein weit verbreitetes Produkt einsetzen (oder was, was ich selber geschrieben hätte. 😃 Sonst wäre mir zu unsicher, dass man aufs falsche Pferd gesetzt hat und alles (mühsam) auf ein anderes Produkt umstellen muss, wenn deins nicht mehr gefegt oder weiterentwickelt wird.

Drei Überschriftenebenen halte ich für zu wenig. Wenn man es überhaupt beschränken muss, dann auf sechs, wie bei HTML. Das bedeutet nicht, dass man das ausschöpfen sollte. Nur sollte man die Beschränkung so hoch wählen, dass man nie dran stößt. Und vier oder vielleicht auch fünf Ebenen können in komplexen Dokumenten schon vorkommen.

Wie kommen denn die Steuerbefehle in den Text? Also wie sagte ich z.B., dass etwas eine Überschrift oder ein Link oder ein Stichwort ist?

Wie hast du die Anzeige realisiert? Per WebBrowser-Control?

BTW: Ich bin ein Freund von Offline-Handbüchern und mag Online-Handbücher nicht. Wenn man eine Software einsetzt, dann gehört in meinen Augen das Handbuch genau für die jeweilige Version dazu. Bei einem Online-Handbuch halte ich die Gefahr zu groß, dass es seiner Zeit voraus ist, also sich auf die aktuelle Version bezieht, statt auf die eingesetzte. Oder der Hersteller bzw. Betreiber die Handbücher alter Versionen gar nicht mehr bereithält. Wenn man die Software aktualisiert, dann kann ja auch das Offline-Handbuch aktualisiert werden. Und wenn nicht, dann nicht. So oder so passt das Offline-Handbuch immer garantiert zur eingesetzten Version und ist immer verfügbar.

herbivore

BerndFfm Themenstarter:in
3.825 Beiträge seit 2006
vor 8 Jahren

Hallo herbivore,

die Anzahl der Ebenen im Inhaltsverzeichnis sind eigentlich unbegrenzt. Man kann das Inhaltsverzeichnis auch vergrößern (SplitContainer).

Die Markierungen im Text sind wie folgt :

[i1] = Überschrift Kapitel 1. Ebene
[i2] = Überschrift Kapitel 2. Ebene
[s:..] = Stichwort
[m:...] = Hilfe zu Menü
[f:...] = Hilfe zu Feld
[b:...] = Bildschirm oder Grafik

Ja, Webbrowser-Control. Das klappt gut außer dem Zoom-Befehl, da wird die Schrift holprig.

Eine Offline-Lösung, die genau zu der eingesetzten Version passt, finde ich langfristig auch besser. Jetzt, wo ich erstmal noch viel Text schreiben muss lass ich es erstmal Online. Das Umschalten ist keine große Sache, eher die Verteilung bei Installation und Updates.

Grüße Bernd

Workshop : Datenbanken mit ADO.NET
Xamarin Mobile App : Finderwille Einsatz App
Unternehmenssoftware : Quasar-3

49.485 Beiträge seit 2005
vor 8 Jahren

Hallo BerndFfm,

warum benutzt du für die Steuerbefehle nicht irgendwas Bestehendes? HTML, XML oder BBCode oder von mir aus sogar SGML oder vielleicht noch einen passenderen Standard, den ich gerade übersehe, evtl. erweitert um eigene Tags.

Ich verstehe schon, dass du für Formatierungen wie Kursiv, Fett per WYSIWYG und nicht per Tag vornehmen können willst. Und das ist auch ok. Trotzdem könntest du dich ja bei den Tags, die nicht WYSIWYG gehen, eine bestehenden Auszeichnungssprache verwenden.

Andersherum ist die Frage, warum man z.B. für Überschriften u.ä. Tags verwenden muss. Wenn man für die Überschriften in Word die entsprechenden Formate verwendet (z.B. Überschrift1), dann wären die Überschriften ja auch eindeutig markiert/ausgezeichnet.

Genauso könnte man ein Format für Stichworte definieren. Dann muss man das Stichwort in Word nur markieren, das Format vergeben und fertig.

Versteh mich nicht falsch. Ich bin ein Fan von Auszeichnungssprachen. Und ich liebe es, wenn die Textformatierungen als Tags explizit sichtbar sind. Auf der anderen Seite gibt es Leute, die stehen voll auf WYSIWYG. Für die wäre es praktisch, wenn sie gar keine Tags verwenden müssten.

So wie du es jetzt hast, ist es - wenn ich es richtig verstanden habe - ein Mix zwischen Tags und WYSIWYG.

Gerade in Bezug auf die Frage, ob man sowas verkaufen könnte, sollte das Konzept durchgängig, schlüssig und praktikabel sein. Und sich an bestehendem orientieren.

Das alles natürlich nur als Anregung. Du entscheidest.

herbivore

BerndFfm Themenstarter:in
3.825 Beiträge seit 2006
vor 8 Jahren

Hallo Herbivore,

die Steuerkommandos hatte ich mir früher mal ausgedacht als es noch kein HTML gab.
Hätte ich mir vielleicht patentieren lassen soll 😉

Ich hatte überlegt sie zu ändern, aber wenn ich sie so lasse kann ich sie gut mit einem HTML- oder RTF-Editor bearbeiten. Also bleiben sie so.

Wenn ich HTML-Tags nehmen würde dann müsste ich zum Editieren einen Texteditor benutzen.

Mit Word arbeite ich nicht. Aber in TextControl könnte man auch Textmarkierungen definieren. Und sogar auch Sachen selber programmieren und einbauen.

WYSIWYG benutze ich zur Zeit beim Schreiben des Hilfetextes überhaupt nicht, wäre aber möglich.

Grüße Bernd

Workshop : Datenbanken mit ADO.NET
Xamarin Mobile App : Finderwille Einsatz App
Unternehmenssoftware : Quasar-3