Article de référence | Réf : H7450 v1

Cas pratique
Rédaction structurée, un outil industriel efficace

Auteur(s) : Florimond ALEMPS

Date de publication : 10 août 2022

Pour explorer cet article
Télécharger l'extrait gratuit

Vous êtes déjà abonné ?Connectez-vous !

Sommaire

Présentation

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’article

ABSTRACT

Technical writing, an industrial and efficient tool

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.

Cet article est réservé aux abonnés.
Il vous reste 93% à découvrir.

Pour explorer cet article
Téléchargez l'extrait gratuit

Vous êtes déjà abonné ?Connectez-vous !


L'expertise technique et scientifique de référence

La plus importante ressource documentaire technique et scientifique en langue française, avec + de 1 200 auteurs et 100 conseillers scientifiques.
+ de 10 000 articles et 1 000 fiches pratiques opérationnelles, + de 800 articles nouveaux ou mis à jours chaque année.
De la conception au prototypage, jusqu'à l'industrialisation, la référence pour sécuriser le développement de vos projets industriels.

KEYWORDS

documentation   |   Product   |   data   |   configuration   |   word processing

DOI (Digital Object Identifier)

https://doi.org/10.51257/a-v1-h7450


Cet article fait partie de l’offre

Documents numériques Gestion de contenu

(74 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

ABONNEZ-VOUS

Lecture en cours
Présentation

10. Cas pratique

Cette partie technique montre la façon dont l’information est codée. Les données de la figure 5 sont reprises. Cela illustre bien la différence entre fond et forme : l’éditeur est une publication interactive des documents.

Les mécanismes de modularisation, profilage en vue du filtrage à la publication sont décrits dans les trois figures (figure 8, 9 et 10).

L’identification de données pour créer des modules paramétrés est également décrite.

HAUT DE PAGE

Cet article est réservé aux abonnés.
Il vous reste 92% à découvrir.

Pour explorer cet article
Téléchargez l'extrait gratuit

Vous êtes déjà abonné ?Connectez-vous !


L'expertise technique et scientifique de référence

La plus importante ressource documentaire technique et scientifique en langue française, avec + de 1 200 auteurs et 100 conseillers scientifiques.
+ de 10 000 articles et 1 000 fiches pratiques opérationnelles, + de 800 articles nouveaux ou mis à jours chaque année.
De la conception au prototypage, jusqu'à l'industrialisation, la référence pour sécuriser le développement de vos projets industriels.

Cet article fait partie de l’offre

Documents numériques Gestion de contenu

(74 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

ABONNEZ-VOUS

Lecture en cours
Cas pratique
Sommaire
Sommaire

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.

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

Cet article est réservé aux abonnés.
Il vous reste 93% à découvrir.

Pour explorer cet article
Téléchargez l'extrait gratuit

Vous êtes déjà abonné ?Connectez-vous !


L'expertise technique et scientifique de référence

La plus importante ressource documentaire technique et scientifique en langue française, avec + de 1 200 auteurs et 100 conseillers scientifiques.
+ de 10 000 articles et 1 000 fiches pratiques opérationnelles, + de 800 articles nouveaux ou mis à jours chaque année.
De la conception au prototypage, jusqu'à l'industrialisation, la référence pour sécuriser le développement de vos projets industriels.

Cet article fait partie de l’offre

Documents numériques Gestion de contenu

(74 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

ABONNEZ-VOUS