En interne
Les rédacteurs techniques travaillent dans un traitement de texte, un outil DITA ou un système S1000D.
Glossaire
Qu’est-ce que la documentation technique ?
Les documents qui expliquent comment un produit fonctionne, et comment l’installer, l’utiliser, l’entretenir, le réparer et le fabriquer.
Tout au long de la vie d’un produit.
Certains documents restent chez le fabricant. Les autres accompagnent le produit.
La documentation technique tout au long de la vie du produit
-
Concevoir et fabriquer
- Plans et modèles 3D
- Nomenclature
- Modes opératoires
- Instructions de travail
-
Prouver la conformité
- Dossier technique
- Appréciation des risques
- Déclaration UE de conformité
-
Installer et utiliser
- Manuel d’installation
- Notice d’utilisation ou manuel opérateur
- Guide de démarrage rapide
- Consignes de sécurité
-
Entretenir et réparer
- Manuel de maintenance
- Guide de dépannage
- Catalogue illustré de pièces détachées
- Bulletins de service
-
Former
- Formations
- Aide-mémoire au poste
- Animations et vues 3D
En droit européen, un sens plus étroit.
Le dossier qu’un fabricant conserve pour prouver la conformité d’un produit. Ce dossier est destiné aux autorités, pas aux utilisateurs.
Plus de détails
Dans la réglementation européenne des produits, le terme a aussi un sens plus étroit : le dossier qu’un fabricant conserve pour prouver la conformité de son produit, avec ses données de conception, son appréciation des risques et ses rapports d’essais. Pour les machines, l’annexe IV du règlement machines en fixe le contenu.
Les principaux types. Et qui les lit.
| Document | Lecteur | Ce qu’il couvre |
|---|---|---|
| Notice d’utilisation ou manuel opérateur (notice d’instructions) | Opérateurs et utilisateurs finaux | Usage prévu, commandes, utilisation en sécurité, nettoyage et pannes simples |
| Manuel d’installation | Installateurs et intégrateurs | Transport, levage, montage, raccordement et mise en service |
| Manuel de maintenance et de réparation | Techniciens de maintenance | Inspections et périodicités, dépose et repose, réglages et essais |
| Instructions de travail | Opérateurs et monteurs | Comment réaliser une tâche, étape par étape, au poste de travail |
| Catalogue illustré de pièces détachées | Techniciens et acheteurs de pièces de rechange | Vues éclatées et listes de pièces pour identifier et commander les pièces |
| Supports de formation | Stagiaires et formateurs | Cours, exercices et animations construits sur la documentation |
| Dossier technique | Le fabricant et les autorités | Données de conception, appréciation des risques et rapports d’essais qui prouvent la conformité |
Les normes qui l’encadrent.
- IEC/IEEE 82079-1:2019 Élaboration des informations d’utilisation (instructions d’utilisation) des produits. La norme internationale générale des instructions, du contenu et de la structure jusqu’à la rédaction et à la présentation.
- ISO 20607:2019 Les principes rédactionnels du manuel d’instructions des machines.
- S1000D La spécification internationale des publications techniques modulaires de l’aéronautique et de la défense, fondée sur des modules de données XML. Qu’est-ce que la S1000D ?
- ASD-STE100 Simplified Technical English Une langue contrôlée, avec un dictionnaire et des règles d’écriture qui rendent sans ambiguïté les textes de maintenance rédigés en anglais. Le numéro 9 est paru en janvier 2025.
- ATA iSpec 2200 La norme qu’emploient compagnies aériennes et constructeurs d’aéronefs pour la documentation de maintenance.
- DITA Une norme XML de l’OASIS pour la documentation par sujets (topics), courante dans le logiciel et l’électronique.
- Réglementation des produits Dans l’UE, le règlement machines (UE) 2023/1230 et d’autres textes fixent ce que doivent contenir les instructions, et dans quelle langue.
À quoi ressemble une bonne page de manuel.
Un en-tête de tâche, un avertissement, une figure, les outils et les pièces, puis les étapes.
- 1En-tête de tâche : numéro, titre, applicabilité, outils et logiciel
- 2Consigne de sécurité, avant la première étape
- 3Figure rendue à partir du modèle 3D, avec les repères
- 4Tableau des outils et des pièces, avec les quantités
- 5Étapes de dépose et de repose numérotées, avec une mise en garde là où il le faut
- 6Pied de page avec le numéro du document, l’indice et la date
- Écrite pour la tâche du lecteur, et non selon la structure du produit.
- Une action par étape, à l’impératif ou à l’infinitif, avec un visuel pour chaque étape.
- Des avertissements placés avant l’étape qu’ils concernent.
- Le même terme pour la même chose, idéalement tiré d’un vocabulaire contrôlé.
- Une seule version approuvée et à jour, facile à trouver là où le travail se fait.
- Mise à jour à chaque modification technique.
En interne, en prestation ou avec un logiciel.
En prestation
TwinWorks rédige manuels d’installation, d’utilisation et de maintenance, procédures et catalogues illustrés de pièces détachées à partir de vos sources d’ingénierie et d’entretiens avec vos experts, qui approuvent le résultat.
Voir les services de rédaction techniqueAvec un logiciel
TwinWorks est un logiciel de publications techniques assisté par l’IA qui prépare des brouillons prêts à relire à partir de manuels liés et de données d’ingénierie analysées ; les experts modifient, relisent, approuvent, versionnent et publient une documentation web et PDF.
Voir le logiciel de publications techniquesQuestions
Qu’est-ce que la documentation technique ?
La documentation technique est l’ensemble des documents qui expliquent comment fonctionne un produit et comment l’installer, l’utiliser, l’entretenir, le réparer et le fabriquer : notices d’utilisation et manuels opérateur, manuels d’installation, manuels de maintenance, instructions de travail, catalogues de pièces et supports de formation. Des rédacteurs techniques la produisent à partir des données d’ingénierie et du savoir des experts, et pour de nombreux produits, la loi l’exige, par exemple le règlement machines européen.
Quels sont les types de documentation technique ?
Les principaux types sont les notices d’utilisation et manuels opérateur, les manuels d’installation, les manuels de maintenance et de réparation, les instructions de travail, les catalogues illustrés de pièces détachées, les guides de dépannage et les supports de formation, sans oublier le dossier technique interne qui prouve la conformité du produit.
Quelle différence entre documentation technique et documentation utilisateur ?
La documentation utilisateur est la partie de la documentation technique écrite pour les utilisateurs finaux, comme la notice d’utilisation et le guide de démarrage rapide. La documentation technique couvre aussi les documents destinés aux installateurs, aux techniciens de maintenance, à la production et aux autorités.
Quelle norme s’applique aux instructions d’utilisation ?
L’IEC/IEEE 82079-1 est la norme internationale générale pour les instructions d’utilisation des produits. Des règles sectorielles la complètent, comme la S1000D et l’ATA iSpec 2200 dans l’aéronautique, et des textes comme le règlement machines européen fixent ce que les instructions doivent contenir.
Qui rédige la documentation technique ?
Des rédacteurs techniques, avec les ingénieurs et les experts terrain qui fournissent et vérifient les informations. Beaucoup de fabricants confient aussi une partie du travail à des prestataires de rédaction technique.
Partez d’une structure éprouvée
Des modèles gratuits de notice d’utilisation, de mode opératoire, d’instruction de travail, de notice de montage et de nomenclature, prêts à remplir.
Mis à jour