Linguistique Communication Informatique

Actualités, événements, articles
Toutes les actualités du Groupe LCI

Retour aux actualités

Quel format pour la production de votre documentation technique ?

A l’heure de la transition digitale, voici un panorama des solutions pour une documentation technique innovante et orientée vers une diffusion numérique.

Microsoft Office Word, inadapté

Word est un logiciel de traitement de texte. Il n’est pas destiné à générer de la documentation technique, d’autant plus si celle-ci doit être modulaire. Ce n’est pas un format structuré, il ne dissocie pas le fond de la forme et le principal format d’export est le PDF.

Les LML, pour la documentation logicielle

Dans le cas d’une documentation logicielle, la tendance actuelle est aux formats non structurés dits à balisage léger (Lightweight Markup Language) tels que Markdown, reStructuredText ou Asciidoc. Ces documentations sont ensuite publiées sous forme de sites web statiques (HTML) flexibles et conviviaux par des générateurs de documentation (Sphinx, Asciidoctor).

DocBook, la simplicité

DocBook est un format de documentation structurée. Initialement, DocBook permettait d’élaborer des documents monolithiques. Depuis sa version 5.1, DocBook suit l’évolution actuelle et permet aussi de développer des contenus modulaires, même si cette modularité est moins poussée que pour DITA.

DITA, universelle

Dans le domaine de l’industrie, la spécification DITA est en train de se généraliser. Plus qu’une simple architecture de document XML, DITA permet de concevoir, de rédiger, de gérer et de publier du contenu modulaire.
DITA est flexible dans l’organisation de l’information et permet la réutilisation de contenu, le single-sourcing et l’automatisation des processus de création documentaire.
Contrairement à d’autres spécifications plus rigides, DITA s’adapte à tout type de structure d’information grâce à son mécanisme de spécialisation.

S1000D, pour les projets complexes

La spécification S1000D, quant à elle, est plus complexe, avec des règles plus strictes. En contrepartie, cela rend cette spécification adaptée à des programmes complexes et très structurés tels qu’on peut en trouver dans le domaine aéronautique, ainsi que dans les domaines du naval et du ferroviaire. Tout comme DITA, la S1000D offre des gains de productivité et de qualité de l’information grâce à sa structure modulaire.

Outre les caractéristiques de chaque format de rédaction, le choix dépend de plusieurs autres paramètres comme les outils d’édition et de publication associés ou le type de profil qui doit contribuer à la mise à jour de la documentation.

Pascal LEGALLIC, Rédacteur Technique - Chef de Projet

Contact

1 rue du Petit Robinson
F-78350 Jouy-en-Josas
France
Tél : +33 (0)1 34 58 77 77
Fax : +33 (0)1 34 58 77 00
Email :

Nous rejoindre

Technicien assistance diagnostic automobile Je postule

Business developer linguistique Je postule

Technicien helpdesk/hotline niveaux 2 Je postule

Business Manager Je postule

voir toutes nos offres

LCI est une PME française créée dans les années 1990 qui réunit des savoir-faire complémentaires dans le conseil en ingénierie, la formation, le digital, la linguistique et la documentation technique.

Présent en France et au Luxembourg, LCI regroupe près de 200 talents animés par une même volonté : l’audace au service de l’excellence.

mentions légales