Documentation d’applications
Rédiger c’est aider
La rédaction technique consiste à aider les gens à utiliser votre application. Que cette application soit utilisée via un mobile ou un ordinateur, que vous soyez dans une relation B-to-B ou B-to-C, l’objectif est le même : vous devez guider l’utilisateur à travers une série d’écrans pour qu’il tire le meilleur parti de votre application, et assurer ainsi sa satisfaction.
Soutenez votre application en la complétant d’un Guide d’installation, d’un Guide de démarrage, de tutoriels, de « how-to » avec toujours cet objectif : la satisfaction de votre utilisateur.
Bien sûr, les manuels de référence (qu’ils soient imprimés ou sous forme d’aide) sont toujours utiles.
Documenter c’est intéressant
Deux aspects sont plus particulièrement intéressants lorsqu’on documente une application :
- La logique de l’application
- Les informations à saisir dans les écrans
Une des tâches plaisantes du travail de documentation c’est de découvrir et comprendre la logique interne de l’application. Mais aussi de trouver le meilleur moyen d’utiliser cette application : la logique utilisateur. Les informations que l’utilisateur doit saisir constituent une bonne part du travail également. Vous êtes le premier utilisateur de l’application, apprenait à connaître l’activité qu’il y a derrière l’application et recherchez les informations pertinentes que vous devez y rentrer.
En tant qu’auteur technique pour des logiciels et des applications métiers, vous êtes à la fois un béta testeur avec des compétences d’écriture et une personne en charge de la communication produit.
Markdown et les générateurs de sites
J’ai toujours eu un faible pour la documentation en ligne, en HTML. Désormais c’est Markdown ! Voir ma page qui lui est consacrée : 🔗 Markdown
L’offre de service Coffee Cup pour la documentation d’applications
Coffee Cup crée pour vous de la documentation de qualité :
- Guide d’installation
- Guide de configuration
- Guide de démarrage
- Manuel utilisateur
- Manuel de référence
- Rubriques d’aide ou systèmes d’aides complets
- Tutoriels
- How-to
- Vidéos
La documentation peut être rédigée en français, en anglais ou en allemand.
🔗 Consultez mon Portfolio.
Outils
WordPress, Adobe FrameMaker, Adobe RoboHelp, Oxygen, Adobe PageMaker, Microsoft Word. Captures d’écran et images réalisés avec Corel Paint Shop Pro ou Adobe Photoshop. Environnement Windows ou MacOs.
Autres outils : Quand on maîtrise déjà une douzaine de logiciels, c’est facile d’en apprendre un autre.