edc à Documation 2016 - le futur de la doc

La production de la documentation utilisateur adaptée aux éditeurs de logiciels

Gestion de

stratégie éditoriale

de contenu

Publication

dans votre produit

et multi-canal

Construction facile

et incrémentale du

bas vers le haut

Implication

de tous les acteurs

dans un rôle approprié

Validation,

gestion de versions

et de traductions

faciles

un éditeur de contenu structuré pour la

conception d’information et de

documentation orientées utilisateurs

Convertir une

norme reconnue

en un processus

de fabrication de

documentation

facile

Notre vision est inspirée des bonnes pratiques du modèle DITA notamment

concernant la segmentation de l’information

Nous supprimons le besoin de configuration technique pour permettre aux

contributeurs de se concentrer sur leur travail

Nous transformons la fabrication de la documentation en un processus

collaboratif impliquant tous les acteurs d’un produit au bon moment

edc, c’est quoi ?

un éditeur de contenu structuré pour la

conception d’information et de

documentation orientées utilisateurs

Conçu pour des

éditeurs de

logiciels

souhaitant

moderniser leur

documentation

utilisateur

La documentation est construite de manière incrémentale en la

livrant d’abord sous forme d’aide contextuelle dans l’interface

Le contenu connexe est ensuite ajouté étape par étape sous forme de

procédures, de howtos, ou de FAQs…

Il propose une approche originale de rédaction technique logicielle en

intégrant la documentation dans le cycle de développement

edc, c’est quoi ?

Documentez

votre produit

intuitivement

et de façon

incrémentale

Connectez la

documentation

contextuelle

avec notre

plug-in IDE

Rédacteurs,

collaborateurs,

développeurs

travaillent mieux

ensemble

Devenez 100%

agile en rendant

votre

documentation

agile

Une nouvelle dimension

pour la livraison de votre

documentation

Documentez

votre produit

intuitivement

de façon

incrémentale

Avec une

méthodologie

simple

Concevez une

stratégie éditoriale de contenu1

Commencez avec la base,

la doc contextuelle2

Ajoutez au bon endroit

la doc connexe3

Gérez les contributions,

les commentaires et validez4

Publiez dans votre produit

et distribuez en multi-canal5

• la plus vieille approche architecturale au monde

• garantit la prise en compte de l’essentiel au bon endroit

• préserve le lecteur d’une surcharge d’information

Pourquoi documenter de manière incrémentale ?

• originalité d’edc

• vue d’ensemble

• vision des priorités

• répartit les rôles

• organise la collaboration

• intègre les experts

• programme la validation

Pourquoi une stratégie éditoriale de contenu ?

• connectée in-situ aux

briques de l’IU définies par les

développeurs

• elle est minimaliste,

pertinente

• c’est la porte d’entrée pour le reste, connecté par

des liens

La doc contextuelle vue par edc

• toute autre forme

d’information

• bâtie de manière stratégique

et suivant un mapping

DITA

• disponible pour le

support et sur un

portail doc

Qu’est-ce que la doc connexe ?

• ils sont essentiels à

l’enrichissement du

contenu

• permettent de collecter le

savoir et savoir-faire

• mobilisent et motivent les utilisateurs

Les commentaires et contributions

• le premier canal est

dans votre produit

• deux autres canaux

prioritaires :

• portail support

• portail doc orienté

connaissances

Publication multi-canal

Notre plug-in

IDE pour

créer des

briques de

l’IU et

connecter la

documentation

contextuelle

Les développeurs déclarent

les briques de l’IU1

Ils attribuent une image

de référence2

Ils déclarent les

tooltips à gérer3

Ils contribuent au contenu

et le commentent4

Ils traitent les remarques sur

l’ergonomie et la terminologie5


• briques de l’IU

déclarées par les

développeurs

• maintenues à jour par

les développeurs

Briques de l’IU


• plug-in dans leur IDE – ils n’ont pas à changer

d’environnement

• ils disposent du code pour

l’affichage de la doc –api automatique

Back-office edc pour développeur

• implication des deux

dans des rôles très

complémentaires

• collaboration autour

de la terminologie et de

l’ergonomie

• les rédacteurs sont les

premiers testeurs

Collaboration développeur - rédacteur

Rédacteurs,

collaborateurs,

développeurs

peuvent

mieux travailler

ensemble

pour créer

une doc

pertinente

Responsables produit :

stratégie, cadre, avancement1

Développeurs :

briques d’interface, tooltips2

Rédacteurs techniques :

centrés sur la rédaction3

Equipes support :

contribuent et interagissent4

Utilisateurs :

contribuent et commentent5

• il sait ce qu’il veut

• il connaît son public

• il fixe et oriente les priorités

• il contribue– concepts, glossaire,

workflows

Que fait le responsable produit dans la doc ?

• ils savent ce qu’ils ont

développé

• ils aident à comprendre le

fonctionnement de base

• ils écoutent les

suggestions pour la

terminologie

Que font les développeurs dans la doc ?

• elle connaît les clients et

a besoin de la doc

• elle contribue au contenu

(astuces, procédures,

FAQ…)

• elle participe aux tests et

à la validation de la doc

Que fait une équipe support dans la doc ?

• ils sont les premiers

concernés

• ils peuvent commenter

et enrichir

• leurs stats de lecture gouvernent les choix de

maintenance

Que font les utlisateurs dans la doc ?

Devenez 100%

agile en rendant

votre

documentation

agile

edc le permet

Développement non agile :

edc est agile en soiA

Documenter avec agilité :

edc exploite les sprints & storiesB

Développement agile :

la doc est aussi agileC

• pas obligatoire mais un

plus indéniable la méthodologie edc est agile en soi

• une doc en phase

• une réactivité accrue

• la doc aussi est testée

• les rédacteurs

comprennent mieux

Agilité et documentation utilisateur

Agilité – une vue classique

Agilité – on fait quoi de la doc ?

La doc utilisateur et les besoins du

support sont absents en méthode

agile

Une partie des réponses aux besoins

utilisateur l’est donc aussi ?

Agilité + stratégie de contenu

+Notre implémentation

de la stratégie éditoriale de contenu

est conçue pour qu’elle

s’insère dans les méthodes agiles


+La vue d’ensemble et les objectifs sont

définis par le

product ownerau démarrage


+Audience cible définie par le

product ownerdans l’identification des

exigences du projet


+Canaux de

publicationdéfinis dans la phase

de planification


+

Fabrication de contenuC’est la phase itérative la plus longueet qui peut se dérouler en même temps que le développement

- étendue de la doc contextuelle via les briques de

l’IU déterminée avec les développeurs

- contenu connexe en accord avec les objectifs :

- procédures avec les experts

- FAQ & Howtos (astuces) avec le support

- tutoriels avec les formateurs


+Les sources sont matérielles et humaines

- le PO contribue aux concepts

- le PO et les experts contribuent aux procédures

- le support connaît les attentes des utilisateurs

- les formateurs connaissent leurs besoins en tutoriels


+

Tests et validation

durant le

développement

Feedback

processus en continu

- capture d’expérience utilisateur

- améliorations

making software easy

Nous facilitons la conception de votre documentation utilisateur

avec

Nous facilitons la conception de votre documentation utilisateur


Avant

• pour les éditeurs de logiciels

fabriquer la doc

est un processus difficile

• qui implique des techniques et

un savoir-faire qu’ils

ne maîtrisent pas

• son coût est réel et sans visibilité

quant à son efficacité

Après

• la doc fait partie intégrante du

projet de développement

• les responsables produit

conçoivent et maîtrisent leur

stratégie

• tous les acteurs s’impliquent au

bon moment

• la doc devient une valeur ajoutée

Comment faciliter la conception ? Et le plus simplement

possible

Etape 1

Concevez votre stratégie

éditoriale de contenu


Fixez les objectifs

Définissez l’audience

Déterminez les canaux

Décidez du contenu

Organisez les sources

Organisez la validation


possible

Etape 2

Commencez avec la

documentation

contextuelle


Les développeurs ont

accès au serveur edc


possible

Etape 2

Commencez avec la

documentation

contextuelle

Les développeurs

déclarent les briques

d’interface dans edc

pour qu’elles soient

documentées



possible

Etape 2

Commencez avec la

documentation

contextuelle

Les rédacteurs

prennent le relai…

Ils voient ce que les

développeurs ont créé



possible

Etape 2

Commencez avec la

documentation

contextuelle

Les rédacteurs

documentent avec des

topics typés

- Ils servent à guider la

rédaction



possible

Etape 3

Ajoutez des concepts,

des howtos, des FAQs…

Le contenu additionnel

est ajouté

Il est attaché en tant que

lien où il va être utile



possible

Etape 4

Vérifiez et validez votre

contenu

Commentaires & contributions

Commentaires tout au long du

cycle de production

Contributions par des experts et

des utilisateurs

Validation

edc utilise un cycle de validation

simplifié

Il n’est pas obligatoire.

L’avancement de la validation est visible

dans le tableau de bord.



possible

Etape 4

Publiez dans votre

produit

et vers d’autres canaux

si besoin


La doc est disponible

dans votre produit

Exemple pour une

technologie Eclipse/RCP


Quelques avantages supplémentaires Ca ne s’arrête pas

là?

Maintenance facilitée

- les développeurs signalent les

changements dans l’IU

- des FAQs peuvent être ajoutées

par le support

- les retours et contributions des

utilisateurs sont accessibles

- des statistiques de pertinence

orientent l’évolution de la

documentation existante

Gestion de versions facilitée

- les nouvelles versions sont

produites en se basant sur les

précédentes

- les développeurs signalent les

changements

- le responsable produit indique de

nouvelles priorités

- les rédacteurs ne traitent que ce

qui a changé

Traduction facilitée

- la traduction est synchronisée et

suit les versions

- elle se fait dans un double

éditeur, article par article

- sa progression est visible via le

tableau de bord edc

- les changements dans les articles

sources sont notifiés

Comment démarrer ?

Téléchargez

1. Identifiez-vous et votre

structure

2. Installez le produit

3. Installez le plugin dans votre

IDE

4. Démarrez votre documentation

Utilisez en mode SAAS

1. Créez votre compte

2. Téléchargez et installez le

plugin pour votre IDE

3. Démarrez votre documentation

Suis-je accompagné ?

Si vous avez téléchargé

Un support de base

• le produit est complètement

documenté et vous guide

• vous avez un support en ligne

avec chat intégré

• vous avez un portail métier

pour échanger

En plus : vous pouvez acheter des

tickets support en cas de

besoin

Si vous êtes en mode SAAS

En plus du support de base

• nous pouvons intervenir à

distance en cas de besoin

• vous pouvez demander l’aide

d’experts

En plus : vous pouvez acheter des

tickets support en cas de

besoin

Un support performant autour

de votre métier

Quels sont mes avantages ?

Avantages pour les responsables produit

• Aperçu de l’avancement du projet de doc

• Votre projet de documentation est agile

• Collaboration naturelle autour de la doc

• La puissance d’une stratégie éditoriale

• La validation facilitée

• La gestion des versions adaptée au monde du logiciel

• La gestion des traductions facilitée

Nous souhaitons faire passer

la documentation d’un projet

fastidieux et mal perçu à une

stratégie apportant une valeur

ajoutée identifiable.

Nous vous aidons à mieux

gérer l’implication des

utilisateurs (user onboarding)

et leur satisfaction.


Avantages pour les développeurs

• Ils deviennent des acteurs clés de la doc

• Ils disposent d’un plugin-in simple dans leurs IDE

• Ils n’ont plus besoin de s’occuper des tooltips

• Tout le code nécessaire leur est fourni

• Ils ont un retour d’expérience le plus tôt possible

• Ils sont actifs dans la maintenance de la doc

L’idée est d’intégrer les

développeurs dans le cycle de

la documentation et de leur

simplifier la vie grâce à un back

office intégré dans leur IDE

favori.

Une plus grande implication

de leur part sensibilise tôt sur

l’ergonomie et la terminologie.


Avantages pour les rédacteurs

• Leurs objectifs sont plus clairs

• Ils ont accès à des experts identifiés

• Ils se concentrent sur la rédaction ciblée

• Ils deviennent architectes d’information

• Ils voient leur état d’avancement plus facilement

• Ils bénéficient de méthodes de travail en collaboration

Le travail des rédacteurs

(techniques) est grandement

facilité et mieux valorisé.

Leur métier s’oriente vers la

gestion de l'ensemble du projet

de documentation et

l’architecture d’information.


Avantages pour les équipes support

• Elles se concentrent sur leur mission d’assistance

• Les rédacteurs les assistent dans la création de contenu

• Elles contribuent aux FAQ

• Elles utilisent une doc maintenue à jour

• Elles sollicitent des retours d’expérience

L’information venant du

support fait partie intégrante

du schéma d’information et de

documentation autour des

produits et doit être captée.

L’intégration de ce type de

contenu est facilitée et ouvre la

voie vers les portails de

connaissances et de savoir-

faire.


Avantages pour les utilisateurs

• Une documentation à jour

• Une implication réelle et le sentiment d’être considéré

• Pouvoir contribuer et partager

• A terme, bénéficier du savoir faire des autres

Nous faisons de la

documentation pour les

utilisateurs. Leur satisfaction

est notre objectif.

Leur implication garantira une

meilleure pertinence de la doc

et en retour, leur satisfaction.


Avantages pour les éditeurs de logiciels

• Ils peuvent doser l’investissement plus facilement

• L’effort est graduel et ajustable

• Ils mesurent la satisfaction plus facilement

• La documentation devient une valeur ajoutée

• Leurs utilisateurs sont plus satisfaits et impliqués

Le retour sur investissement,

même immatériel, est ce que les

éditeurs recherchent avant tout.

Nous voulons partager avec

eux toute notre expérience en

matière de documentation

utilisateur dans le domaine des

logiciels techniques.

www.easydoccontents.com

www.doccontents.commaking software documentation easy

edc à Documation 2016 - le futur de la doc

Software

Transcript of edc à Documation 2016 - le futur de la doc