D'un PDF encombrant de 7000 pages à une aide en ligne facile à utiliser
Situation initiale unsmart : Utilisation difficile d'une Spec étendue
Dans notre travail quotidien de développeur, nous nous occupons souvent de la conversion de et vers Microsoft Word. Pour cela, nous travaillons beaucoup avec l'ECMA-376, la spécification OOXML. Quiconque a déjà eu accès à ce recueil d'informations de ~7000 pages sait qu'il est très pénible de travailler avec cette spécification en PDF, Word ou avec les documents imprimés.
Lorsque l'on travaille avec le cahier des charges, il est surtout important que les informations soient trouvées rapidement. Essayez d'ouvrir le Word Part IV à partir de l'édition 1. Il faut en moyenne 5 minutes pour que le document s'affiche. Essayez maintenant de faire des recherches dans ce document volumineux. Vous constaterez qu'il faut à nouveau un certain temps pour que la recherche soit active et réagisse. Il en va de même pour les versions PDF. Ce n'est pas une situation avec laquelle développeursdéveloppeusesdéveloppeurs et développeusesdéveloppeur·se·s qui ont besoin d'un accès rapide à une information spécifique peuvent bien vivre.
Objectif smart: Accès facile aux informations de la Spec
C'est là que l'on souhaite la présentation et l'accès rapide à toutes les informations et, idéalement, dans une mise en page entièrement responsive, avec une bonne possibilité de naviguer dans les contenus, avec une mise en évidence de la syntaxe et, bien sûr, une recherche rapide en texte intégral.
Conversion en une aide en ligne, HTML5
Pour réaliser ces objectifs, la conversion de la spécification en HTML5 s'est imposée. Quelle chance que nous ayons un environnement de conversion conçu précisément pour ce genre de tâches.
Nous avons donc configuré notre propre environnement de conversion c-rex.net.DTS de manière à extraire toutes les informations du Word et à transférer ce contenu vers DITA et, de là, vers une aide en ligne répondant à toutes les exigences de notre travail quotidien. Cette conversion a été effectuée de manière entièrement automatique.
C'est vrai, le format intermédiaire est DITA. Et cela nous permet d'avancer de manière structurée et surtout modulaire. Le monde est ouvert - de la traduction automatique à la diffusion de contenu pilotée par l'utilisateur, par exemple sur la base d'iiRDS. Le contenu DITA peut d'ailleurs être téléchargé sur c-rex.net resources.
Points forts de Webhelp par rapport à la solution PDF de l'ECMA Spec originale
Vous voyez ici les points forts, c'est-à-dire ce qui, selon nous, rend le travail avec la Spec au format HTML nettement plus intelligent que le travail avec les Word ou PDF.
Présentation
responsive vs. non responsive en Word
Recherche
Recherche plein texte vs. limitée au fichier Word concerné
Suggestions de recherche dans le champ de recherche
Durée de la recherche quelques secondes vs. plusieurs minutes dans un fichier de 5000 pages
Classement des résultats de recherche vs. pas de classement des résultats de recherche dans Word
Navigation et orientation du contenu
sur les tables des matières globales et par chapitre vs. Table des matières uniquement au début du fichier Word
Mise en relief de la syntaxe
Surlignage syntaxique vs. pas de surlignage syntaxique en Word
Nobody is perfect : les petits défauts de la mise en œuvre du HTML
Nous sommes conscients que cette conversion entièrement automatique ne donne pas un résultat parfait. Et ce n'est pas nécessaire ! Mais nous y reviendrons dans un instant. Nous vous montrons ici quelques déficits dans le résultat de la conversion, mais avec lesquels nous, développeursdéveloppeusesdéveloppeurs et développeusesdéveloppeur·se·s, pouvons facilement vivre.
deux points superflus pour certains éléments, par ex. pour Notes et Example
l'absence de numérotation des chapitres, surtout lorsqu'il y a des références qui n'affichent pas le texte du titre, mais le numéro de la section.
Conclusion : se concentrer sur l'essentiel et ignorer les détails qui ne sont pas importants pour le cas d'utilisation
Ce projet est un bon exemple de réalisation de projet dans lequel nous n'avons pas mis en œuvre une solution en partant du maximum faisable, mais en partant d'un cas d'utilisation très spécifique.
Nous avons ici délibérément pris nos distances par rapport à une attitude que nous avons pu observer à maintes reprises : La tendance à être parfait, à s'accrocher à de nombreux petits détails qui génèrent beaucoup d'efforts. Cela conduit trop souvent à ce qu'un projet prenne beaucoup trop de temps à être mis en œuvre. Ou alors, l'obsession du détail peut même faire échouer des projets.
Avec la OOXML-Spec, nous avons un cas d'utilisation particulier : Un ouvrage de référence pour les développeursdéveloppeusesdéveloppeurs et développeusesdéveloppeur·se·s qui doivent travailler avec Word. Pour ce cas d'utilisation, il est important que les informations soient trouvées rapidement. développeursdéveloppeusesdéveloppeurs et développeusesdéveloppeur·se·s - donc le groupe cible de cette mise en œuvre - ne s'intéressent pas vraiment aux petits défauts décrits ci-dessus. Si, en tant que développeurdéveloppeusedéveloppeur et développeusedéveloppeur·se, je parviens au résultat en quelques clics, cela m'aide rapidement dans mon travail quotidien et je suis heureuse de ne plus avoir à me battre avec Word ou des PDF non-répondants encombrants.
Nous avons donc généré ici une véritable valeur ajoutée pour les développeursdéveloppeusesdéveloppeurs et développeusesdéveloppeur·se·s avec une approche qui n'est pas à 100% et avec un effort raisonnable, car nous ne nous sommes tout simplement pas souciés des détails mentionnés. Si c'est important pour d'autres cas d'application, on peut bien sûr investir plus de temps et d'argent pour optimiser encore plus le résultat.
Si vous le souhaitez, vous pouvez voir le résultat par vous-même : Exemple OOXML sur le site c-rex.net.