Il n’existe qu’une unique règle pour le choix du meilleur format de publication de manuels d’aide : à savoir choisir le format qui rend le manuel facile d’accès aux utilisateurs quand et tel qu’ils en ont besoin.
Fait intéressant, les utilisateurs du produit ont accès à de nombreux périphériques, logiciels et contenus numériques, y compris des navigateurs web, PDF, Microsoft Word et appareils intelligents tels que smartphones, tablettes, Kindle, iPad, Mac… La liste est presque interminable. Voici pourquoi la rédaction d’un manuel d’aide de qualité peut être le meilleur investissement réalisé par votre entreprise.
Mais avec une telle longue liste, quel est le meilleur format pour publier votre manuel d’aide? Examinons certains d’entre eux.

Lire la suite →

Tout le monde ou presque a au moins une horrible histoire liée à un manuel d’aide à raconter. Qu’il s’agisse d’essayer de comprendre un produit quand le manuel d’aide est écrit dans un si mauvais Français qu’il est illisible, ou qu’un produit ait simplement été livré avec le manuel d’un autre modèle. Ou peut-être l’histoire concerne-t-elle l’un de ces manuels qui sont si détaillés qu’ils contiennent trop d’informations et qu’il est presque impossible de trouver la réponse dont vous avez rapidement besoin. Il existe beaucoup de raisons pour qu’un manuel d’aide soit mauvais, mais en général, elles peuvent être divisées en deux principales catégories:

• Le manuel est obsolète ou contient la mauvaise information
• Le manuel est mal écrit ou il est difficile à parcourir

Lire la suite →

Rédiger un manuel d’aide peut souvent s’avérer être un processus très pénible. Tout le monde sait que l’objectif est de créer un manuel qui permette aux utilisateurs de comprendre toutes les fonctions de vos produits et de résoudre les problèmes qu’ils rencontrent. La difficulté réside dans le fait de savoir comment y parvenir. La plupart des auteurs font un jour ou l’autre l’expérience de la page blanche (ou de l’écran blanc), se demandant comment commencer leur dernier livre ou article. Quand on rédige une documentation d’aide, le principal problème est de savoir comment aborder le sujet.

Lire la suite →

Rédiger une documentation d’aide peut être un processus très long. Si vous avez un produit compliqué à expliquer, il n’est pas rare qu’il puisse nécessiter plusieurs centaines de pages d’aide, et même un produit assez simple peut avoir besoin d’un manuel de 50 ou 100 chapitres.
Ce n’est pas seulement la longueur des documents d’aide qui peuvent les rendre compliqués à rédiger. Si vous voulez que votre manuel soit utile à vos lecteurs, vous devez vous assurer que toutes les fonctions du produit sont incluses dans la documentation et que chaque aspect du produit soit décrit avec précision et d’une manière qui soit vraiment utile à votre utilisateur final.
Avec autant d’information à inclure; organiser votre documentation d’aide et la compléter au moment opportun, peut représenter un sérieux défi pour n’importe quel rédacteur technique. Heureusement, il existe une façon de rédiger des documents d’aide plus rapidement, d’y inclure tout ce que vous devez couvrir et de créer quand même un document professionnel de haute qualité qui peut être produit dans une variété de formats.

Lire la suite →

Tout le monde comprend l’importance d’une documentation d’aide précise et mise à jour. La seule manière de tirer le meilleur parti de n’importe quel produit, c’est d’en lire le manuel et d’y trouver comment utiliser correctement chaque fonction. La difficulté à laquelle font face les développeurs de nombreux produits, est de savoir quels formats choisir pour produire leur documentation d’aide. Autrefois, un manuel imprimé était considéré comme suffisant pour la plupart des produits. Au cours des dernières années, le manuel imprimé a souvent été remplacé soit par un PDF, soit par une version en ligne. Mais s’agit-il vraiment des meilleures options disponibles?

Lire la suite →

La création de la documentation d’aide d’un produit, présente de nombreuses similitudes avec un projet étudiant typique. Un projet étudiant devra souvent:

• Discuter d’un sujet en profondeur, en couvrant minutieusement chaque aspect du sujet
• Diviser un sujet en sections clairement identifiables
• Inclure des références détaillées appuyant la conclusion du projet
• Fournir un index complet couvrant le sujet discuté

Toutes ces tâches peuvent être bien mieux gérées dans un logiciel de création d’aide que dans une suite de traitement de texte classique. Si vous rédigez un projet étudiant dans Microsoft Word, vous avez peu d’autre choix que de commencer au début du sujet et de taper le tout au fur et à mesure. Cette approche rend l’écriture du projet difficile et très longue.

Lire la suite →