Saint-Quentin-En-Yvelines, un atout pour 4DCONCEPT.

Saint-Quentin-En-Yvelines, un atout pour 4DCONCEPT.

 

 

La société 4D CONCEPT est née en 1989 à Nogent-sur-Marne dans le Val-de-Marne. Après une escale à Jouy-en-Josas dans les Yvelines durant huit années, c’est aujourd’hui dans ce même département, à Saint-Quentin-en-Yvelines, qu’une partie de ses activités trouvent un cadre de vie correspondant à ses valeurs.

 

Comment sommes-nous arrivés dans les Yvelines ?

 

Il nous a suffi d’un appel pour faire décoller cette belle aventure !

Cela a été le cas lorsqu’un jour, l’entreprise Safran, nous a contacté afin de nous confier des travaux importants. Mais, il y avait un « mais ».

La condition était telle qu’elle : Assurer une meilleure communication en déplaçant nos locaux situés dans l’Est parisien pour venir nous installer à Vélizy-Villacoublay dans les Yvelines, tout proche de Safran et de ce qui allait devenir nos « marchés cibles ».

Derrière un appel important se cache parfois certaines surprises qui compliquent les choses. La zone de Vélizy manquait de couverture par les transports en commun, entrainant des complications pour nos clients et nos salariés. Par conséquent, certains clients devenaient réticents à l’idée de nous rencontrer physiquement. Cette relocalisation nous causait trop de difficultés dans le recrutement de compétences tout en affectant la vie de nos salariés.

Nous avons donc décidé de nous rapprocher d’une ville beaucoup plus attractive en termes de mobilité urbaine. Saint-Quentin-En-Yvelines figurait parmi nos options et le choix de Montigny-le-Bretonneux s’est imposé comme une évidence !

 

Une ville qui partage nos valeurs !

 

L’agglomération de la ville nouvelle de Saint-Quentin-en-Yvelines est un rassemblement de communes qui correspond à nos valeurs.

Notre choix s’est fait suivant plusieurs critères ; une ville sportive et prometteuse avec des ambitions multiples sur diverses perspectives. Celle-ci véhicule un esprit sportif et d’entraide, puisqu’elle s’adapte à tout le monde. SQY est une ville dynamique et aménage des infrastructures permettant d’entretenir des liens sociaux.

Continuer son développement en répondant aux besoins de chacun est l’une de ses priorités qui égale les valeurs de notre entreprise. Un cadre de vie agréable pour nos équipes, qui profitent des infrastructures mise en place par la ville, à quelques pas de nos locaux. Des restaurants à proximité, des magasins, ou encore des bars nous permettent d’entretenir une cohésion de groupe même après le travail. La ville continue sa progression avec de nouveaux projets en tête pour continuer de grandir à l’échelle nationale et internationale. SQY est accessible et nous permets de vous rencontrer facilement et rapidement. La gare se situe à cinq minutes à pied de 4D CONCEPT. Celle-ci dessert la ligne N et U en direction de Paris Montparnasse et La Défense, mais également le RER C. Un emplacement favorable pour nos équipes qui facilite leurs trajets au quotidien.

 

SQY, ville phare des Jeux Olympiques et Paralympiques 2024

 

L’agglomération de SQY a poussé ses ambitions lui permettant d’être représentée durant les JO 2024. Plusieurs compétitions se dérouleront dans la ville et ses alentours. Ainsi, le développement d’infrastructures sportives permet désormais d’accueillir une multitude d’épreuves sportives. Le cyclisme sur piste se déroulera dans le fameux vélodrome de Saint-Quentin-En-Yvelines, ou encore le BMX sur la célèbre piste du BMX Stadium. D’autres disciplines verront le jour pendant ces JO 2024. Le golf se déroulera sur le Golf National qui figure parmi les plus beaux parcours d’Europe et qui a accueilli la prestigieuse Rider Cup en 2018. Toutes ces disciplines représentées durant les JO mettent en avant le fruit de nombreux projets conduits sur plusieurs années.

 

Le pôle High-Tech francilien

 

Le terme High-Tech, anglicisme de Hautes Technologies, regroupe tout un panel d’initiatives scientifiques et économiques. Autour de lui tourne toutes les nouvelles technologies qui vont concerner l’informatique, internet, la haute définition et pleins d’autres innovations. 4D CONCEPT se situe actuellement dans ce pôle High-tech impulsé par la Région Ile-de-France. Notons que nous sommes entourés d’une zone regroupant de grands groupes moteurs dans les hautes technologies. De sorte que notre emplacement nous permet d’apporter notre expertise à de grandes entreprises telles que Thalès, Safran, ARQUUS ou encore Airbus. Leurs cœurs de métiers concernent divers secteurs dont l’aéronautique, le spatial et même la Défense. Ces industriels phare produisent de très grands volumes de documentation commerciale et technique. Nous sommes en capacités de leur apporter une aide favorable dans le développement de leurs projets afin de faciliter leurs méthodes de travail.

Chaque année plusieurs événements dédiés à ces secteurs d’activités sont organisés par le pôle francilien pour présenter leurs nouveautés. Parmi eux, le salon d’Eurosatory, initialement situé aux portes de Saint-Quentin-En-Yvelines, à Versailles Satory, regroupe tous les professionnels de l’industrie Défense et de la sécurité. Il nous permet de confirmer notre présence afin d’exposer nos produits dédiés à ces secteurs. D’autres grands salons nous offrent la possibilité de continuer de mettre en avant l’image de l’entreprise. Ainsi, le Salon International de l’Aéronautique et de l’Espace, familièrement appelé Salon du Bourget, nous permet également de convier tous nos clients autour de l’image d’un rêve universel, celui de pouvoir voler.

 

Le mot de la fin

 

Alors quoi de mieux que de faire confiance à une équipe moderne et doté d’un esprit d’entraide et à l’écoute de ses clients. Chez 4D CONCEPT, nous pensons que cette relation de confiance est essentielle afin d’évoluer sereinement et productivement. C’est un état d’esprit qui motive notre volonté de bien servir et bien conseiller, qualités que vous retrouvez dans notre accompagnement sur le choix du logiciel qui vous conviendra le mieux. Nous présenterons dans nos prochaines publications nos autres activités et implantations qui font la richesse de 4DCONCEPT.

Rédaction technique : Histoire et évolution de la discipline

rédaction technique s1000d

Évolution : de la documentation classique à la nouvelle ingénierie documentaire

La rédaction technique est une discipline à l’historique riche. Elle connaît depuis longtemps des avancées
techniques et technologiques surprenantes qui ont encadré son évolution dans le temps. Des prémices de la PAO jusqu’à la production documentaire
numérique à grande échelle, du langage GML, en passant par le SGML jusqu’au langage XML, découvrez l’histoire et les évolutions de la rédaction technique.

La genèse de la rédaction numérique

Il y a déjà longtemps que le besoin d’écrire et de faire transposer des idées, des actions, des récits, des ordres ou des lois
existe dans nos sociétés. L’idée de transcrire nos pensées, de transformer l’abstrait en quelque chose de concret grâce à l’expression écrite n’a cessé d’évoluer.
On rencontrait déjà ce phénomène au travers de l’écriture cunéiforme sur tablette d’argile, puis sur des supports plus souples comme le papyrus et le parchemin.
Plus tard, la méthode s’est adaptée au livre papier rédigé par les moines copistes et plus récemment produit par les imprimeries numériques de première génération.

Dans tous les cas, le sens et la mise en forme de l’image de l’écrit a toujours permis de donner un sens à l’information. La volonté de réaliser
une rédaction structurée se remarquait déjà par l’application d’un titre important qui apparaissait bien centré et plus gros que le reste du texte. De même, on organisait déjà les
principales parties des textes en les préfixant d’un introducteur tel que « Chapitre », « Partie » ou « Section ». Enfin, les idées étaient toujours séquencées et organisées selon
un numéro ou des puces permettant de classer et différencier les différentes informations au sein d’un même contenu.

Ces premières instructions de mise en page, que l’on nommait déjà de façon commune « feuille de style », donnaient du sens à l’information par la forme que l’on
appliquait aux mots. Cependant, la rédaction et la mise en forme restaient tout de même très pauvres en termes de diversité.

Cette méthode de production et de restitution de l’information était qualifiée par le terme « P.A.O » (Publication Assistée par Ordinateur).
Elle se focalisait plutôt sur la représentation de l’information que sur le sens réel de cette dernière. Ainsi, la réutilisation de l’information n’était pas vraiment la
priorité, même si les applications de composition avancée facilitaient le travail au moment de l’application des styles de mise en forme. À cette période, on vivait les
premiers balbutiements de la rédaction numérique et structurée par le balisage.

L’Authoring numérique

À l’aube de la rédaction dite « numérique », deux écoles existaient. Premièrement, celle du marquage de l’information en terme de représentation.
Secondement, l’école du marquage sémantique, bien que ce dernier ne fût pas si bien structuré que ce que nous connaissons aujourd’hui.

Ainsi, on distinguait d’un côté les applications orientées « présentation », qui proposaient une vue WYSIWYG de la production documentaire. Avec ce type de processus
What You See Is What You Get, on pouvait créer et visualiser une mise en forme identique à celle qui, ensuite, serait imprimée.

C’est alors que plusieurs solutions voient le jour dans les années 80. Massivement utilisées par les grands industriels, ces méthodes de rédaction numérique incluaient déjà
des notions d’homogénéité, de création automatique de document et de Framework, jetant ainsi les bases de la rédaction moderne. Nous pouvons notamment citer les logiciels Interleaf, Xerox Ventura Publisher
ou encore Frame Maker. Ces produits Adobe développés en 1995 ne pouvaient pas, pour la plupart, proposer des solutions permettant de travailler directement sur le format natif SGML/XML. Ainsi, des opérations
de conversion et de paramétrage à l’import et à l’export étaient toujours obligatoires pour optimiser la rédaction des contenus.

C’est pour cette raison qu’on distinguait une autre école, celle des applications à base de pur marquage. Cette solution permettait de mêler sémantique et instructions de composition.
À l’opposé de l’approche WYSIWYG, on initiait ainsi la notion de balisage et de rédaction structurée :

  • Le langage GML (1978 et prémisse du SGML) utilisé par IBM pour réaliser sa documentation axée sur le plan sémantique
  • Le langage TeX/LaTeX (1980/1983) utilisé pour rédiger de la documentation dans les domaines techniques et scientifiques.

La rédaction structurée

C’est ainsi que la révolution du monde documentaire structuré est apparue, en parallèle des deux approches précédentes. La rédaction structurée apporta dès lors une véritable notion de
structuration grâce à l’utilisation du langage SGML (Standard Generalized Markup Language) en 1986 (issue du langage GML). On pouvait désormais garder le contrôle d’une structure et la respecter à travers la DTD (Document Type Definition)
mais aussi séparer plus facilement la forme du fond (instance SGM versus feuille de style).

C’est à ce moment-là que certaines initiatives internationales s’engagent dans la spécialisation de ces DTD à un domaine particulier dans le monde documentaire civil et militaire. Désormais, on formalise
beaucoup mieux l’organisation du contenu et des échanges :

  • L’ATA avec la spécification ATA100 (1989) dans le monde aéronautique,
  • L’AECMA avec la spécification S1000D (1989) pour la documentation militaire qui aujourd’hui a élargie son utilisation à tous les domaines

Bien entendu, il existe d’autres initiatives visant une structuration de la rédaction technique, peut-être moins normalisées. Elles ont notamment vu le jour dans les domaines du juridique, du pharmaceutique et de l’automobile.

Au travers du format SGML, de nombreux outils ont offert des moyens de plus en plus avancés permettant de développer la rédaction structurée. Tournés vers le WYSIWYG, ces outils ont permis de démocratiser l’utilisation de
formats essentiellement codés et relativement complexes, réconciliant ainsi les deux écoles.

À cette période, on voit également apparaitre les prémices des moteurs de publication servant à générer des composition PDF, comme sur ArborText ADEPT*Editor, SoftQuad Author/Editor, et toujours Interleaf et Frame Maker dans des versions
évoluées traitant le SGML et le XML.

La dernière évolution qui a permis de vulgariser la rédaction technique et structurée tout en proposant une plus large offre d’application est apparue en même temps que l’expansion d’Internet. Il s’agit du langage XML (1998)
dont l’objectif était :

  • D’être plus explicite que SGML qui était assez permissif,
  • De simplifier la manipulation des instances par les applications (parseur, langage, éditeur, …),
  • D’être bien sûr compatible avec Internet.

La rédaction nouvelle génération

Avec le développement des applications numériques, et la standardisation du langage XML comme schéma de données, de nombreuses normes ont fait évoluer leur DTD dans ce sens. C’est le cas de la rédaction S1000D,
mais également de l’ATA, sans compter tous les standards de rédaction numérique qui sont apparus par la suite.

Grâce à cette évolution majeure, il est désormais possible d’offrir un nouvelle gamme d’outils de rédaction bien plus spécifiques et modernes. Ces outils, basés sur des technologies plus récentes et largement orientées vers le web,
constituent alors la pointe de la technologie, mais aussi l’avenir de l’informatique en matière de rédaction numérique au tournant des années 2000.

En 2013, c’est avec plus de maturité sur ces sujets que 4D Concept franchi le cap et s’engage dans le développement de la rédaction à son tour, en dévoilant une nouvelle solution de rédaction
moderne et ouverte, basée sur le standard XML S1000D. En effet, avec la spécialisation des standards de rédaction, il devient désormais plus aisé de concevoir des outils adaptés à l’un d’entre eux, avec une capacité à retranscrire parfaitement
la DTD de la norme qu’ils adressent.

Dans le domaine de la rédaction technique, plusieurs moyens et outil informatique sont mis à disposition de l’utilisateur, qu’il soit néophyte ou professionnel de la rédaction. Qu’il s’agisse de rédiger un article, une documentation,
une aide en ligne ou tout autre contenu, 4D Concept propose désormais à ses utilisateurs son module ADAM Author pour gérer simplement la rédaction des contenus techniques et structurés, toujours dans le respect des normes imposées.

4D Concept s’est ainsi attaché à penser tout ce qui pouvait faciliter le travail du rédacteur, notamment grâce à la mise à disposition toutes ces informations à porter de clic directement dans son environnement
de rédaction.

De plus, la norme S1000D, de par sa philosophie, s’y prête très bien à travers les éléments suivants :

  • Accès aux objets documentaires de la CSDB dans des widgets dédiés (Data module, Illustrations, Multimédia, …)
  • Accès aux divers référentiels issus des différents CIR (Common Information Repository)
  • Accès simplifié à des notions complexes comme la gestion de l’applicabilité à travers des assistants
  • Helper divers contextuels pour simplifier l’ajout d’éléments et de références

Selon 4D Concept, la rédaction structurée doit être accessible aux non-initiés sans forcément montrer, dans un premier temps, la pseudo-complexité du balisage. Elle doit ainsi proposer une
représentation du document à la mode « Word » en mettant à disposition le bon assistant pour aider et guider le rédacteur qui, au fur et à mesure, se familiarisera avec cette structure.

En effet, il semble difficile de rédiger suivant un contexte normatif sans acquérir une certaine connaissance de ce contexte, surtout si l’on veut en exploiter toutes les capacités (factorisation des informations, qualification correcte des données,
réutilisation, optimisation, gestion des impacts, …). C’est pourquoi il est primordial de faciliter le travail des rédacteurs avec des solutions Users Friendly

Cette considération était encore peu mise à l’honneur il y a seulement quelques années, mais les aspects économiques liés à la réduction des coûts de déploiement et de maintenance ont eu raison des solutions lourdes et souvent inaccessibles sans une
formation spécifique, occasionnant dépense et perte de temps.

Ces innovations en matière de simplification et d’accessibilité des outils de rédaction technique ne constituent en fait que la réponse logique de 4D Concept aux attentes des industriels et
surtout de leur DSI.

L’avenir de la rédaction technique

La rédaction technique se présente donc comme une discipline à mi-chemin entre l’écriture, les sciences des plus nobles et anciennes et les technologies les plus avancées. Les utilisateurs des solutions de rédaction ont
désormais de plus en plus l’habitude d’utiliser divers outils dans leur quotidien. Plus que de simples rédacteurs, ils s’orientent maintenant naturellement vers des logiciels et des solutions web exécutables via n’importe quel navigateur.

Ainsi, la prochaine étape dans l’évolution des solutions de rédaction structurée sera, sans aucun doute, l’ouverture à l’authoring web. L’objectif deviendra alors de disposer d’un outil de rédaction
structurée
, en ligne, accessible partout et tout le temps.

De plus, impossible d’omettre l’interaction rendue possible entre le contenu texte (rédigé par le rédacteur) et la maquette numérique (phase presque incontournable dans tout projet de conception d’un système), comme une des prochaines
évolutions majeures dans le domaine de la rédaction technique.

Précurseur dans ce domaine, 4D Concept a développé une intégration entre son outil de rédaction S1000D ADAM Author, et le logiciel de projection 3D Catia Composer de Dassault Systèmes : ADAM 3D Plugin. L’objectif est de créer une nouvelle dimension dans la documentation en y ajoutant des contenus issus directement de la maquette numérique du système documenté.

FOCUS : Formation S1000D

formation S1000D

Qu’est-ce que la S1000D ?

 

La fabrication d’un système dit complexe fait souvent intervenir de nombreux industriels contribuant à la fabrication de composants finalement assemblés par un systémier. On pense à l’Aéronautique, la Défense, le Spatial, le Nucléaire et d’autres.

La maintenance de ces systèmes, sur un cycle de vie pouvant dépasser régulièrement les 20 à 30 ans, est un enjeu majeur, tant sur le plan commercial que sur les aspects évidemment opérationnels. Ainsi, l’information et la connaissance technique que constitue la documentation de maintenance sont directement associées à la qualité et la durabilité, notions incontournables lorsqu’on parle d’un système complexe.

Le processus documentaire, qui relie l’ensemble des étapes de production d’une documentation de maintenance, est régi par des normes propres aux secteurs précités. Celles ci ont pour premier objectif de rationaliser ce processus, en structurant l’information technique de façon à en garantir la pertinence et l’employabilité.

La maintenance, métier à part entière, dispose de son standard documentaire, la spécification ASD S1000D, d’abord créée dans le but d’assurer une interopérabilité dans le secteur de la Défense européenne. D’autres standards propres au maintien en conditions opérationnelles la complètent, comme la S2000M (approvisionnement), la S3000L (soutien logistique), S4000P (maintenance programmée), où S5000F (retour d’expérience).

Schématiquement, la S1000D découpe le contenu, le rendant exploitable dans des documentations différentes et complémentaires : une action sur un élément est équivalente à un bloc d’information qui comprend la description de l’élément en question, la description de l’action, le matériel nécessaire, les consommables nécessaires s’il y a lieu. On place toutes ces informations dans un tableau à plusieurs entrées qui forme le schéma du fonds documentaire, où chaque case formera un bloc d’information appelé Data Module, réutilisable dans plusieurs publications avec un agencement différent.

Le standard documentaire a également pour mission de rendre simple ce qui est complexe pour garantir la clarté de l’information, et supprimer tout risque ou besoin d’interprétation par les opérateurs de maintenance. De fait, l’objectif est de réduire les marges d’erreur, et d’augmenter la sécurité et la durée de vie des systèmes.

 

Pourquoi rédiger en S1000D ?

 

Il est primordial de préciser que malgré tous les avantages que présente un standard documentaire comme la S1000D, il apporte son lot de contraintes. Cette norme est avant tout propre à certains secteurs d’activités et sa mise en œuvre peut s’avérer complexe au départ.

 

Mais ce constat fait, il ne faut pas pour autant en oublier les avantages, qui pourraient bien faire basculer ceux qui n’en auraient pourtant pas l’obligation.

 

En effet, la S1000D impose un certain nombre de règles, mais elle harmonise les processus. Elle est de fait spécifique au métier de la maintenance, mais justement, elle le fait parfaitement. Sa structure autorise la modification et la mise à jour des contenus, sans pour autant impacter l’ensemble. La S1000D s’appuie sur un schéma de données libre, XML. Ce format octroie une grande liberté d’utilisation, favorisant le développement web et la publication cross-média. Rédiger en XML est aussi un excellent moyen de rendre la création plus participative, en utilisant les outils adaptés.

Enfin, rédiger sa documentation en S1000D, c’est aussi garantir à ses clients un accès pertinent et efficace à l’information technique. Sa qualité constituera sans nul doute un facteur différenciant, et son maintien à jour un excellent élément de relation client.

 

Pourquoi suivre une formation S1000D ?

 

Après avoir chanté les louanges de la S1000D, simplifiant la documentation de maintenance, nous devons nous pencher sur sa mise en œuvre, qui est moins immédiate.

La mise en place d’un projet S1000D répond au besoin clair d’une approche structurée de la documentation technique, par opposition à la documentation traditionnelle, souvent ingérable dans un contexte global. L’acquisition des connaissances nécessaires demande un accompagnement complet et précis, dispensé par des professionnels expérimentés. Se former est donc un prérequis incontournable.

Par ailleurs, même pour des personnes déjà formées, le maintien à jour des connaissances liées aux évolutions techniques du « marché » de la documentation permet aux entreprises de s’assurer des ressources expertes en capacité de piloter les projets et évangéliser leurs équipes en interne.

 

Pourquoi se former avec 4D CONCEPT ?

 

4D CONCEPT est avant tout un expert de la documentation technique en standards documentaires S1000D, ATA ou DITA. Avant de partager leur savoir, nos formateurs sont des consultants qui utilisent au quotidien ces normes, qu’ils pratiquent pour le compte de grands groupes les utilisant (Airbus, Naval Group, Safran, Thales etc.).

Ils sont tous opérationnels dans l’accompagnement de nos clients à la mise en place de fonds documentaires et de projets de documentation structurée en environnement normé.

Ainsi, se former auprès de 4D CONCEPT est la garantie d’avoir les réponses à toutes les problématiques liées à vos projets de documentations techniques, en plus de bénéficier d’un accompagnement au-delà des sessions de formation.

 

Enfin, 4D CONCEPT est l’éditeur de la suite logiciel ADAM, référence dans le domaine de l’édition S1000D.

Quel est le contenu de la formation ?

 

Afin d’être la plus exhaustive possible, la formation a une durée de trois jours, et alterne principes et exercices pratiques. Notre but est de rendre nos stagiaires opérationnels en leur donnant le maximum des « indispensables » pour piloter un projet de documentation structuré en standard S1000D. Ainsi, les différents concepts (modularité, applicabilité, CIR, publication, etc.) sont mis en pratique pour en garantir la meilleure assimilation possible.

Le programme de formation s’étend des fondamentaux, comme les principes du XML, jusqu’à la rédaction de Data Modules et la mise en œuvre d’une CSDB (Common Source Data Base) normée. Enfin, nos formateurs adaptent la formation aux attentes et problématiques propres à chaque stagiaire, afin de répondre aux spécificités de leurs entreprises.

 

DÉCOUVRIR LE PROGRAMME DE CETTE FORMATION

DITA ou S1000D … Et s’il faut choisir ?

Vous en avez probablement déjà entendu parler, vous vous êtes renseigné∙e sur le sujet : DITA ou S1000D sont des standards rédactionnels rationalisés, qui permettent de mieux gérer la production et la diffusion de publications techniques : manuels d’utilisation, de maintenance, de formation, offres techniques…

Plus précisément, utiliser ces standards permet, si votre production documentaire s’y prête, de :

  • Augmenter très fortement la qualité perçue
  • Réduire drastiquement les coûts de mise à jour
  • Diminuer les coûts de traduction
  • Diffuser vos publications facilement sur différents canaux ou médias : papier (et PDF à télécharger), web et applications mobiles.

 

DITA ou S1000D, comment ça marche ?

 

DITA et S1000D sont tous deux basés sur XML, un format « texte » d’enregistrement des données, non‑propriétaire, et universellement utilisé notamment parce qu’il accepte tous les alphabets (européens, asiatiques) et facilite les échanges à l’échelle mondiale.

En outre, tant S1000D que DITA utilisent un format de rédaction « modulaire » : les documents sont constitués par assemblage d’unités documentaires « réutilisables » dans différents contextes de publication. Les unités documentaires sont réutilisées notamment en cas de commonalité technique (produits eux-mêmes modulaires), d’aspects transversaux (sécurité, juridique, concepts, méthodes…), de données partagées (interfaces, emplacements, pièces de rechange…), etc.

Pour chaque module et au sein des modules, un mécanisme d’applicabilité permet de gérer les aspects variables selon le contexte de diffusion : marques multiples, particularités au sein des gammes, spécificités clients, etc.

La granularité des modules documentaires, alliée à une discipline d’écriture indispensable, permettent les économies d’échelle citées et l’augmentation de qualité. La diffusion multi-canal, en bout de processus, nécessite une bonne maîtrise des formats de diffusion, notamment pour la génération de PDF ; la conversion au format web (HTML) ou en App destinée aux téléphones et tablettes est relativement simple à partir du XML, mais la question de l’ergonomie reste centrale.

 

Alors, DITA ou S1000D ?

 

La réponse est relativement simple.

S1000D est une spécification très précise quant aux données à utiliser et aux processus à mettre en œuvre, dans le contexte de l’exploitation d’équipements essentiellement mécaniques, électriques ou électroniques.

Ce sont certains secteurs industriels qui imposent d’utiliser S1000D, afin d’assurer l’interopérabilité des informations entre différentes entités ayant un rôle dans l’exploitation, le soutien logistique et jusqu’au transport des équipements. Ces secteurs sont la Défense (Air, Mer, Terre), l’Aéronautique civile partiellement, ainsi que le Ferroviaire ou le Nucléaire, par exemple. Tous exploitent des équipements à très longue durée de vie, dont les modifications et évolutions doivent être suivies très précisément.

Pour cela, S1000D impose salutairement de respecter un découpage matériel précis des équipements, ainsi qu’une nomenclature des procédures, agréés internationalement.

On notera que S1000D est d’un abord assez complexe, pour répondre à l’ensemble des problématiques des domaines concernés, et souffre d’un manque de souplesse certain, même si quelques paramètres sont ajustables.

S1000D n’inclut pas d’outils standards de génération des publications, et ne permet pas, par exemple, de documenter efficacement des logiciels et interfaces, car sa modularité n’est pas assez fine.

DITA, de son côté, est une boîte à outils plutôt qu’une spécification. Elle inclut des outils standard à l’état de l’art, répondant à une très grande majorité de cas. DITA permet de publier, et est issue d’un consensus de spécialistes de la documentation post-web, contrairement à S1000D qui est plus ancienne.

En soit, le standard DITA laisse l’utilisateur relativement « sans aide », par rapport à S1000D, ce qui peut inquiéter (à tort). Mais en contrepartie, DITA possède une très grande souplesse de structuration : DITA permettrait de « reconstruire » et imiter entièrement le standard S1000D, si c’était nécessaire.

Plus simplement, DITA permet de constituer le système documentaire dont vous avez besoin, car il s’adapte à peu près à tout, par construction : DITA est conçu comme un système évolutif qui conserve son interopérabilité tout en permettant la personnalisation.

Si vos produits et processus sont simples, DITA sera simple. Sinon, DITA s’adaptera « juste assez » pour satisfaire vos besoins de façon efficace.

 

De la nécessité de bons outils et d’un accompagnement

 

Un projet de documentation modulaire, qu’il soit S1000D ou DITA, peut mettre en œuvre 500, 1500 ou 5000 unités documentaires. L’ensemble des unités documentaires d’une entreprise industrielle ou logicielle peut se compter en dizaines voire centaines de milliers d’unités.

Pour gérer les versions dans le temps, les langues et les liens dans cette masse d’information, un CCMS (Component Content Management System), à l’image de ADAM ou DITA FACTORY, est rapidement nécessaire, dès lors que le nombre d’unités documentaires atteint quelques milliers.

Vous serez d’autant plus efficace que l’outil permettra de « coller » à vos propres processus de production et de diffusion d’information, de s’adapter à vos formats de données, et de s’interfacer à vos systèmes existants de gestion d’information.

De part la complexité de S1000D, et la liberté qu’offre DITA, vous vous adjoindrez avantageusement les services d’accompagnement et de formation de spécialistes de ces standards, pour démarrer vos projets S1000D ou permettre le virage de votre entreprise vers le digital.

L’ingénierie documentaire : qu’est-ce que c’est ?

Évolution : de la documentation classique à la nouvelle ingénierie documentaire

Auparavant, la documentation était un manuel fourni obligatoirement à la livraison de l’équipement. Mais aujourd’hui, son format évolue. L’ingénierie documentaire est pensée principalement de manière électronique. Elle devient, de ce fait, accessible sur Internet et permet de s’adapter facilement aux différents supports sur lesquels on souhaite la diffuser. L’ingénierie documentaire garantie aujourd’hui une plus grande interactivité avec le client final. L’utilisateur du produit accède plus facilement à l’information par des requêtes et des filtres dynamiques. On peut désormais affirmer que demain, la documentation intégrera de nouvelles technologies comme le machine learning ou la réalité virtuelle. Ainsi, les services après-vente des entreprises doivent déjà anticiper et s’adapter à ces évolutions. Il devient donc essentiel de repenser chaque processus de production documentaire afin de mettre en avant une nouvelle ingénierie permettant d’améliorer sa qualité, de faciliter son usage et d’envisager l’apport de nouveaux formats de contenus comme la 3D ou la vidéo.

Ingénierie documentaire, un contexte structuré

Le processus de création documentaire est encadré par un ensemble de règles, appelées « spécification ». Cette spécification est déterminée en amont par un service interne à l’entreprise ou par un organisme international. Dans le domaine aéronautique, par exemple, certaines normes sont très répandues telles que l’ATA, la S1000D ou encore la DITA.  L’ingénierie documentaire régissant ces normes permet de fournir, à minima, une structure pour la documentation de l’entreprise. Mais elle apporte aussi des règles de rédaction, d’échange ainsi qu’un cadre adapté de mise en page.

Pour les contenus textuels, il est toujours conseillé de privilégier le format XML. La structure est fournie sous forme de fichier de type Doctype (DTD) ou XML Schema (XSD). Tandis que pour les autres formats, comme la vidéo ou les images, la spécification de l’ingénierie documentaire impose les règles à suivre.

Outre la structure, l’ingénierie documentaire et sa spécification permettent également de contrôler la façon dont le fond documentaire est rédigé.

Par exemple, la norme S1000D fournit un format d’échange pour ces règles appelé le BREX (Business Rules Exchange). Ces règles de rédaction vont permettre de rationaliser certains processus comme le nombre d’étapes dans une procédure de démontage d’un bien industriel (par exemple).

Une autre norme appelée ASD-STE100 (Simplified Technical English) contrôle l’usage du lexique anglais dans la rédaction des procédures techniques. Ainsi, cette norme interdira l’usage du verbe « place » au profit du verbe « put » afin d’assurer l’homogénéité et la bonne logique du contenu.

L’ingénierie documentaire permet aussi de développer des normes destinées à contraindre le contenu des graphiques afin d’en garantir leur bon fonctionnement dans les outils de visualisation. C’est, par exemple, le cas de la norme WebCGM , co-produite par les groupes W3C et OASIS. Cette règle permet de restreindre l’usage des graphiques au format CGM. Ce dernier étant un format modifiable librement et gratuitement, il est indispensable de limiter l’usage de ces contenus.

Malgré cet arsenal de normes, les industriels ajoutent souvent leurs propres règles pour renforcer le contrôle de leur ingénierie documentaire. Au final, lorsqu’un industriel livre un matériel pour un client, il reste toujours libre de choisir la norme qu’il souhaite suivre et qui convient le mieux à son activité. En revanche, un équipementier, qui doit livrer plusieurs industriels sera contraint de livrer sa documentation technique dans le respect de la norme choisie par ses clients.

Grâce à l’ingénierie documentaire, chaque industriel peut définir les règles qui lui correspondent avant de passer à la production de sa documentation technique.

Le processus de production documentaire

Le déclencheur

Plusieurs événements peuvent déclencher le processus. Il peut s’agir de créer une documentation pour un nouvel équipement ou d’intégrer une modification émanant d’un organisme tiers (bureau d’étude, chaîne de montage, autorité …) dans une documentation existante.

La collecte des données sources et l’analyse d’impact

La première étape du processus d’ingénierie documentaire consiste à récupérer l’ensemble des documents associés à la modification (plan, données 3D, analyse logistique, gamme de montage, photos..) et d’analyser quels sont les éléments de la documentation impactés par cette modification.

Cette étape permet de planifier la rédaction de la documentation technique, de définir les dates de livraison et d’attribuer les tâches aux personnes en charge de rédiger les contenus. Par exemple, le système de gestion de contenu dédié à l’ingénierie documentaire de 4D Concept appelé  ADAM Manager permet de créer de manière optimale une liste de documents vides et de les assigner à un rédacteur spécifique.

La rédaction

Afin de faciliter le travail de la rédaction, cette dernière doit se faire, de préférence, dans un environnement contraint. À cet égard, un bon outil permet d’intégrer des contrôles techniques ou métier. Si le rédacteur ne bénéficie pas d’un bon environnement et d’un cadre, il doit alors se référer à un guide de rédaction. De cette façon, les risques d’erreur sont nécessairement augmentés.

Il est donc toujours préférable d’utiliser un bon outil de rédaction. Celui-ci doit être facile à utiliser et doit guider le rédacteur dans son travail, sans pour autant le bloquer ou modifier le contenu à sa place. Si le besoin s’en fait ressentir, le rédacteur peut aussi préparer des maquettes d’illustration. Un illustrateur pourra ensuite s’appuyer sur ces maquettes afin de concevoir les graphiques dans un outil de dessin technique (2D ou 3D), respectant les normes du projet initial, et compléter ainsi la documentation finale de façon optimale.

Dans la production de contenus et de normes techniques, toute modification effectuée sur un document existant doit être tracée. Ce processus d’ingénierie documentaire assure ainsi la possibilité de revenir en arrière, de connaître les modifications passées et les auteurs de ces modifications. De même, si le rédacteur écrit des parties communes à différents matériels, il doit être en mesure d’attribuer les contenus aux équipements concernés depuis son outil d’édition. Le but est toujours d’éviter la redondance de l’information et de réduire les risques d’incohérence lorsque la documentation est distribuée aux différents utilisateurs.

La preview

Avant la validation finale de la documentation technique, une vérification, aussi appelée « preview », est effectuée pour s’assurer que le rendu corresponde bien aux contenus rédigés précédemment. Le document rédigé est ainsi traité en passant par les mêmes étapes que celles effectuées lors de la publication finale. Grâce à la suite ADAM, cette étape de preview du processus d’ingénierie documentaire se réalise rapidement et facilement et peut être lancée par le rédacteur à n’importe quel moment de la rédaction depuis l’outil ADAM Author.

La validation

Une fois l’étape de preview effectuée, la validation de la production documentaire s’effectue en plusieurs étapes afin de toujours s’assurer que chaque document respecte la procédure en place :

  • Une étape de relecture est nécessaire pour détecter d’éventuelles erreurs dans la première version du document.
  • Une étape de validation automatisée, réalisable grâce à l’outil ADAM Data Checker, réduit les risques de non-qualité en intégrant des contrôles informatiques.
  • Enfin, pour certaines procédures, une validation en conditions réelles sur l’équipement doit être effectuée.

La publication

Une fois la documentation validée, elle sera alors publiée puis livrée au client final.

Au moment de cette étape, il devient obligatoire de tracer précisément le contenu livré au client.

Par exemple, il faudra, à cette étape de processus d’ingénierie documentaire, lister les documents envoyés et répertorier les différences apportées à chaque nouvelle version d’un document.

Une fois livré, un document ne peut plus être modifié. Dans le cas contraire, chaque modification nécessite de livrer une nouvelle version, ce qui déclenche un nouveau cycle de création documentaire encadré par la spécification en vigueur. La production documentaire peut être livrée au format de documentation papier (PDF) ou électronique (visualiseur). Le client peut aussi demander les fichiers bruts (graphiques et textuels), s’il souhaite les intégrer dans une nouvelle chaîne de traitement.

Ingénierie documentaire : la nécessité de s’outiller

La volonté de produire une documentation plus interactive, avec toujours plus de service, pousse les producteurs de documentation technique vers une information plus structurée, plus modulaire, mais aussi plus complexe.

De ce fait, il est quasiment impossible de gérer un processus d’ingénierie documentaire sans :

  • un atelier de rédaction guidée ;
  • un gestionnaire de contenu (CMS) avec un suivi des flux de publication ;
  • un outil de contrôle des documents ;
  • un outil de publication doté de fonction de filtrage.

Cest toujours avec cette volonté et dans cet esprit que 4D Concept développe la suite ADAM , spécialisée dans la gestion de contenu et l’ingénierie documentaire, afin daccompagner au mieux le processus de production documentaire à chaque étape de sa création et de sa validation.