Embed Size (px)
Citation preview
Étude de cas
Bientôt disponible au téléchargement
Nolwenn Kerzreho, IXIASOFT
Marie Louise Flacke, Awel-A-Ben
Documation Paris, 7 avril 2016
Stand A37
STAND A37Concepts
Contenus
Minimalisme – la méthode de conception d’une documentation
centrée sur les besoins des utilisateurs.
DITA – le format dans lequel l’information est stockée.
Ici, un format modulaire, structuré et un standard ouvert.
On parle aussi d’une architecture pour les mécanismes de publication
conditionnelle et réutilisation directe et indirecte de rubriques et fragments
Outillage
DITA CMS – le système qui permet de rédiger et gérer les contenus
DITA et de publier les documents
STAND A37Agenda
IXIASOFT
Lyra Network et les défis à relever
La solution adoptée
Les résultats
Application des principes du minimalisme
STAND A37Vos intervenants
Nolwenn Kerzreho
@nolwennIXIASOFT
Représente IXIASOFT pour
l’Europe & auprès des
partenaires européens
Prof associée en communication
technique au Master de
l’université Rennes 2 – CFTTR
Marie Louise Flacke
@flacke
Spécialiste conseil multilingue en
communication technique.
Formatrice via Comtech et Awel
A Ben en rédaction technique,
rédaction DITA, et minimalisme.
STAND A37IXIASOFT
Leader des systèmes de gestion de contenus DITA
LogicielsMédical Haute technoIndustrie
STAND A37Lyra Network
PME internationale, présente sur 4 continents
Opérateur de paiements en ligne et sur dispositifs –
gestion et sécurisation
B2B – tous types d’intégrateurs, différents niveaux d’expertise
Options des produits : type paiements, langues, devises, clients
PDF, Mobiles, Web
http://www.lyra-network.com/
STAND A37Quelques symptômes, côté utilisateurs...
Je n’arrive pas à trouver
ma réponse dans le doc, il
est à jour ? Je vais appeler
le support
Cette information
est-elle exacte ?
Où est la dernière
version ?
J’ai déjà révisé
trois fois cette
information. Oui,
c’est juste!
STAND A37Quelques symptômes, côté utilisateurs...
Cette information
est-elle exacte ?
Où est la dernière
version ?
Je n’arrive pas à trouver
ma réponse dans le doc, il
est à jour ? Je vais appeler
le support
Publication plus ciblées (variables DITA, minimalisme)
Référentiel uniqueContenu modulaire et
versionnage
J’ai déjà révisé
trois fois cette
information. Oui,
c’est juste!
STAND A37Autres défis côté production chez Lyra Network
Les instructions
d’intégration sont-
elles prêtes et
disponibles ? Peut-on se
permettre de diffuser
vers un nouveau
pays ?
STAND A37Autres défis côté production chez Lyra Network
Les instructions
d’intégration sont-
elles prêtes et
disponibles ? Peut-on se
permettre de diffuser
vers un nouveau
pays ?
Gestion des modules, publication automatisée,
maîtrise des processus et des coûts via le DITA CMS
STAND A37
Choisir d’adopter la documentation
structurée – POC (DITA en modèle de
contenu)
Choisir le minimalisme
Mise en œuvre des outils de gestion
+ formation
Nouveaux formats de contenus livrés
Nouvelles traductions /
Nouvelles feuilles de style – réguliers
Résolutions
Mars 2012
Juillet 2014
Août 2014
Septembre
2014
STAND A37Modularité DITA : rubriques & cartes
Chaque rubrique à un objectif
Procédure (comment configurer)
Concept (ce qu’est le paiement sécurisé)
Référence (listes des options)
Rubriques et autres ressources
P
R
C
Des rubriques et des
fragments peuvent être
réutilisés – ce sont des
« sources »
On peut ajouter des
variables dans les
rubriques
STAND A37Modularité DITA : rubriques & cartesCartesRubriques et autres ressources
Les cartes
organisent les
rubriques
(table des matières)
Suivi des objets
Suivi des
réutilisation (où est
utilisé quoi)
Création assistée
Modèles
Clonages
Création de
brouillons
Réutilisation
STAND A37Cycle de vie : stockés - versionnés
Suivi des modifications :
Historique
Versionnage
Traçabilité
Suivi des commentaires
de version
Diff / Retour sur version
STAND A37Suivent les cycles de relecture et validation
Gestion des processus :
Définitions de rôles
Tâches « to do »
Statuts
Suivi des annotations et
des modifications
STAND A37… traduction et livraison
Gestion des traductions :
Création des kits de
traduction complets
Prétraitements (auto-
traduction)
Suivi des liens entre langues
/ multilinguisme
Connexion aux outils de TAO
STAND A37Publié et contrôlé par le DITA CMS
F1
F1
Web
Aide en ligne
Traitement des valeurs conditionnelles + feuilles de style
Gestion des publications :
Gestion des feuilles de style
Gestion des conditions
Manifeste de publication
Publication multilingue
Connexion aux outils de
publication dynamique
STAND A37Une documentation complexe,
enfin maîtrisée
Un « manuel » = ?? produits documentaires
sans compter les variables
Réutilisation
de contenu
12 variables
£ $ €
5 feuilles de
style
5 langues
F1
F1
3 formats
STAND A37Résultats – conception maitrisée
• Flexibilité et puissance de l’outil pour recréer par clonage des
documents entiers permettant un meilleur ciblage des utilisateurs.
• Meilleure maîtrise des contenus car l’équipe de rédaction a une
vue directe sur l’avancement de la production
• Publication personnalisée d’un large choix de documents, et ce
pour chaque plateforme Lyra, chacune des marques blanches,
langues, et formats de sortie (PDF et HTML, sur mobile, page web)
STAND A37Résultats – réutilisation et diminution des volumes
• Réutilisation intensive des rubriques grâce à la maintenance des
liens entre modules, entièrement prise en charge par le DITA CMS.
• Diminution du volume envoyé en traduction et raccourcissement
des délais de traduction.
STAND A37Résultats – livraison plus fiable et plus rapide
• Temps de publication négligeables – Toutes les marques sont
produites et disponibles en même temps.
• Réduction des délais de mise sur le marché, de plusieurs
semaines à une journée.
STAND A37Objectifs de Lyra Network –
contenu sûr, exact et moins coûteux
Les caractéristiques d’un contenu de qualité
• Automatisé – cohérent
• Lean – gestion de la production sans gaspillage
• Collaboratif – inclus facilement les contributeurs
• Contrôlé – processus et coûts
• Résultats constants – supprime les étapes de vérifications
superflues
STAND A37Minimalisme
• Formation sur site
• 1er trimestre 2014
• Mise en application principes du minimalisme
• Fourniture d’un Guide rédactionnel
(exemples AVANT / APRES)
STAND A37Technique de conception d’instructions
• Pas de DITA sans minimalisme
• « Minimalism is an approach that presents the
reader with the smallest amount of
information necessary to achieve the reader’s
goals. »
The DITA Style Guide, Tony Self
STAND A37Minimalisme, c’est…
• Couper les mots
• Couper les phrases
• Style télégraphique
• Brièveté…
STAND A37Minimalisme : besoins de l’utilisateur
• Ne donner à l’utilisateur que ce dont il a besoin (pour accomplir une
tâche)
STAND A37Minimalisme !
http://users.edte.utwente.nl/meij/minimalism.htm
STAND A37Orienté action
• Objectifs de l’utilisateur ?
Intégrer PayPal?
Paramétrer 1 formulaire de paiement ?
Effectuer un remboursement ?
• Action, Tâches procédures !
STAND A37Action : coup de balai ! (Principe N° 1)
• Éliminer le superflu
Éliminer :
• Introduction, Vue d’ensemble
• Informations générales
• Préambule
• A propos de…
Donner l’occasion d’agir
immédiatement
STAND A37Introduction ./. Tâches et action (1)
• Au lieu de
STAND A37Tâche et action (2)
Configurer une transaction e-commerce standard(EC4)
La transaction e-commerce standard est fournie par défaut et suit le processus
indiqué fig. 1
Configurer le XXXX
Configurer les ZZZZZ
Valider la configuration
STAND A37Éliminer aussi
• Le bla-bla marketing
• Le méta-texte (texte parlant du texte)
Caractères gras pour les titres de menu
Pictogrammes d’avertissement
Etc.
• Longues descriptions de produit
• L’illustration de chaque bouton
• L’introduction qui répète le titre
• La description de l’interface Quoi ? L’option
« Imprimer » sert à
imprimer ?...
STAND A37Principe n°2 : Tâches & environnement
• Ancrer l’outil dans son domaine
• Comprendre l’environnement de l’utilisateur (son milieu de travail)
• Quels sont ses véritables objectifs ?
STAND A37Environnement utilisateur (Principe n° 2)
Utilisateur-type
Environnement de travail
Langue Terminologie (de l’utilisateur)
Phrases simples et courtes (28 mots)
Vrais objectifs : titres « parlants »
• Pas les fonctions du produits… mais les objectifs des utilisateurs !
STAND A37Définir la terminologie
• Vocabulaire de l’utilisateur?
Cinématique ? Nomenclature?
• Mort aux synonymes !
Marchand, commerçant, boutique…
• Définir les abréviations
• Phraséologie constante !
• Guide rédactionnel (‘Style Guide’)
STAND A37Éliminer les synonymes
• intégration vs implémentation
• éditer vs modifier
• transaction vs opération
• marchand vs commerçant
STAND A37Titre, terminologie & synonymes
« Si nous apprenons très jeunes à éviter les répétitions en employant des
synonymes différents pour désigner la même chose, dans les modes d’emploi,
le recours à des noms différents pour désigner un même objet constitue une
faute majeure »
Christian Morel « L’enfer de l’information ordinaire » , p. 93
37
STAND A37Instructions : le titre
• Parlant, précis
• Forme verbale (infinitif)
<TITLE> Implémenter une transaction e-commerce
<TITLE> Contrôler la signature
STAND A37Titre de la procédure (1) ?
STAND A37Titre parlant et structure
d’instructions (2)
Spécifier l'URL sur l'outil de gestion de caisseLa plateforme de paiement peut appeler systématiquement l'URL sur l'outil de gestion de caisse.
Cette requête est réalisée de serveur à serveur en utilisant un formulaire HTTP POST.
1. Dans le formulaire AAA, définissez ZZZ
2. Sélectionnez l'option BABA
3. Confirmez l'URL
4...
STAND A37Titre, formule politesse, liste puces (1)
STAND A37Titre parlant : préparer
l’intégration… (2)
Préparer l'intégration du module de paiement
1. Vérifiez être en possession des 3 éléments suivants :
Fichier du module de paiement Payzen_prestashopxxxxx
Certificat de test ou de production : votre outil de gestion de caisse -
Paramétrage --> Boutique --> Certificats
STAND A37Titre parlant :
préparer l’intégration… (2)
Identifiant de votre boutique : votre outil de gestion de caisse Paramétrage
BoutiquesConfiguration – rubrique : identifiant de site
2. Connectez-vous à votre back-office marchand :
https://secureXXXXXX
STAND A37Instructions cachées ?
Associer le contrat à votre boutique
Pour proposer le moyen de paiement Paypal, vous devez associer le contrat XXX à
votre boutique.
1. Dans la fenêtre Boutiques associées, cochez l'option "Boutique associée"
2. Vérifiez le compte à créditer
3. Pour enregistrer, cliquez sur Sauvegarder en bas de l'écran à droite.
STAND A37Une Short Description (pas introduction)
• Concept qui complète la tâche
• Ne pas répéter le titre
• Doit fournir des précisions
…essentiel pour DITA (outil de recherche sur le Web)
STAND A37Une note à transformer en instruction
Paramétrer une vente à distance
1. Avant de définir les paramètres, vérifiez que
le commerçant a souscrit une offre VAD
auprès de sa banque
2. Sous Paramètre non défini ou valeur vide,
vérifiez que XXX
3. Cochez l'option BO pour autoriser un
paiement en saisie manuelle
4...
STAND A37Trouver l’information (Principe N° 4)
“Also, one should not expect users to process the manual in a linear fashion. As a rule,
users frequently look back to earlier sections and chapters, peek ahead at chapters and
sections, and redo chapters or tasks.
Providing for the proper headings can be a meaningful way to accommodate to this need
for consultation. “
Dr. Hans van der Meij, Website
Un titre
« parlant »,
sinon rien !
47
STAND A37Trouver l’information (comment faire ?)
Trouver rapidement l’info pertinente
(a) Table des matières
Précise (orientée tâches)
(b) Index
Fonction recherche ou index ?
Titres précis et faisant sens
48
STAND A37Question / réponses
www.ixiasoft.com/
@IXIASOFT
@nolwennIXIASOFT
LinkedIn :
IXIASOFT DITA CMS Users
Membres du comité
technique OASIS DITA
www.awelaben.com
Awel A Ben
@flacke
