Rédaction technique

Intermec STC

Lecteurs de code-barres

Du produit à ses accessoires, rédaction sur site

Ma collaboration avec Intermec STC remonte à 2005.
 
Les deux dernières missions en date consistaient à créer plusieurs ensembles complets de documents pour trois lecteurs de code-barres : User's Guides, Quick Start Guides, Instructions Manual, Instructions Sheet. Un second volet de la mission concernait la mise à jour de documents existants. Ci-dessous, quelques exemples de travaux réalisés.
 
Ces missions, toutes basées sur site, comprenaient les phases suivantes :

  • recueil des informations auprès de la R&D, des chefs de projet, du support et du marketing,
  • structuration des informations,
  • rédaction (sous Adobe FrameMaker 8 et 9 et Adobe InDesign CS5),
  • création des illustrations (de eDrawings à Adobe Illustrator CS5),
  • génération des documents.
Recommandation

« Mathieu Jacquet has been a great contractor. He is hard working and reliable. He is able to adapt to the different tasks required (writing, graphics, translations, etc.) and ready to learn new technologies if necessary. I highly recommend his services. Looking forward to working with him again in the near future. »
 

Krista Monjauze, Technical Communications Specialist, Intermec STC (Toulouse office)

Document(s) réalisé(s)
Sierra Wireless

M2M, Machine-to-Machine (Software as a service)

Du PDF, du Web et des vidéos pour un SaaS et ses outils

Ma collaboration avec Sierra Wireless a démarré dès 2005 avec la rédaction de deux premiers User Guides (sous MS Office Word) pour un studio Eclipse de développement d'application M2M, M2M Developer Suite.

 
Elle s'est poursuivie jusqu'à ce jour par la rédaction de nombreux Getting Started Guides, User Guides et Developer Cases (scénarios de développement à l'intention des développeurs, voir sur la Developer Zone de Sierra Wireless), pour différentes offres logicielles proposées en Saas (Software As A Service): AirVantage Services Platform, AirVantage Smart Automation, AirVantage Management Service

 
Les grandes étapes de la mission :

  • recueil des informations auprès des développeurs, chefs de projet et responsables produit. Intégralité du travail effectuée à distance, et ponctué de régulières réunions d'avancement sur site,
  • création des différentes et rédaction en anglais (Adobe FrameMaker 9 ou directement dans le Confluence Wiki de l'entreprise), illustrations sous forme de captures d 'écran (Snag-It) et, pour le dernier projet de User's Guides, par un graphiste professionnel, Yves Saint Lary (quelques exemples dans «Contenu Wiki (court extrait)» ci-dessous).
  • génération du contenu aux formats PDF et HTML

 
Derniers travaux en date: un User Guide entièrement rédigé sous Confluence (ici) ainsi qu'une série de didacticiels vidéos mis en ligne sur le AirVantage™ Learning Center.

Recommandation

« Mathieu Jacquet est notre partenaire privilégié pour la rédaction et la mise en forme de la documentation technique, notamment celle destinée aux développeurs, et en particuliers les tutoriaux. Sa capacité à se mettre dans la peau d'un développeur, à dérouler les scénarii techniques tout en faisant la documentation, est pour tous un gain de temps évident. Sa double compétence technique et documentaire, avec sa qualité relationnelle et sa disponibilité sont les atouts majeurs qui me font chaudement recommander Mathieu Jacquet.
Certains des documents réalisés par Mathieu sont téléchargeables au format HTML et PDF sur http://developer.sierrawireless.com (anglais) »
Thibault Cantegrel, Developer Program Director, Sierra Wireless

Document(s) réalisé(s)
Convertigo

Mashups d'entreprise (plateforme open source)

Un Mash-Up documenté à distance, et par automatisation

Convertigo a fait appel à moi lors du lancement de son Mash-Up (logiciel permettant de combiner plusieurs sites Web et applications) sur le marché américain.

 

Il m'a été de demander de créer la documentation de bout en bout, soit cinq Getting Started Guides (environ 250 pages chacun). À l'issue de ce premier travail, un processus de production documentaire automatique (à partir des informations contenues dans le logiciel, beans XML) a été développé, à l'aide de l'outil FrameScript. Il a permis de créer le Reference Manual (800 pages), qui est aujourd'hui mis à jour automatiquement par le lancement d'un script.

 

Les grandes étapes de la mission :

  • recueil d'informations auprès de l'équipe projets via des formations à distance (par GoToMeeting entre le siège de Convertigo (région parisienne) et mon bureau toulousain),
  • création de maquette (Adobe FrameMaker 9),
  • rédaction de contenu en anglais (Adobe FrameMaker 9) illustré par des captures (Snag-It).
  • génération des documents aux formats requis (PDF et HTML (OmniHelp, EclipseHelp)).

 

Cette documentation est disponible en ligne : Getting Started et Reference Manual.

Recommandation

« Mathieu a travaillé avec moi dans la construction de notre documentation produit, via l’écriture de cinq Quick start guides ainsi que la mise en œuvre d’une génération automatique du Manuel de référence directement extrait du code source de notre application Convertigo, ainsi que sa rédaction. D’un contact très agréable, Mathieu a écrit des documentations de grande qualité, tant en terme de contenus et de langue anglaise, que de rendu esthétique. Il a inscrit dans notre société une volonté de continuer ce projet documentaire et m’a formé sur les outils utilisés afin que je puisse maintenir ce niveau de qualité. Travailler avec Mathieu fut une très belle et intéressante expérience. »
 
 

Elodie Eberhardt, Program Manager, Convertigo

Document(s) réalisé(s)
Kapsys

Navigateurs GPS multi-transports

Le duo de base : Guide de prise en main & Guide utilisateur

Cette mission de rédaction technique m'a été confiée alors que Kapsys s'apprêtait à lancer son tout premier modèle de navigateur GPS vocal, le Kapten.
 
Il s'agissait, en une vingtaine de jours, de créer l'essentiel de la documentation pour toute nouvelle technologie : un Guide de prise en main rapide (sous forme de brochure dépliante) ainsi qu'un Guide d'utilisation complet.
 
Ce fut chose faite, avec une prise d'informations sur site, à Sophia-Antoplis, suivi d'un travail à distance de :

  • création de maquette, rédaction en français (Word pour le Guide de prise en main avant mise en forme définitive par un infographiste, Adobe FrameMaker 7 pour le Guide d'utlisation), et travail d'illustration (retouche de photos et illustration existantes, ajout de texte, etc.),
  • génération au format PDF.
Document(s) réalisé(s)
Poclain-Hydraulics

Transmissions hydrostatiques

Documentation après-vente (ateliers de réparation), refonte documentaire

J'ai été amené, en tant que responsable rédaction technique de Raptrad-Imagine, à travailler avec les équipes de documentation de Poclain Hydraulics lors de la refonte de leur système documentaire.
 
La mission consistait à éclater le contenu des documents "tout en un" utilisés dans les ateliers de réparation en un ensemble de fiches claires et succinctes, organisées en 5 familles : Procédure, Savoir-faire, Outillage, Service bulletin, Valeurs. Vous trouverez ci-dessous trois exemples de fiches (à l'état non finalisé).
 
Les grandes étapes de la mission :

  • recueil des informations et du contenu à « refondre » au centre de formation Poclain Hydraulics et en atelier de réparation, auprès de l'équipe de documentation, des formateurs et des techniciens,
  • création de maquette et rédaction de contenu en français (Adobe FrameMaker 7), photos fournies par le client et retouchées par le pôle inforgraphie de Raptrad-Imagine,
  • génération des fiches au format PDF.
Document(s) réalisé(s)
Esterel Technologies

Outils logiciels de conception, de validation et de génération de code pour les applications critiques

Documentation logicielle complexe, mise à jour sur site, migration Word - FrameMaker

Plusieurs travaux de rédaction technique ont été réalisés pour Esterel Technologies lors de mon passage au sein de Raptrad-Imagine
 
Un travail de migration d'un document Word de plusieurs centaines de pages au format FrameMaker tout d'abord, avec tout les efforts de vérification des références croisées, de gestion des images et des arborescences et de mise en correspondance des différents styles (de caractères, de paragraphes, de tableaux, etc.) des formats que cela comporte. Le tout a été réalisé en quelques jours, grâce notamment à plusieurs scripts FrameScript.
 
Un travail de mise à jour ensuite, celle de la documentation technique de la suite logicielle Scade®. Celui-ci a été effectué sur site, dans les locaux de l'entreprise à Toulouse, parmi l'équipe de développement de de support (40 jours). 

Recommandation

« Mathieu a collaboré efficacement à la remise à niveau d'une partie de notre documentation produit sur la génération de code C.
Capable de s'investir dans un domaine très technique et d'acquérir rapidement l'expertise technique requise auprès de nos spécialistes, il a su fournir le bon niveau d'explication et d'illustration des différentes options du générateur de code de notre outil SCADE Suite.
Réactif, adaptable, et d'un contact facile, Mathieu a parfaitement rempli sa mission selon un cahier des charges précis et malgré des délais de réalisation contraignants. »
 
Guillaume BENNEHARD, Usability Assurance and Documentation Manager