Quel type de système d'aide est le meilleur?
Dans mon entreprise, nous créons des applications de bureau basées sur Windows. Dans le passé, nous avons créé des fichiers .chm pour notre documentation d'aide et nous en avons été satisfaits. Nous avons maintenant été confrontés à certains problèmes concernant le logiciel que nous utilisons pour créer le .chm et nous devions essentiellement investir beaucoup d'argent pour continuer à utiliser ce logiciel de création .chm, ce qui m'amène à cette question: Are. chm fichiers est-il vraiment le meilleur moyen de fournir de la documentation d'aide?
J'ai effectué des recherches sur la création de fichiers PDF avec tous les éléments qui se trouvent dans les fichiers .chm, tels qu'une table des matières et des liens qui permettent d'accéder à d'autres sections du document. L'aide en ligne n'est pas une option. Quelle que soit la solution que nous choisissons a pour fonctionner sans connexion Internet.
Encore une fois, quel type de système d'aide est le meilleur? Les fichiers PDF sont-ils acceptables au lieu des fichiers .chm? Y a-t-il une autre meilleure alternative?
Mise à jour: Il semble que nous devons utiliser .chm pour plusieurs raisons, principalement en raison de sa facilité de mise à jour et de distribution (1 seul fichier). Mon runner jusqu'à cela aurait été l'aide html, qui est essentiellement ce qu'est un .chm de toute façon.
Les gens ne lisent pas. La meilleure aide n'est pas d'aide. Bien sûr, pour ce faire, vous devez mettre beaucoup de temps et travailler dans l'UX.
Donc, en supposant que vous ayez besoin d'aide, je suggérerais que la meilleure serait une aide contextuelle qui puisse créer un lien vers votre site Web avec les dernières informations d'aide mises à jour. Vous publieriez l'aide au format HTML, vous évitant ainsi les workflows de production CHM propriétaires.
Comme d'autres l'ont dit, vous devriez chercher à générer des fichiers HTML que vous expédiez avec votre produit pour obtenir de l'aide. Un de nos produits (utilisé dans un environnement sans accès Internet) le fait depuis des années et de nombreux utilisateurs le préfèrent aux PDF que nous expédions également parce que la navigation est plus facile, le contenu se présente pour s'adapter à la fenêtre du navigateur et au bloc la taille est plus petite. Notre configuration HTML prend également en charge l'aide contextuelle, bien que nous ne l'ayons pas encore implémentée.
A PDF est une belle présentation de la documentation basée sur la page, mais si l'utilisateur veut éviter le défilement horizontal pour le lire, il doit allouer une bonne quantité de En fonction de la taille de son moniteur et de l'espace requis par votre application, il peut ne pas être possible pour lui d'afficher l'aide à côté de l'application, ce qui est gênant s'il utilise le document pour parcourir une étape étape par étape.
Comme impliqué dans mon premier paragraphe, générer plusieurs formats n'est pas difficile si vous avez les bons outils. Aucune raison pour laquelle vous ne pouvez pas générer et expédier à la fois HTML et PDF, donnant à l'utilisateur la possibilité.
Pour la génération automatique de documentation technique, vous pouvez utiliser des formats de publication XML tels que Docbook ou DITA. En particulier, DITA est capable de générer des fichiers PDF, CHM, RTF et HTML.
J'ai utilisé Serna Free editor qui fournit un bon support d'édition visuelle (WYSIWYG) pour DITA afin de réduire les spécificités XML.
Cependant, la documentation technique n'est pas la manière la plus efficace de communiquer aux utilisateurs finaux. De plus en plus, des protoypes interactifs sont utilisés pour communiquer avec les utilisateurs. Pour un exemple, jetez un œil à la démo Google+ . L'élaboration de ce type de prototypes peut coûter cher. Cependant, si un processus UXD est utilisé, ces prototypes peuvent être utilisés à de nombreuses étapes du processus. Ils valent donc la peine.
Le PDF est une mauvaise option:
- il est orienté page, ce qui craint pour la lecture à l'écran. PDF vous fait choisir entre un nombre infiniment petit et beaucoup de défilement.
- La recherche est terriblement lente à gérer par rapport à toute autre chose
- Certaines personnes réagissent fortement négativement à certains produits associés au PDF. Imaginez un hager Aggrobat en entreprise avec une politique informatique très stricte
- Le PDF est un format d'impression, pas un format de lecture
Si cela doit être au format PDF
- format paysage pour les pages
- Utilisez un générateur qui crée un index
- Bundle un lecteur PDF PDF décent avec votre application (installation facultative, bien sûr)
Comment aidez-vous l'auteur?
J'irais pour les rédacteurs techniques qui éditent directement le HTML. Sharepoint Designer est gratuit et "fonctionne comme Word" (citation réelle), vous auriez besoin d'une configuration et de règles concernant les styles, la réticulation, etc., mais cela a fonctionné.
Que vous regroupiez le code HTML dans un CHM n'a pas vraiment d'importance. Le principal avantage de CHM par rapport au HTML simple est l'index et la recherche en texte intégral. Il existe des moteurs de recherche HTML pour le site client, mais je n'en ai pas trouvé un qui soit facile à utiliser
Contenu sur format, écrire pour les utilisateurs d'aujourd'hui
Même si j'ai critiqué PDF ci-dessus, je dirais toujours que le contenu est plus important que le wrapper final. Un excellent manuel en PDF bat un médiocre) qui peut être téléchargé directement sur le cerveau.
Le comportement des utilisateurs a considérablement changé avec les progrès de l'interface utilisateur
- Les utilisateurs s'attendent à ce qu'ils n'aient pas besoin de vous lire le manuel. Si votre logiciel nécessite de lire un manuel, votre logiciel est nul. (Il semble qu'il reste <1% des utilisateurs qui lisent de couverture en couverture et signalent des captures d'écran incorrectes et des fautes d'orthographe mineures)
- Les utilisateurs se tourneront vers votre manuel lorsqu'ils seront bloqués
- Les utilisateurs se tourneront vers la recherche et essaieront différents termes de recherche/recherche de manière incrémentielle.
Il n'y a plus grand intérêt à documenter les boîtes de dialogue et les longues listes d'éléments de menu. Fournissez un manuel axé sur les tâches, de nombreux tutoriels et des exemples de scénarios. Répondez aux questions. Ne décrivez pas les éléments de dialogue (ils doivent être auto-descriptifs), mais comment ils interagissent avec les autres et affectent le résultat.
Utilisez les fonctionnalités interactives de HTML. Vous pouvez intégrer des vidéos, de l'audio, un lien vers votre page de produit, etc.
Une question clé à laquelle vous devez répondre est de savoir si vous souhaitez offrir une aide séparée ou un mécanisme d'aide contextuel. L'un, l'autre ou les deux affecteront probablement votre choix d'outil.
Indépendamment de ce que vous pensez d'eux, Adobe a généralement de très bons mécanismes d'aide dans leur application. D'après ce que je peux voir, ce sont des alternatives sur mesure à CHM, mais semblent être basées sur HTML. Je n'ai pas les dernières versions de leurs trucs, donc je ne sais pas comment ils le font maintenant.
Comme le dit Roger, il existe des outils qui vous permettent de générer des systèmes d'aide HTML run-in-browser. Mais encore une fois, leur utilité peut dépendre de la sensibilité au contexte dont vous avez besoin de votre aide.
Selon l'application, une aide en ligne plus ou moins importante peut être extrêmement utile. Certaines formes sont meilleures que d'autres. Certains sont plus faciles à produire ou à entretenir.
Souvent, il doit y avoir un guide de l'utilisateur, qui dirige ensuite l'effort de documentation principal. L'aide en ligne peut alors se présenter comme une forme réorientée ou dérivée d'un guide de type livre - même si le guide n'est jamais imprimé mais existe uniquement au format PDF.
Ces efforts peuvent être OK ou moche. Gifler simplement un PDF vers le haut à l'écran n'est pas génial. Vous devez mettre un peu de travail dans la (ré) organisation, le bookmarking, l'hyperlien, la recherche du guide de l'utilisateur pour le rendre utile dans le programme.
Vous devez choisir votre format de livraison en fonction de l'audience, de la durée d'attention, du besoin de documents imprimés. Les applications commerciales internes nécessitent des cours de formation, qui peuvent également stimuler la demande pour un livre ou un autre livrable de formation.
Si votre application peut s'en sortir sans expliquer quoi que ce soit ni montrer aucune aide supplémentaire aux utilisateurs pendant leur utilisation, hourra, les développeurs ont décroché le jackpot et ont probablement eu une équipe d'écrivains et de communicateurs techniques travaillant à leurs côtés.
Ce n'est presque jamais le cas. Presque tous les logiciels doivent afficher, dans l'application, certaines rubriques d'aide "comment puis-je" et "comment fonctionne cet outil". De nos jours, les moyens les plus simples sont l'aide CHM (compilée) et l'aide basée sur HTML, avec une interactivité fournie via Javascript. Vous pouvez avoir un système d'aide HTML identique à CHM en utilisant l'un des environnements de développement d'aide coûteux ou en utilisant des éditeurs gratuits. J'ai eu beaucoup de succès avec une bibliothèque, le compilateur d'aide FAR, une sorte d'atelier combiné CHM/Javascript qui est presque gratuit.
Je suis convaincu que HTML5 est la voie à suivre pour tout système de documentation/d'aide en ligne. Avec Javascript, CSS, graphiques SVG, de nombreuses bibliothèques, vous pouvez offrir toute l'interactivité de n'importe quel site Web et inclure des animations, des vidéos, une recherche en texte intégral, une IA, une 3D, etc.
Il n'y a pas d'environnement de développement parfait pour tout cela, car cela nécessite des outils d'écriture et de langage que les éditeurs de code seuls n'ont pas. Il existe de gros packages de publication qui promettent plusieurs formats de sortie, mais il est impossible d'être parfait avec la création et la sortie de PDF, CHM, HTML.
Visual Studio avec une base de données de gestion de contenu et un traitement de texte (probablement Word) serait un ensemble d'outils pour les systèmes d'aide HTML 5 dynamiques. Il en irait de même pour Flare ou FrameMaker. Vous avez toujours besoin d'un éditeur Web (MS Expressions Web, Dreamweaver, etc.) pour les moments où vous devez travailler directement dans le HTML. Vous avez besoin de Photoshop ou d'un autre éditeur d'images et d'un outil de capture polyvalent.
Plus important encore, si vous voulez excellent une aide en ligne, vous avez besoin de rédacteurs techniques expérimentés, qui sont des développeurs de documentation et des spécialistes de la communication vraiment interactifs et autant qu'ils sont des "rédacteurs".