it-swarm.com.de

Welche Art von Hilfesystem ist am besten?

In meiner Firma erstellen wir Windows-basierte Desktop-Anwendungen. In der Vergangenheit haben wir .chm-Dateien für unsere Hilfedokumentation erstellt und waren damit zufrieden. Wir hatten jetzt einige Probleme mit der Software, die wir zum Erstellen der .chm-Software verwenden, und müssten im Wesentlichen viel Geld investieren, um diese .chm-Erstellungssoftware weiterhin zu verwenden, was mich zu der Frage führt: Are. chm-Dateien sind wirklich der beste Weg, um Hilfedokumentation bereitzustellen?

Ich habe einige Nachforschungen angestellt, um PDFs mit allen Elementen in den .chm-Dateien zu erstellen, z. B. einem Inhaltsverzeichnis und Links, die zu anderen Abschnitten im Dokument springen. Online-Hilfe ist keine Option. Welche Lösung wir auch wählen hat , um ohne Internetverbindung zu funktionieren.

Also nochmal, welche Art von Hilfesystem ist am besten? Sind PDFs anstelle von .chm-Dateien akzeptabel? Gibt es eine andere bessere Alternative?

Update: Es sieht so aus, als müssten wir .chm aus einigen Gründen verwenden, hauptsächlich wegen der einfachen Aktualisierung und Verteilung (nur 1 Datei). Mein Läufer bis dahin wäre HTML-Hilfe gewesen, was im Wesentlichen sowieso eine .chm ist.

13
Matt Rockwell

Die Leute lesen nicht. Die beste Hilfe ist keine Hilfe. Dazu müssen Sie natürlich viel Zeit und Arbeit in die UX investieren.

Unter der Annahme, dass Sie Hilfe benötigen, würde ich vorschlagen, dass die beste kontextsensitive Hilfe ist, die mit den neuesten Hilfeinformationen auf Ihre Website verlinken kann. Sie würden die Hilfe als HTML veröffentlichen und sich so vor proprietären CHM-Produktionsworkflows schützen.

11
DA01

Wie bereits erwähnt, sollten Sie sich mit der Generierung von HTML-Dateien befassen, die Sie mit Ihrem Produkt ausliefern, um Hilfe zu erhalten. Eines unserer Produkte (das in einer Umgebung ohne Internetzugang verwendet wird) tut dies seit Jahren und viele Benutzer bevorzugen es gegenüber den PDFs, die wir auch versenden, da die Navigation einfacher ist, der Inhalt sich so anpasst, dass er in das Browserfenster und den Block passt Größe ist kleiner. Unsere HTML-Konfiguration unterstützt auch kontextsensitive Hilfe, die wir jedoch noch nicht implementiert haben.

A PDF ist eine schöne Präsentation der seitenbasierten Dokumentation, aber wenn der Benutzer horizontales Scrollen vermeiden möchte, um sie zu lesen, muss er ein gutes Stück davon zuweisen Bildschirmfläche. Abhängig von seiner Monitorgröße (n) und dem von Ihrer Anwendung benötigten Speicherplatz kann er die Hilfe möglicherweise nicht neben der Anwendung anzeigen. Dies ist ein Hindernis, wenn er das Dokument verwendet, um einen Schritt durchzugehen - Schritt für Schritt.

Wie in meinem ersten Absatz angedeutet, ist das Generieren mehrerer Formate nicht schwierig, wenn Sie über die richtigen Tools verfügen. Kein Grund, warum Sie nicht sowohl HTML als auch PDF generieren und versenden können, sodass der Benutzer die Option hat.

8
Monica Cellio

Für die automatische Erstellung technischer Dokumentationen können Sie XML-Veröffentlichungsformate wie Docbook oder DITA verwenden. Insbesondere kann DITA PDF, CHM, RTF und HTML generieren.

Ich habe den Serna Free Editor verwendet, der eine gute visuelle Bearbeitungsunterstützung (WYSIWYG) für DITA bietet, um die XML-Besonderheiten zu reduzieren.

Technische Dokumentation ist jedoch nicht die effektivste Art, mit Endbenutzern zu kommunizieren. Zunehmend werden interaktive Prototypen verwendet, um mit Benutzern zu kommunizieren. Schauen Sie sich zum Beispiel die Google+ Demo an. Die Ausarbeitung solcher Prototypen kann teuer sein. Wenn jedoch ein UXD-Prozess verwendet wird, können diese Prototypen in vielen Phasen des Prozesses verwendet werden. Sie können also die Mühe wert sein.

4
Pau Giner

PDF ist eine schlechte Option :

  • es ist seitenorientiert, was für das Lesen auf dem Bildschirm zum Kotzen ist. PDF lässt Sie zwischen unlesbar klein und viel scrollen wählen.
  • Die Suche ist im Vergleich zu allem anderen furchtbar langsam
  • Einige Leute reagieren stark negativ auf einige Produkte, die mit PDF verbunden sind. Stellen Sie sich einen Aggrobat-Hasser in Begleitung einer sehr strengen IT-Richtlinie vor
  • PDF ist ein Druckformat, kein Leseformat

Wenn es PDF sein muss

  • querformat für Seiten
  • Verwenden Sie einen Generator, der einen Index erstellt
  • Bündeln Sie einen anständigen PDF Reader mit Ihrer Anwendung (Installation optional, natürlich)

Wie helfen Sie dem Autor?

Ich würde mich für technische Redakteure entscheiden, die HTML direkt bearbeiten. Sharepoint Designer ist kostenlos und funktioniert "genau wie Word" (aktuelles Zitat). Sie benötigen einige Einstellungen und Regeln in Bezug auf Stile, Vernetzung usw., aber es hat funktioniert.

Ob Sie den HTML-Code in einem CHM bündeln, spielt eigentlich keine Rolle. Der Hauptvorteil von CHM gegenüber einfachem HTML ist die Index- und Volltextsuche. Es gibt einige HTML-Suchmaschinen auf Client-Websites, aber ich habe eine gefunden, die einfach zu bedienen ist

Inhalt über Format, schreibe für heutige Benutzer

Auch wenn ich PDF oben) verprügelt habe, würde ich immer noch behaupten, dass der Inhalt wichtiger ist als der endgültige Wrapper. Ein großartiges Handbuch in PDF schlägt ein mittelmäßiges das kann direkt ins Gehirn heruntergeladen werden.

Das Benutzerverhalten hat sich mit den Fortschritten der Benutzeroberfläche erheblich geändert

  • Benutzer erwarten, dass sie Ihr Handbuch nicht lesen müssen. Wenn Ihre Software das Lesen eines Handbuchs erfordert, ist Ihre Software zum Kotzen. (Es scheint, dass <1% der Benutzer von vorne bis hinten lesen und auf falsche Screenshots und kleinere Rechtschreibfehler hinweisen.)
  • Benutzer wenden sich an Ihr Handbuch, wenn sie nicht weiterkommen
  • Benutzer wenden sich der Suche zu und versuchen inkrementell verschiedene Suchbegriffe/Suchen.

Es macht nicht mehr viel Sinn, Dialoge und lange Listen von Menüelementen zu dokumentieren. Stellen Sie ein aufgabenorientiertes Handbuch, viele Anleitungen und Beispielszenarien bereit. Fragen beantworten. Beschreiben Sie keine Dialogelemente (sie sollten selbstbeschreibend sein), sondern wie sie mit anderen interagieren und das Ergebnis beeinflussen.

Nutzen Sie die interaktiven Funktionen von HTML. Sie können Videos, Audio, Links zu Ihrer Produktseite usw. einbetten.

3
peterchen

Eine wichtige Frage, die Sie beantworten müssen, ist, ob Sie eine separate Hilfe oder einen kontextsensitiven Hilfsmechanismus anbieten möchten. Eins, das andere oder beide beeinflussen wahrscheinlich Ihre Werkzeugwahl.

Unabhängig davon, was Sie von ihnen halten, verfügt Adobe im Allgemeinen über ziemlich gute Hilfsmechanismen in der Anwendung. Soweit ich sehen kann, handelt es sich um maßgeschneiderte Alternativen zu CHM, sie scheinen jedoch HTML-basiert zu sein. Ich habe nicht die neuesten Versionen ihrer Sachen, also bin ich mir nicht sicher, wie sie es jetzt machen.

Wie Roger sagt, gibt es Tools, mit denen Sie HTML-Hilfesysteme mit eingebautem Browser generieren können. Aber auch hier kann der Nutzen davon abhängen, wie kontextsensitiv Sie Ihre Hilfe benötigen.

2
Sam K

Je nach Anwendung kann mehr oder weniger Online-Hilfe äußerst nützlich sein. Einige Formen sind besser als andere. Einige sind einfacher herzustellen oder zu warten.

Oft ist ein Benutzerhandbuch erforderlich, das den Hauptaufwand für die Dokumentation steuert. Die Online-Hilfe kann dann als zweckentfremdete oder abgeleitete Form eines buchartigen Leitfadens angezeigt werden - auch wenn der Leitfaden nie gedruckt wird, sondern nur als PDF vorliegt.

Diese Bemühungen können in Ordnung oder mies sein. Es ist nicht großartig, einfach ein PDF] auf den Bildschirm zu legen. Sie müssen einige Arbeiten in die (Neu-) Organisation, Lesezeichen, Hyperlinks und Durchsuchbarkeit des Benutzerhandbuchs investieren, um es im Programm nützlich zu machen.

Sie müssen Ihr Lieferformat basierend auf Zielgruppe, Aufmerksamkeitsspanne und Bedarf an Drucksachen auswählen. Interne Geschäftsanwendungen erfordern Schulungskurse, die auch die Nachfrage nach einem Buch oder einem anderen Schulungsangebot steigern können.

Wenn Ihre Anwendung auskommt, ohne etwas zu erklären oder zusätzliche Hilfe für Benutzer zu zeigen, während sie sie verwenden, haben die Entwickler den Jackpot geknackt und wahrscheinlich ein Team von Autoren und technischen Kommunikatoren an ihrer Seite.

Das ist fast nie der Fall. Fast jede Software muss in der App einige Hilfethemen "Wie mache ich" und "Wie funktioniert dieses Tool?" Anzeigen. Heutzutage sind die einfachste Möglichkeit die CHM-Hilfe (kompiliert) und die HTML-basierte Hilfe, wobei die Interaktivität über Javascript bereitgestellt wird. Sie können ein HTML-Hilfesystem haben, das mit CHM identisch ist, indem Sie eine der teuren Hilfeentwicklungsumgebungen oder kostenlose Editoren verwenden. Ich hatte viel Erfolg mit einer Bibliothek, dem FAR Help Compiler, einer Art kombinierten CHM/Javascript-Workshop, der fast kostenlos ist.

Ich bin davon überzeugt, dass HTML5 der richtige Weg für jedes Online-Dokumentations-/Hilfesystem ist. Mit Javascript, CSS, SVG-Grafiken und vielen Bibliotheken können Sie die gesamte Interaktivität jeder Website bereitstellen und Animationen, Videos, Volltextsuche, KI, 3D und mehr einschließen.

Für all das gibt es keine perfekte Entwicklungsumgebung, da dafür Schreib- und Sprachwerkzeuge erforderlich sind, über die Code-Editoren allein nicht verfügen. Es gibt große Veröffentlichungspakete, die mehrere Ausgabeformate versprechen, aber es ist unmöglich, auch bei der Erstellung und Ausgabe von PDF, CHM, HTML perfekt zu sein.

Visual Studio wäre zusammen mit einer Content-Management-Datenbank und einem Textverarbeitungsprogramm (wahrscheinlich Word) eine Reihe von Tools für dynamische HTML 5-Hilfesysteme. So würde Flare oder FrameMaker. Sie benötigen wahrscheinlich noch einen Web-Editor (MS Expressions Web, Dreamweaver usw.) für Zeiten, in denen Sie direkt im HTML arbeiten müssen. Sie benötigen Photoshop oder einen anderen Bildeditor sowie ein vielseitiges Aufnahmewerkzeug.

Am wichtigsten ist, wenn Sie ausgezeichnete Online-Hilfe benötigen, benötigen Sie erfahrene technische Redakteure, die wirklich interaktive Dokumentationsentwickler und Kommunikationsspezialisten sind und "Autoren".

0
user8356