Bibliographie & annexes
Présentation
En anglais
RÉSUMÉ
Beaucoup d'organisations proposent de nombreux documents. Cette production mobilise beaucoup de ressources, tout au long du cycle de vie des produits ou des projets. Les outils de production sont les suites bureautiques traditionnelles et la méthodologie, le copier-coller, les échanges par mail et le stockage sur un disque partagé ou dans un outil de gestion documentaire. Malgré le peu d'efficacité, la recherche d'alternatives reste rare. La rédaction structurée propose des outils proches des outils de CAO ou des PLM. Dans les deux cas, les livrables sont des assemblages, utilisant des composants standards ou spécifiques. Ces livrables peuvent être gérés via des règles de configuration.
Lire cet article issu d'une ressource documentaire complète, actualisée et validée par des comités scientifiques.
Lire l’articleABSTRACT
Many organisations propose a lot of documents. This production consumes many resources, all along the lifecycle of products or projects. Editing tools are traditional office suites and the methodology is based on copy-paste, exchanges by e-mail and storage on shared drive or document management tool. Despite the low efficiency, searching for alternatives remains unusual. Structured writing offers tools close to CAD or PLM. In both cases, deliverables are assemblies, based on standards or specific components. Those deliverables can also be managed through rules of configuration.
Auteur(s)
-
Florimond ALEMPS : Responsable de projets industriels - Société NeoDoc, Venelles, France
INTRODUCTION
Le poids économique de la documentation
De nombreuses entreprises investissent pour réduire leurs coûts de production.
La documentation fait partie du produit (selon la directive Machines (2006/42/CE) et pourtant, elle ne bénéficie pas de la même attention – notamment en France. Produire la documentation mobilise d’importantes ressources (humaines). Toute montée en charge est directement dépendante du recrutement et de la formation.
Une grande majorité des employé.e.s dispose de licence d’une suite bureautique. Au niveau mondial, ce marché pèse 25 milliards USD en 2021 (selon une étude Statistica). Ces outils font tellement partie du paysage que leur utilisation n’est que très peu discutée. Peu d’organisations ont une idée précise des coûts consacrés à cette activité.
Ce simple calcul permet de se rendre compte du budget mobilisé pour cette réalisation : temps consacré à cette activité par employé × nombre d’employés × nombre de jours travaillés × taux horaire.
Le budget d’une équipe de 3 personnes produisant des documents 4 h/jour à 50 €/h est de 130 200 €/an.
Outre le coût financier, cet effort – pas toujours passionnant – pénalise le développement d’autres activités dans ce domaine (publication web...) ou dans d’autres (développement de Services Après-Vente, formation...).
La documentation, le côté obscur du produit
La documentation est obligatoire pour mettre en service ou exporter des équipements. C’est parfois un jalon de paiement. La dématérialisation a permis de réduire les temps d’échanges de supports physiques. Néanmoins, constituer la documentation reste une source de stress pour les organisations, avec de forts enjeux financiers : refuser un paiement en invoquant l’insuffisance de la documentation est très facile. Réaliser un test de performance sur un appareil nécessite bien plus de moyens.
La rédaction structurée regroupe des méthodes de rédaction (le minimalisme), des technologies (XML) et des outils pour produire plus rapidement et de manière plus fiable toutes sortes de documents (notices, contrats, manuels…).
Alors que la majorité de la documentation est produite avec des outils bureautiques, de CAO ou de PAO, le principal format d’usage reste le pdf – notamment parce qu’il est difficilement éditable.
Cette finalité implique donc des changements de formats de la documentation durant son cycle de vie avant une mise à disposition de l’information :
-
les fichiers PDF sont diffusés pour le téléchargement sur un site web ou à disposition dans des outils de gestion électronique de documents (GED) ;
-
les fichiers html sont publiés sur un site web ou une tablette.
Cet article explique les mécanismes existants pour adresser efficacement ces usages.
Ces mécanismes sont :
-
la séparation du fond de la forme ;
-
la publication ;
-
le profilage et le filtrage ;
-
la modularisation.
Ces mécanismes seront décrits avant d’être utilisés dans un cas pratique.
L'expertise technique et scientifique de référence
MOTS-CLÉS
KEYWORDS
documentation | Product | data | configuration | word processing
DOI (Digital Object Identifier)
Cet article fait partie de l’offre
Documents numériques Gestion de contenu
(76 articles en ce moment)
Cette offre vous donne accès à :
Une base complète d’articles
Actualisée et enrichie d’articles validés par nos comités scientifiques
Des services
Un ensemble d'outils exclusifs en complément des ressources
Un Parcours Pratique
Opérationnel et didactique, pour garantir l'acquisition des compétences transverses
Doc & Quiz
Des articles interactifs avec des quiz, pour une lecture constructive
Présentation
Gestionnaire de contenus
En anglais
7. Modularité et réutilisation
-
Modulariser évite d’avoir à copier-coller des informations récurrentes.
-
Le cycle de vie des modules (élaboration, validité) est plus facilement traçable.
-
La consommation de contenus standards permet de dégager du temps pour se focaliser sur ce qui est spécifique.
En mécanique ou en électronique, il est moins coûteux d’assembler des éléments standards (existants donc) plutôt que d’en développer de nouveaux. Ce principe de gestion de configuration (make or buy) existe également en rédaction structurée. Réutiliser est souvent synonyme de copier-coller : la duplication est un moyen simple et rapide de réutiliser du contenu. À long terme, c’est désastreux : comment savoir où un contenu est utilisé pour mesurer des impacts en cas de changement ? Si on ne connaît pas les impacts, on ne peut pas faire les mises à jour nécessaires. Si on connaît les impacts, leur maintenance est très fastidieuse.
La rédaction structurée propose donc d’inclure des contenus dans d’autres, ce qui est parfaitement conforme aux structures arborescentes. Au lieu de contenir un contenu, le document contient une référence vers un contenu. Les avantages de cette façon de faire sont multiples :
-
la documentation est réalisée comme un assemblage de contenus standardisés, ce qui évite de réinventer ;
-
puisque les contenus sont réutilisés, tout le monde a un intérêt à les compléter pour qu’ils soient à jour, complets et prêts à l’emploi. Le temps consacré à chaque application est nécessairement moindre que si chaque contenu devait être adapté ;
-
cela permet de mesurer les impacts d’une modification. Si un contenu concerne l’évolution d’une réglementation, une composition chimique, l’étude des références inverses permet de voir les cas d’usage et d’agir en conséquence ;
-
les périmètres d’action des contributeurs sont clairement définis. Chaque rédacteur peut agrémenter les contenus dont il est responsable sans avoir à « réserver » les documents maintenus par d’autres. Ses mises à jour sont disponibles au niveau des assemblages. Cela évite les échanges de fichiers bureautiques, souvent source de perte d’information...
L'expertise technique et scientifique de référence
Cet article fait partie de l’offre
Documents numériques Gestion de contenu
(76 articles en ce moment)
Cette offre vous donne accès à :
Une base complète d’articles
Actualisée et enrichie d’articles validés par nos comités scientifiques
Des services
Un ensemble d'outils exclusifs en complément des ressources
Un Parcours Pratique
Opérationnel et didactique, pour garantir l'acquisition des compétences transverses
Doc & Quiz
Des articles interactifs avec des quiz, pour une lecture constructive
Modularité et réutilisation
BIBLIOGRAPHIE
-
(1) - CASEY (J.) - What If We Had Written the ISO/IEC/IEEE 26531 Component Content Management Systems (CCMS) Standard in a DITA CCMS? – - Heretto (2016) https://heretto. com/what-if-we-had-written-the-isoiecieee-26531-component-content-management-systems-ccms-standard-in-a-dita-ccms/]
-
(2) - SCHUBERT (S.), DURUSAU (P.) - Information technology — - OASIS Open Document Format for Office Applications (OpenDocument) – OASIS open (2021) [https://www.oasis-open. org/committees/tc_home.php?wg_abbrev= office].
-
(3) - CAROLL (J.) - The Nurnberg Funnel – Designing Minimalist Instruction for Practical Computer Skill – - Digital communication (1991).
-
(4) - Docbook - DocBook Technical Committee Document Repository [ - http://docbook.org/ns/docbookhttps://www.oasis-ope.org/docbook.
-
(5) - DocBook XSL: the complete guide - Bob Stayton, Sagehill Enterprises. ( - http://www. sagehill.net/book-description.html). http://www.sagehill.net/book-description.html.
DANS NOS BASES DOCUMENTAIRES
NORMES
-
Ingénierie des systèmes et du logiciel – Gestion de contenu relatif a la documentation du cycle de vie du produit, de l’utilisateur, et de la gestion de service. - ISO 26531 - 2015
L'expertise technique et scientifique de référence
Cet article fait partie de l’offre
Documents numériques Gestion de contenu
(76 articles en ce moment)
Cette offre vous donne accès à :
Une base complète d’articles
Actualisée et enrichie d’articles validés par nos comités scientifiques
Des services
Un ensemble d'outils exclusifs en complément des ressources
Un Parcours Pratique
Opérationnel et didactique, pour garantir l'acquisition des compétences transverses
Doc & Quiz
Des articles interactifs avec des quiz, pour une lecture constructive
