Bien que fréquemment ignorés par de nombreux utilisateurs d'ordinateurs, les fichiers d'aide fournissent des informations clés sur la façon d'utiliser l'application logicielle à laquelle ils sont associés. En cliquant sur « Aide », un utilisateur peut obtenir un aperçu des fonctionnalités du programme, une description de l'écran qu'il regarde, des instructions sur la façon d'utiliser le programme pour effectuer une tâche donnée ou lire des listes de questions fréquemment posées sur le programme et leurs réponses. L'écriture d'un fichier d'aide nécessite à la fois la capacité de travailler avec des applications logicielles et la capacité d'expliquer les choses d'une manière que les utilisateurs peuvent comprendre.
Pas
Étape 1. Obtenez une copie du logiciel que vous devez documenter
Si possible, vous devriez également obtenir une copie des spécifications écrites du programme, bien que tous les développeurs de logiciels ne travaillent pas avec eux. Dans certains cas, le programmeur s'écartera des spécifications, en raison d'un temps de développement court ou de l'incapacité de coder une fonctionnalité particulière.
Étape 2. Obtenez un outil de création d'aide
Bien qu'il soit possible de créer un fichier d'aide à la main, à l'aide d'un fichier au format texte enrichi (.rtf), la plupart des auteurs de fichiers d'aide utilisent une application logicielle pour écrire leurs fichiers d'aide, comme RoboHelp, Help and Manual, Doc-To -Aide, MadCap Flare ou HelpLogix. La plupart des outils de création d'aide incluent un éditeur de texte ou fonctionnent avec un programme de traitement de texte comme Microsoft Word et fournissent une interface utilisateur qui permet à l'auteur de l'aide de voir à quoi ressemblera le fichier d'aide lorsqu'il l'écrit tout en écrivant du code informatique dans les coulisses pour faire fonctionner le fichier d'aide. Certains outils de création d'aide incluent également des éditeurs graphiques permettant de créer des captures d'écran à inclure dans le fichier d'aide.
Il existe un certain nombre de formats de fichiers d'aide: Le plus courant est l'aide HTML, qui est utilisée par les applications qui s'exécutent sous Windows. (Un format plus ancien, WinHelp, n'est plus pris en charge.) Apple et Unix ont chacun leurs propres formats, tout comme Sun Microsystems, avec son JavaHelp. Les applications logicielles conçues pour fonctionner sous plusieurs systèmes d'exploitation peuvent utiliser un système d'aide multiplateforme qui s'exécute dans le navigateur Web de l'utilisateur. Quel que soit l'outil de création d'aide que vous utilisez, il doit prendre en charge le(s) format(s) d'aide dans lesquels vous allez créer des fichiers d'aide
Étape 3. Créez le fichier de projet d'aide
Votre outil de création d'aide créera un fichier de projet d'aide pour vous, en fonction du nom de fichier que vous fournissez et d'autres informations. Le fichier de projet principal contient des informations sur les autres fichiers, qui incluent un fichier de contenu, un fichier d'index, un ou plusieurs fichiers image et d'autres fichiers.
- Le fichier de contenu comprend le texte du fichier d'aide qui explique le fonctionnement de l'application logicielle que vous documentez. Le texte est généralement divisé en sujets qui couvrent un écran, une fonctionnalité ou une procédure spécifique.
- Le fichier d'index est une liste des rubriques du fichier d'aide. Il est utilisé pour créer une table des matières que les utilisateurs peuvent utiliser pour sélectionner un sujet à afficher, ainsi qu'un index consultable dans le fichier d'aide.
- Les fichiers image sont des fichiers graphiques d'écrans de programme ou de parties de ces écrans affichés dans le fichier d'aide pour améliorer la capacité des utilisateurs à comprendre à quoi le texte du fichier d'aide fait référence.
Étape 4. Ajustez la taille de la fenêtre d'aide
À moins que vous n'écriviez le fichier d'aide pour qu'il apparaisse dans le navigateur Web de l'utilisateur, le fichier d'aide apparaîtra dans sa propre fenêtre. Votre outil de création d'aide vous permettra d'ajuster les dimensions horizontales et verticales de la fenêtre à une taille qui permettra à l'utilisateur final de lire le fichier d'aide sans gêner l'application elle-même. La fenêtre d'aide principale est souvent dans un format à trois volets, avec la table des matières à gauche et le sujet sélectionné à droite.
Les fichiers d'aide peuvent également avoir, en plus de la fenêtre principale, des fenêtres secondaires qui décrivent en détail une fonctionnalité particulière et des fenêtres contextuelles de dimensionnement automatique qui donnent de brèves descriptions des fonctionnalités. Les fichiers d'aide peuvent également inclure du texte incorporé qui n'apparaît que lorsque le texte en surbrillance ou un bouton est cliqué
Étape 5. Écrivez les rubriques d'aide
Pour ce faire, vous devrez revoir les spécifications ou le programme lui-même pour créer les rubriques afin de documenter les écrans et les fonctionnalités du programme. Au fur et à mesure que vous créez chaque rubrique, votre outil de création d'aide l'ajoute à la table des matières et à l'index du fichier d'aide.
- Bien que vous puissiez créer la table des matières au fur et à mesure, il est utile d'avoir un plan pour l'organiser. Vous pouvez organiser la table des matières autour des écrans du programme, de ses fonctionnalités, de ses modes d'utilisation ou d'une combinaison de ceux-ci.
- Au fur et à mesure que vous rédigez les rubriques, tenez compte des autres informations du fichier d'aide auxquelles les utilisateurs voudront avoir un accès rapide. Vous pouvez créer des sauts ou des hyperliens dans le texte du fichier d'aide qui se connectent aux rubriques contenant ces informations.
Étape 6. Incluez des captures d'écran, si nécessaire
De nombreuses fonctionnalités du programme sont mieux expliquées avec une combinaison de texte et de graphiques. Vous pouvez créer des captures d'écran avec l'application fournie avec votre outil de création d'aide ou avec une application distincte, telle que Microsoft Paint, Paint Shop Pro ou SnagIt.
- Le texte et les captures d'écran doivent être regroupés dans un sujet de manière à ce que les utilisateurs puissent voir la capture d'écran et son texte d'accompagnement sans défilement excessif. Dans de nombreux cas, vous souhaiterez afficher une partie d'un écran de programme au lieu de l'écran entier, ou afficher la capture d'écran dans une taille plus petite que l'original. Votre application de capture d'écran doit être capable de redimensionner la capture d'écran sans flou ni perte de détails.
- Si vous anticipez des modifications de l'interface utilisateur entre les versions de test et finales du programme, vous souhaiterez peut-être suspendre la création de captures d'écran jusqu'à ce que vous disposiez de la version finale du programme avec laquelle travailler.
Étape 7. Créez un fichier de carte, si nécessaire
Certains programmes incluent des boutons "Aide" permettant à un utilisateur de cliquer et d'afficher la rubrique dans le fichier d'aide qui décrit spécifiquement le fonctionnement de cet écran. L'affichage d'un sujet de cette manière est appelé aide contextuelle et nécessite la création d'un fichier map pour que le programmeur lie le bouton « Aide » au sujet spécifique dans votre fichier d'aide. Votre outil de création d'aide peut en créer un pour vous, ou le programmeur peut le coder et vous le donner pour l'inclure dans le fichier d'aide.
Étape 8. Compilez le fichier d'aide
La compilation crée le fichier d'aide réel qui sera inclus avec le programme. Pour la plupart des formats d'aide, cela incorporera tous les fichiers de composants qui ont été créés lorsque vous avez créé le fichier d'aide, bien que certains formats d'aide non compilés nécessitent également que les fichiers de rubrique d'aide individuels soient inclus avec le programme.
Étape 9. Testez le fichier d'aide
Une fois que vous avez compilé le fichier d'aide, vous devez le tester pour vous assurer que tous les hyperliens se connectent aux sujets auxquels ils sont censés et que tous les graphiques s'affichent correctement. Le fichier d'aide doit également être testé pour s'assurer que le contenu est précis et approprié pour les utilisateurs et dans un format cohérent. Vous voudrez examiner vous-même le fichier d'aide et demander aux personnes qui testent l'application de l'examiner également.
Sur les projets de fichiers d'aide plus volumineux, la compilation et les tests sont des processus continus. Vous voudrez compiler le fichier d'aide et vérifier votre travail plusieurs fois avant de créer la version finale
Étape 10. Donnez le fichier d'aide au développeur pour qu'il l'inclue avec le programme
Selon la nature du projet et le format du fichier d'aide, vous devrez peut-être fournir au développeur plusieurs fichiers, y compris un fichier de carte s'il existe des sujets contextuels.
