Tour d’horizon des ressources récentes pour les rédacteurs techniques: Choisissez le format de documentation approprié et davantage

Nous publions régulièrement diverses ressources pour informer les auteurs et rédacteurs techniques sur des sujets importants, des articles, des conseils et astuces… afin qu’ils soient aussi efficaces que possible au quotidien. Voici une sélection de sujets récents que nous avons publiés sur différents réseaux sociaux. Vous devriez envisager de nous suivre pour être informés des futures publications sur : FaceBook, Twitter, LinkedIn, YouTube ou Google+.

Le choix du format de publication approprié pour vos fichiers d’aide peut être délicat.
C’est la grande question à laquelle nous répondons dans l’article suivant : devez-vous publier un manuel imprimé (copie papier) ou une version numérique (PDF, CHM, Web HTML, format eBook…) ?

Quel genre d’erreurs faites-vous pendant l’écriture de documentations ?
Voici les 5 erreurs que vous devez éviter lors de la rédaction de manuels d’aide:

Lorsque vous écrivez un excellent manuel d’aide, vous faites deux choses: aider les clients à trouver et utiliser facilement les solutions appropriées et réduire significativement vos coûts d’assistance clientèle.
Voici quelques conseils sur la façon d’écrire de meilleurs manuels d’aide:

L’analyseur de projet de HelpNDoc vous aide à vous concentrer sur l’écriture en repérant automatiquement les problèmes dans vos projets.
Apprenez, dans ce guide vidéo, à utiliser l’analyseur de projet de HelpNDoc pour contrôler vos projets de documentation à la recherche d’éventuels problèmes :

Tellement Vrai:
“La plupart des écrivains peuvent écrire des livres plus rapidement que la plupart des éditeurs émettent des chèques”
— Richard Curtis

Les guides d’utilisation dessinés sont-ils plus interactifs et plus faciles d’emploi que d’autres modèles de fichiers d’aide ?
Qu’en pensez-vous?

Commencer est difficile et la perfection prend du temps…

Une fois votre documentation écrite, c’est le moment de générer de multiples formats. HelpNDoc vous permet de personnaliser l’apparence et la conception via un très puissant éditeur de modèle. Apprenez à vous en servir à travers la vidéo suivante:

Lisez-vous assez ?
“La majeure partie du temps de l’écrivain est consacrée à la lecture, afin d’écrire un homme retournera plus de la moitié d’une bibliothèque pour écrire un livre.”
— Samuel Johnson.

“Je n’ai jamais eu de doutes sur mes capacités. Je savais que je pouvais écrire. J’ai juste eu à trouver une façon de manger tout en le faisant”
— Cormac McCarthy

La ponctuation sauve des vies ;)
Quelle est la pire erreur de ponctuation que vous ayez vu dans un manuel d’aide ?

Avez-vous apprécié cette petite sélection d’articles et de ressources ? Vous pouvez nous suivre pour celles à venir sur : FaceBook, Twitter, LinkedIn, YouTube ou Google+.

Voir aussi

Catégories: articles
Tags: réseaux sociaux