Worldlex Wiki La documentation technique est un terme générique désignant les classes d' informations créées pour décrire (en langage technique ) l'utilisation, la fonctionnalité ou l'architecture d'un produit, d'un système ou d'un service.
Classes de documentation technique
Les classes de documentation technique peuvent inclure :
- brevets
- spécifications de l'article ou des composants/matériaux
- fiches techniques d'articles ou de composants/matériaux
- méthodes d'essai
- normes de fabrication
- Configuration requise
- architecture du système
- documents et données de conception du système , y compris ceux nécessaires au développement, aux tests, à la fabrication, à l'exploitation et à la maintenance du système
Normalisation de la documentation technique
Historiquement, la plupart des catégories de documentation technique manquaient de conformité universelle (normes) en termes de format, de contenu et de structure. Des normes sont en cours d'élaboration pour remédier à cette situation par l'intermédiaire d'organismes tels que l' Organisation internationale de normalisation (ISO), qui a publié des normes relatives aux règles de préparation des guides d'utilisation, des manuels, des spécifications de produits, etc. pour la documentation technique des produits. Ces normes sont couvertes par l'ICS 01.110. La documentation technique des produits non couverte par l'ICS 01.110 est répertoriée dans la sous-section ci-dessous.
Spécifique à la discipline
Règlement de l'UE sur les dispositifs médicaux
Une documentation technique est également requise pour les dispositifs médicaux conformément au règlement de l'UE sur les dispositifs médicaux . L'annexe II, Documentation technique, et l'annexe III, Documentation technique relative à la surveillance après commercialisation, du règlement décrivent le contenu d'une documentation technique pour un dispositif médical . Cela comprend par exemple des informations sur les spécifications, l'étiquetage et les instructions du dispositif, la conception et la fabrication, les exigences de sécurité et de performance, la gestion des risques, la validation et la vérification du dispositif, y compris l'évaluation clinique, ainsi que des informations issues de la surveillance après commercialisation .
Formats pour les données sources
Architecture et typage de la documentation
Certains systèmes de documentation s'intéressent aux types ou formes globaux de documentation qui constituent un ensemble de documentation, ainsi qu'à la manière dont la documentation est produite, publiée ou formatée (ou plutôt à la manière dont elle est mise en forme).
Par exemple, le cadre Diátaxis (qui est principalement utilisé dans le domaine de la documentation logicielle ) propose quatre formes de documentation distinctes, correspondant à quatre besoins utilisateurs différents : tutoriels , guides pratiques , référence et explication . En revanche, DITA propose cinq « types de sujets » différents : Tâche , Concept , Référence , Entrée de glossaire et Dépannage , tandis que le système de documentation modulaire de RedHat utilise trois « modules » : Concept , Procédure et Référence .