Beste Möglichkeit, Hilfedokumentation anzubieten

413
vDog

Einer meiner Kunden hat eine Software, und er möchte dieser Software Hilfedokumentation beifügen. Ich bin ein Webentwickler und beschäftige mich normalerweise nicht mit solchen Sachen. Die Dokumentation wird über ein Hilfemenü in der Software verlinkt.

Meine Frage ist, wie die Endbenutzer diese Dokumentation am besten anbieten können. Derzeit hat er Hilfedokumente im ppt-Format und neigt dazu, sie in avi umzuwandeln. Ich dachte daran, eine chm-Datei verlinkt zu haben, wusste aber nicht, ob dies Video unterstützen würde (es kann nicht online gehostet werden).

Ich würde mich sehr freuen, wenn mich jemand dazu beraten kann.

-1
Diese Frage würde User Experience SE wahrscheinlich besser passen. gronostaj vor 10 Jahren 1

1 Antwort auf die Frage

1
Psycogeek

Punkte, die ich aus Anwendersicht machen würde.
1) Nicht online, tote Links sind keine Hilfe. (bedeckt)

2) PDFs können doppelten Zwecken dienen, manuel und Hilfe. Aber wenn ich ein Programm (Viewer) installieren muss, wenn ich bereits Hilfe bei einem anderen Programm benötige, ist das keine "Hilfe". Ausreichend verbreitet. Denken Sie aber immer daran, dass es Möglichkeiten gibt, dass Ihr Programm direkt nach einer Neuinstallation installiert wird, oder (sei so ein Glück) das einzige Programm, das sie installieren :-) Die Zuschauer mussten früher einfach mit den Programmen installiert werden, sie sind nicht mehr so einfach (ein Programm) oder klein.

3) Verwenden Sie kein Video, wenn Sie kein Video benötigen. Bilder können Menüelemente, Zeigerpositionen und Text beschreiben, die unten beschrieben werden können. Ich würde es vorziehen, wenn diese Art von Raum nicht genutzt würde. Benötigt einen richtigen Codec, einige Systeme können Videos häufiger als verzerrt haben, ohne Bilder sehen zu können. Lassen Sie es zumindest mit eingebauten Codec-Elementen arbeiten. Animierte GIFs können nützlich sein, wenn sie gut gemacht werden.
Eine einfache Bilddiaschau im Exe-Format, es gibt ein paar (sogar kostenlose) Programme, die sie möglicherweise nicht so universell ansprechen, aber billig schnell, klein, einfach. Mehrere Bild-Diaschauen können aus verschiedenen Programmteilen ausgelöst werden, wodurch das Hilfesystem eingebunden wird.

4) Die Windows-Hilfedateien, durchsuchbar, mit Seiten von Registerkarten und Abschnitten des Programms verlinkt, sind bereits installiert, haben viele Versionen des Betriebssystems durchgearbeitet, selbst wirklich alte Windows-Hilfedateien funktionieren weiterhin. Wenn ich es wirklich brauche, hat es die Arbeit gemacht. Nicht glamourös, aber wer braucht schön, wenn man nur Hilfe braucht. Es wurde in einfacher Form (einfach) angewendet und ist vollständiger mit Programmen verknüpft. Behandelt Bilder und Zeichnungen, ich habe noch keine Videos darin gesehen.

5) Programmmakro, coolste Tutorial-Hilfe, die ich je hatte. Ich habe diese nur 2 mal gesehen, 2 verschiedene Möglichkeiten. Lernprogramm, das Sie durch die Nase führt, um bestimmte Schritte auszuführen, den Cursor (oder den sekundären Zeiger) bewegt Zeigt den Menüpunkt oder die Schaltfläche an, spricht Sie durch, und die Person nimmt an der Aktion teil, und der Vorgang wird schrittweise ausgeführt. Es ist ein Spiel, es ist ein Tutorial, ich bin faul, habe ich gelernt.
Agentenmakros, Clippy-Hilfe (Windows-Büro-Helfer) Programmspezifische Hilfe, die die Person dazu bringt, die gewünschte Aufgabe zu erledigen, einschließlich der Angabe von Orten und Funktionen des Programms, die für das Suchthema spezifisch sind.
Auswirkungen, braucht einen guten Programmierer, viele Tests mit Benutzern. Wird unnotwendig und unangenehm, wenn nicht (und falsch),

6) Spaß, aber verlorene Implementierungen, die Windows-Agenten konnten sich unterhalten und präsentieren und zeigen, darauf schweben und aus dem Weg geschoben werden. Einfach, ihre Aktionen zu schreiben. Nicht mehr breit unterstützt, nie abgehoben, muss installiert werden, nicht mehr Teil des Systems, manche Leute hassen sie. Großartig, aber veraltet.

7) Legen Sie eine DVD oder eine DVD vom Typ Data + mit Programm und Videos an. Installieren Sie das Programm, wenn Sie Videos ansehen möchten. Dieselbe Idee, herunterladbare und abwaschbare Videos, für anfängliche Tutorials, die keinen wertvollen Speicherplatz im Programmordner verschwenden. Wenn wir es brauchen, ist es da, ist nicht mit dem Programm verbunden, blockiert jedoch nicht die Verwendung des Programms, um auf einem anderen Gerät zu spielen, während Sie das Programm üben.

8) Der [?] Und der Hilfe-Cursor. mehr von Microsoft selbst verwendet. Keine Notwendigkeit, Hilfe aufzurufen, drücken Sie einfach auf das Symbol [?], Und der Standardcursor wurde umgedreht, um Hilfe zu erhalten, und Sie könnten "Tool Tip" -Hilfe von Anforderungsfeldern, Schaltflächen und anderen Dingen erhalten, die viel mehr Speicherplatz im Programm benötigen beschreiben. Sehr intuitiv, schnell und löst die "Was ist das?" - Fragen gut.

9) Hover-Tool-Tipps: Sehr schön. Wenn ich den Cursor gedankenlos über dem Gegenstand parke, weil ich nicht weiß, was ich tue, würde er sagen, was / warum der Gegenstand ist, oder Statistiken oder Informationen bereitstellen. Schnell in das Programm eingebaut. Sie scheinen nicht im Weg zu sein, wenn Sie das Programm schnell bearbeiten.

10) Seitenleiste und einziehbare Seitenleistenhilfe, im Programm selbst oder in der Seite, in der das Programm angezeigt wird. Die ordnungsgemäße Implementierung muss kritisch sein, da viele von ihnen sehr hilfreich waren, um zu erklären, was nur der Entwickler versteht, und einige von ihnen waren abscheuliche Raumverschwendung, die im Weg stehen. Kommt auf das Programm selbst an, und wenn sie auftauchen, würde ein Wechsel, sie nie wiederzusehen, funktionieren.

11) HTML-Hilfe. Offline-HTML-Seiten, die im Standardbrowser geöffnet werden, jedoch keine Netzverbindungen erfordern. Sie sind "ok" und vernetzen Themen, die funktionieren. Gute Indexe sind fast genauso nützlich wie die Suche. Mein Griff mit HTML wäre "Verpackung". Es wäre schöner, wenn sie die losen Teile und Teile in Container vom Typ "Webarchiv Einzeldatei" verpackten. Dies würde heute morgen und in 10 Jahren noch mit jedem Browser funktionieren. Bereitstellung einer Art einfachen, ausführbaren HTML-Viewer, nur für diese Dateien. Das Aufklappen des Standardbrowsers ist nicht hilfreich. Seien Sie sehr sicher, dass alle Links gültig sind, fehlende Bilder, die auf dem Entwicklercomputer funktionierten, aber bei der Installation nicht korrekt verlinkt wurden. Ich sage also, dass die Verwendung von HTML gut ist, es funktioniert nicht oder hängt von meinem groben Standard-Browser ab, der nicht so gut ist: -) Ich habe Blocker und Skriptkiller, angepasste Netzoptionen. Halten Sie es einfach und eingesammelt, halten Sie sich vom Scripting und .Net-Material fern und liefern Sie einen verdammten Betrachter. Sonst wird es kaputt gehen.

Ich kenne die Programmierseite der Frage nicht.

Vielen Dank für Ihre Antwort, Psycogeek, ich habe Macro ausgecheckt und es sieht nach einer guten Lösung aus, aber das Problem entsteht, wenn Sie das Fenster Ihres Programms vergrößern. Cursorbewegungen scheinen sich nicht entsprechend anzupassen. Ich könnte stattdessen Windows-Hilfedateien (chm) verwenden. vDog vor 10 Jahren 0