youtube Calenco
linkedin Calenco

Documentation d'une solution logicielle

Contexte

  • Entreprise Leader : IGDoc
  • Entreprise(s) partenaire(s) : Neodoc
  • Nom du client : Confidentiel
  • Secteur d'activité : Energie
  • Durée du projet : mai 2019 - septembre 2020
  • Utilisateurs concernés par la solution (utilisateur final) : techniciens, exploitants de la suite logicielle
  • Besoins du client :

    • Produire les manuels d'exploitation, d'installation, d’utilisation et de formation d’une solution logicielle développée en interne
    • Tester un outil de rédaction structurée
  • Prestations proposées :

    • Accompagnement à la mise en place d’un outil de rédaction structurée
    • Mise à disposition d’une bibliothèque documentaire synthétique, uniforme et complète d’une suite logicielle
    • Manuel d’exploitation à destination des exploitants systèmes et administrateurs applicatifs
    • Dossier d’architecture à destination des développeurs applicatifs et architectes infrastructures
    • Traduction FR > EN

Méthodologie

  • Méthode employée :

    • Description de la méthode :

      • Binômes expert IT IGDoc–rédacteur technique confirmé pour la production de 9 livrables
      • Prestation assurée en mode Agile sur une dizaine de sprints avec des ateliers hebdomadaires avec les experts côté client
      • Conseil et accompagnement sur la bibliothèque documentaire attendue par les utilisateurs finaux
    • Ressources mobilisées (nombre et fonction - en interne ou ressource client) :

      • un rédacteur technique senior IGDoc
      • un expert IT IGDoc
      • un chef de projet IGDoc
      • un chef de projet Neodoc
      • un développeur Neodoc
      • 4 experts techniques client
      • un groupe d'utilisateurs
    • Groupes de travail/ateliers nécessaires : à peu près un groupe de travail par semaine de 2 à 6 heures nécessaire ainsi que des ateliers ponctuels avec les utilisateurs
    • Outils utilisés :

      • Calenco
      • Memsource (traduction)
      • Microsoft Power Point (pour les schémas)
      • Gimp ou Paint (retouche d'images)
  • Livrables :

    • Manuels d’exploitation, d’installation, d’utilisation et de communication d’une solution logicielle développée en interne

Bénéfices

  • Coûts (ROI) :

    • Investissement de la part du client au départ pour la mise en oeuvre des feuilles de styles amorti par la volumétrie de documentation à produire
    • Gain sur la production de la documentation à long terme, une fois la nouvelle méthode mise en place (rédacteur technique + outil)
  • Délais :

    • Intervention de l'expert IT pour faire le lien entre le rédacteur technique et les experts métier : gain de temps sur l'appropriation et la prise en compte des données techniques
    • Gain de temps pour les experts qui sont déchargés de la production des documents
  • Qualité :

    • Une documentation multimédia et multilingue répondant aux besoins des utilisateurs
    • Structuration, rédaction et illustrations de haute qualité
    • Adaptation des formats aux supports de consultation (aide contextuelle, PDF interactif)
    • Réduction des sollicitations des utilisateurs auprès des experts
  • Sécurité :

    • Un outil XML répondant aux exigences de sécurité d'un EPIC dont les projets ont un haut niveau de confidentialité
    • Cohérence et maîtrise des contenus
    • Fiabilité et homogénéité de la terminologie
    • Réduction du risque d'erreur grâce aux tests des procédures
textureburgermenubulletcheckbulletnonenone