Logiciel : Ingénierie documentaire et packaging Logiciel : ingénierie documentaire et packaging INTRODUCTION L'Ingénierie et la fabrication documentaire est un projet en tant que telle. Elle se doit d'être prévue et anticiper car … sans documentation pas de produit fini La qualité de la documentation avant et après vente est un critère éliminatoire particulièrement à l’export, il n’y a pas de place pour l’à peu prêt. Elle montre le degré de professionnalisme de la solution … et du vôtre par la même occasion. Elle permet en outre de se couvrir d’un certain nombre de risques juridiques en cas de mauvais manipulation (notamment en Amérique du nord). QUI PARTICIPE ? L'élaboration de la documentation est un travail collaboratif qui implique de nombreuses personnes en interne et aussi en externe. En Interne : Le marketing, la R/D (Chef de produit & les développeurs : et oui !!), les Consultants/ Formateurs ou intervenants au service clients, le support (si différent de la R/D), le service documentation si il existe. En Externe : les distributeurs, la sous-traitance (Rédaction, traduction, impression…).en prenant la peine de respecter au départ la méthodologie pour éviter les incompréhensions. Elle nécessiste donc de la gestion de projet et de la planification pour sortir en même temps que le produit (voir même avant pour les bétatesteurs et partenaires qui auront à la diffuser) AVANTAGES Avantage d’impliquer la R/D : Normalement un cahier des charges (CDC) et de spécification a été réalisé en amont des développements (par expérience cela n'est malheureusement pas toujours le cas). Dans tous les cas, cela fait partie du travail des développeurs de documenter un minimum ce qu’ils ont fait. Bien évidemment il n'est pas question de leur faire faire de la littérature mais de préciser ce que fait le logiciel, comment réagissent telles fonctions …etc. Ce travail permet de ne rien oublier, d’estimer le temps de fabrication des documentations, mais aussi à terme d’intégrer de nouvelles personnes dans l’équipe de développement (moins de dépendance en cas de turnover). Autre avantage : il leur facilite le travail pour la suite (si activité support), car mieux la documentation est faite, moins il y aura d’appel … Avantage d’impliquer les consultants / Formateurs et/ou le service clients : Ils ont l’habitude de faire passer des messages, sont capables de reformuler, de vulgariser certaines techniques, d’utiliser des exemples pertinents …et de faire remonter des expériences du terrain. Il est ainsi possible de prévoir les futurs programmes pédagogiques, d’estimer les charges de réalisation des supports, des exercices, de former le personnel interne et les partenaires avant les clients. Si ils participent aux supports et au cas ou il y ait trop d’appel sur un sujet donné, ils pourront faire compléter la documentation ou modifier la formation et les services associés en conséquence. METHODOLOGIE Phase 1 : Valider la terminologie utilisée dans le produit Avantage : harmonisation du discours. Eliminer les ambigüités, les incompréhensions, les mauvaises traductions Pour se faire s’appuyer sur : les constructeurs, les méthodes et habitudes en place, la concurrence … Faire valider ces termes par le marketing, les partenaires … cela facilite aussi l’indexation future (et le référencement !) Phase 2 : Mettre en place une charte documentaire adaptée à chaque type de documentation Permet de normaliser la production de la documentation en interne et avec des sous-traitants extérieurs éventuels Penser à intégrer et respecter les normes internationales en la matière. Phase 3 : Mettre en place un Process de fabrication documentaire qui permet de décrire les étapes successives à réaliser Phase 4 : Rédiger avant toute chose un « Guide utilisateur (User Guide, Tutorial, Getting started ou « Quick started »). L'approche "Guide utilisateur" convient plus à l'attente de l'utilisateur, lorsqu'il s'agit d'aborder un produit. Elle permet de comprendre et de prendre en main le logiciel dans la « chronologie des étapes » L'approche manuel de référence (reference manuel) est adaptée à une documentation technique comme le "Langage ", les API. Il présente toutes les fonctions de manière exhaustive sans ordre particulier. Ne pas également oublier un guide d’installation, l’aide en ligne (avec ses caractéristiques particulières), Wiki ou FAQ pour facilier le support. Phase 5 : Enfin en vue d’exporter votre solution, respecter la règle des 3 étapes indispensables : Traduction Localisation Validation. LE PLUS Nous tenons à disposition de nos abonnés et clients un fiche méthodologique compléte (détail sur le process documentaire, charte documentaire) ainsi que des outils permettant d'établir des métriques (ratio de production) afin de concevoir des documentations de qualité dans les délais. Il est important de ne pas négliger le temps de production dans la roadmap produit par rapport à la date de commercialisation ou de diffusion du logiciel ou release Conseils industrie logicielle Recherche de logiciels