Quels sont les composants d’une solution complète de documentation technique ?
Les solutions de documentation technique IETM / IETP sont complexes et possèdent des caractéristiques applicables à des tâches spécifiques liées à la gestion de l’information. Elles peuvent comporter plusieurs composants, chacun ayant un objectif unique qui répond aux exigences de l’écosystème du flux de travail de l’industrie aéronautique. Une application de visualisation se consacre à l’affichage du contenu informationnel et aide à sa manipulation grâce à l’utilisation des outils qu’elle contient. Un portail libre-service concerne principalement l’accès et l’autorisation de visualiser des données, permettant aux utilisateurs disposant des droits appropriés de consommer des informations par le biais d’un visualiseur IETM / IETP. Mais d’où vient ce contenu organisé et ces informations ?
Une application est nécessaire pour créer et gérer les masses de données nécessaires à l’exécution des tâches dans le domaine de l’aviation. Les portails web sont le point d’accès habituel à ces applications, mais l’accès n’est pas limité à ce seul support. Ces applications puissantes sont conçues pour maintenir la cohérence et l’alignement de toutes les données utilisées. Elles sont également très utiles pour la mise en œuvre de certaines normes de structuration de l’information, comme la norme S1000D, par exemple. La norme S1000D exige que les données possèdent certaines caractéristiques qui permettent leur réutilisation, leur mise à jour et leur modification tout en respectant les réglementations. Le composant est appelé éditeur ou, comme dans la suite NIVOMAX Builder
Quelle est la fonction d’un Builder ?
Le constructeur, en termes simples, est le créateur, par rapport aux autres composants d’une suite de documentation technique. Les données consommées par les acteurs de l’aviation sont souvent rédigées en XML (Extensible MarkUp Language), en particulier dans les organisations qui utilisent une norme ou une spécification S1000D. Les informations doivent être structurées de manière à inclure des attributs tels que le codage UTF, la version, le statut de l’information (c’est-à-dire nouvelle, révisée, inchangée) et à inclure diverses dénotations de taxonomie, de titres, de notes d’applicabilité, etc. Ces détails permettent au concepteur de reconnaître les caractéristiques des données et d’appliquer facilement des changements ou des modifications pour une structuration organisationnelle et une utilisation optimales.
Avec l’information en format XML, les constructeurs sont le composant clé qui convertit ce contenu XML chargé de données en un format HTML, qui peut être facilement consommé par les utilisateurs qui consultent une application de visualisation IETM / IETP, rendue par un navigateur web. Alors que le XML définit le contenu, par le biais de balises, une autre partie, les métadonnées, est également convertie. Les métadonnées sont les « éléments internes » des données, qui permettent aux moteurs de recherche de trouver les informations spécifiquement demandées. Les feuilles de style constituent la dernière partie, qui permet à l’information d’être affichée sur les différents appareils que les gens utilisent pour la visualiser. Dans la norme S1000D, pour que les données soient conformes à la directive sur les spécifications, tous les éléments ci-dessus et d’autres encore doivent être exécutés. Ils forment un élément de base de la norme S1000D appelé schéma, un petit ensemble d’éléments qui répondent à un objectif spécifique et auxquels on attribue un nom.
La documentation technique doit également être transformée. Pour être affichées efficacement dans une application de visualisation IETM / IETP, les données doivent passer par un autre processus. Pour que le contenu soit bien organisé, en particulier lors de l’application d’une norme ou d’une spécification S100D, les informations doivent être indexées, en indiquant les chapitres et les sections de la publication ou du manuel. Elles doivent également être validées, afin de s’assurer qu’elles contiennent tous les éléments nécessaires à leur structure. Ces éléments requis peuvent être des graphiques ou des tableaux, qui ont leur propre processus d’incorporation dans le contenu final avant l’indexation et la validation.
Que vous apportent tous ces détails ?
La capacité de l’application Builder à autoriser des éléments aussi granulaires dans son contenu a un but précis. La documentation technique utilisée par le biais d’un IETM / IETP est destinée à être, en tant que norme commerciale, réutilisée et maintenue dans un état actuel. Cela signifie qu’elle contient les dernières informations disponibles, que ce soit en matière de sécurité ou d’autres réglementations procédurales. Le composant Builder permet aux entreprises de créer des bibliothèques virtuelles, qui peuvent être organisées selon une norme qui s’adapte et adhère aux besoins internes et à divers paramètres de conformité. La norme S1000D a été créée exactement dans ce but, et de nombreuses organisations l’utilisent, ou utilisent des méthodes correspondant à sa structure unique, pour optimiser la gestion de l’information.
Par exemple, un auteur peut créer une documentation technique sur la maintenance des trains d’atterrissage, pour laquelle une mise à jour critique est nécessaire. Il peut y avoir plusieurs modèles d’avions qui possèdent le même type de pièces contenues dans des manuels répartis dans différentes bibliothèques virtuelles. L’application Builder permet d’aligner toutes les informations relatives à un train d’atterrissage spécifique afin de les mettre à jour et de les harmoniser dans l’ensemble de la structure de la bibliothèque virtuelle à laquelle tout utilisateur peut accéder via le visualiseur IETM / IETP. Inversement, les données erronées peuvent être supprimées ou ramenées à une autre version si nécessaire, en s’alignant dans chaque bibliothèque qui contient le contenu mis à jour ou supprimé. Grâce à cette méthode, la conformité et l’unification des données peuvent être assurées pour une mise en œuvre sûre et concise dans tous les flux de travail, ce qui permet d’éviter les erreurs et les dangers.
Approche de vos exigences en matière d’information
Les composants IETM / IETP ont une grande valeur lorsqu’ils sont utilisés correctement. La mise en œuvre d’une norme ou d’une spécification S1000D est une entreprise qui nécessite une planification et, bien sûr, un partenaire compétent pour vous guider dans la mise en œuvre de l’application ou des applications. Votre capacité à créer, visualiser et accéder à ces composants nécessite une réflexion préalable afin de mettre en place une stratégie qui réponde aux besoins les plus intrinsèques de l’entreprise. Le NIVOMAX Builder et ses composants complémentaires ont la capacité de répondre aux besoins des entreprises du secteur de l’aviation. Si vous avez des questions, n’hésitez pas à nous contacter et à demander une démonstration de nos produits.