pourquoi la documentation compte ?

Download Pourquoi la documentation compte ?

If you can't read please download the document

Upload: sarahhaim-shl

Post on 26-May-2015

1.091 views

Category:

Documents


1 download

TRANSCRIPT

  • 1. Pourquoi la documentation compte ? Where Content Means Business

2. Sarah? SarahHam-Lubczanski PreviouslydveloppeusePHP Previouslyformatrice PreviouslydveloppeusePHP Previouslyinvestiedansl'AFUP,puisdansl'AFUPLyon Now? TechnicalWriterateZSystems Depuisjanvier2014 Monlieudetravail:http://doc.ez.no 3. Agenda Pourquoijesuisdevenuedocumentaliste? Commentoncritunebonnedocumentation? Gnrerdeladoc L'ancienetlenouveau Ecrireladoc:protips Particularitsopensource Pointsd'amliorationchezeZSystems 4. 4 eZ Systems & eZ Publish 4 Quelques mots sur eZ Systems 5. eZ Systems en chiffres Fonden1999SkienenNorvge Prsentdans6pays:France,Allemagne, Etat-Unis,Norvge,Japon,Pologne, 15ansdexpriencedanslcosystmeOpen Source Plusde15000clientsprsentsdans120 pays UnEcosystmedeplusde44000membres etde350partenaires 6. QuelquesmotssureZSystems CrateurdusystmedegestiondecontenueZ PublishPlatform LeadersurlemarchdelEnterpriseOpen SourceContentManagement Nousaccompagnonslessocitsdansleur transitionversledigitalentransformantleur contenuenbusinessdigitalrentable @ezsystems | http://ez.no 7. 7 eZPublishPlatform5.3 Multi-sites Multi-langues Multi-canal 8. 8 Documenter 8 9. Pourquoi je documente ? Aider les gens comprendre Les concepts Les features Comment faire Les bonnes pratiques Pour l'entreprise Publicit Mta-information 10. Je crois que la doc a vend plus Dcision d'achat Confiance : fracheur, pertinence Rputation Complment au discours commercial Support technique 11. Tout le monde peut amliorer sa documentation Nouvelle : http://confluence.ez.no Aucun lien depuis la homepage Ancienne : http://doc.ez.no Habitude Rfrencement 12. Grer la doc existante et ancienne Documentation existante Ancienne version d'eZ Publish 4,x Version actuelle d'eZ Publish 5.3 Choix possibles : Archiver la doc, figer Continuer mettre jour Rendre + trouvable Mettre des liens Problme des versions 13. Janvier 2014 : Documentation v 5 14. Janvier 2014 : Documentation version 4.x 15. Documentation juin 2014 16. Pour qui vous documentez ? utilisateurs externes utilisateurs internes dveloppeurs du futur concurrents 17. Personas la rescousse Technique des personas Nous a permis d'identifier la doc manquante Doc Effort Week 4 collgues 22 pages cres 172 mise jour 18. Quand on est dev, on aime les scripts Avantages Depuis le code Lisible pour ceux qui ne lisent pas le code Inconvnients Doublon de contenu Maintenance supplmentaire Inutile avec IDE Gnrer de la documentation depuis la PhpDoc ? Insuffisant 19. Comment les dev eZ Publish crivent la doc ? Doc = une colonne de notre Kanban Board 20. A quoi sert un Tech Writer ? Dev issues passent par la doc PR avec discussion Commentaires pour Team Doc La doc peut corriger des problmes 21. Qu'est-ce que je fais le plus souvent ? Tester des parties de la doc Lire Comprendre Organiser le contenu Communiquer Ecrire Veille documentaire Comment font les autres ? Pourquoi ? 22. Comment les dvs peuvent crire de la doc sans douleur Ecrire la doc immdiatement aprs la fin du dv Technique du canard en plastique Penser aux mots-clefs Plusieurs manires d'organiser la doc Prs du code Prs du support Prs du marketing Publish often ! 23. Plusieurs manires d'organiser la documentation TOC (Table of Content) Task-based Contextuelle Guerilla documentation Forums Non controlable Search: notions clefs, tags Garder l'esprit Visiteurs cherchent rsoudre problme En colre parfois 24. Problmatiques de la doc technique Coloration syntaxique Plusieurs langages Outils existants et leur prix Workflow de dev Backlog Product Manager Maintenance de la doc Comme le code ! Equipe support Chacun a SA doc 25. Que doit-on documenter ? Trouver les questions que les utilisateurs se posent Frquenter les mmes lieux A/B testing Bugs, tips and tricks 26. Lapport de la communaut opensource http://share.ez.no Sondage Sur les attentes Sur la cration de contenu Collaboration Commentaires Si tu ne contribues pas au code, tu peux contribuer la doc 27. Opensource et documentation Ce qu'on prvoit de faire eZ Systems Utiliser un soft opensource pour la doc ReadTheDocs eZ Publish Platform Augmenter la facilit de collaboration Gnrer la documentation depuis des fichiers ditables Symfony-like Ranger la doc technique prs du code Augmenter les reviews PR avec de la doc 28. Memento Mieux vaut une doc commence qu'inexistante DO IT NOW ! Mettez jour Si vous ne la proposez pas, quelqu'un en fera une Tout le monde est concern When in doubt, document ! 29. Merci ! Questions ? [email protected] Twitter @mereteresa Where Content Means Business