[:fr]La parole est aux speakers : Sarah Haïm-Lubczanski (AFUP Day 2019 Rennes)[:]
[:fr]Jusqu’à l’AFUP Day 2019 Rennes, retrouvez nos interviews de speakers pour mieux comprendre leur parcours et le sujet qu’ils ou elles aborderont lors de leur conférence !
La conférence
No Doc, No Feature v2La nouvelle fonctionnalité est prête, toute l'entreprise se réjouit. Les utilisateur·ices vont-ils savoir s’en servir ? Si vous pensez que le changelog et la PHPDoc suffisent, je voudrais vous demander : pourquoi priver vos utilisateur·ices des meilleures parties de votre logiciel ? Je vous propose de définir la qualité minimale attendue pour une documentation aujourd'hui, et d’examiner l’effort à fournir pour l’atteindre. Nous parlerons des process de documentation et de comment on fait pour documenter avec les moyens et les compétences disponibles au sein de l'équipe. |
La Fabrique 17/05/2019 11:15-11:55 |
Cela sera ta deuxième conférence sur le sujet de la documentation à un événement AFUP. La documentation peut parfois être vue comme rebutante à écrire : comment motiver l’équipe à la rédiger ?
La documentation est vue comme rebutante à écrire par les développeur·euse·s car cela demande un vrai travail de formulation et de concrétisation de concepts abstraits et d’idées pour les partager. Ces idées peuvent être claires dans votre tête et il faut alors les transcrire. En fait, la documentation requiert des compétences de communication.
Lors de ma précédente conférence sur la documentation durant le PHP Tour 2018 à Montpellier, j’insistais sur le fait que les développeur·euse·s apprécient une documentation de qualité, et pourtant ne sont pas toujours prêt·e·s à investir du temps dans la production d’une documentation qui valorisera leur travail.
Existe-il des métriques ou des outils permettant de s’assurer de la complétude/qualité d’une documentation ?
Malheureusement, hormis le coverage pour de la documentation liée au code (comme les commentaires PHPDoc permettant de générer des pages de doc), il n’existe aucune métrique purement statistique.
Une des métriques les plus simples à envisager serait d’examiner le nombre de tickets de supports ou de faire des journées de mise en correspondance des features et des contenus de documentation associés à ces features. On rejoint l’idée que l’évolution de la documentation est liée à la roadmap du logiciel.
Tu as de l’expérience dans différents domaines, en tant que développeuse, formatrice : ces expériences t’aident-elles dans ton métier de Technical Writer ?
Absolument. En fait, mes expériences précédentes m’ont conduite à exercer le métier que je fais maintenant. Le fait de noter et savoir ressortir des informations à point nommé est une compétence que j’ai développée au cours de mes expériences précédentes.
En tant que formatrice, j’ai dû préparer des formations et, le cas échéant, chercher des réponses aux questions des participant·e·s grâce à de la documentation. En tant que développeuse, j’ai eu la chance de travailler dans des équipes et avec des personnes qui attachaient de l’importance à la qualité et à la progression de leurs collègues, et la documentation participe à la qualité.
Une conférence présentée par
 Sarah HAÏM-LUBCZANSKI |
Technical Writer après avoir été formatrice, puis développeuse, Sarah Haïm-Lubczanski a toujours préféré le contact des informaticien.ne.s spécialistes à celui du grand public, et cela a bien fonctionné puisqu'elle écrit de la documentation de logiciel chez BIMData. Co-fondatrice de l’antenne AFUP Lyon, co-fondatrice de la Game Dev Party et co-organisatrice du premier Coding Goûter lyonnais, elle est engagée dans le tissu associatif local technologique. Elle apprécie d’être à l’initiative de projets qui aident les autres. |
Autres interviews
- [:fr]La parole est aux speakers : Aleth Gueguen (AFUP Day 2019 Rennes)[:]
- [:fr]La parole est aux speakers : Yvonnick Frin et Benjamin Cavy (AFUP Day 2019 Rennes)[:]
- [:fr]La parole est aux speakers : Kévin Dunglas (AFUP Day 2019 Lille)[:]
- [:fr]La parole est aux speakers : Maxime Huran (AFUP Day 2019 Lille)[:]
- [:fr]La parole est aux speakers : Gaël Crispyn (AFUP Day 2019 Lille)[:]
- [:fr]La parole est aux speakers : Benoit Jacquemont (AFUP Day 2019 Rennes)[:]
- [:fr]La parole est aux speakers : Rodrigue Villetard (AFUP Day 2019 Lille)[:]
- [:fr]La parole est aux speakers : Frédéric Hardy (AFUP Day 2019 Lyon)[:]
- [:fr]La parole est aux speakers : Lætitia Avrot (AFUP Day 2019 Lyon)[:]
- [:fr]La parole est aux speakers : Fabien Féat (AFUP Day 2019 Rennes)[:]
- [:fr]La parole est aux speakers : Samuel Roze (AFUP Day 2019 Lille)[:]
- [:fr]La parole est aux speakers : Antoine Deprez et Brice Taillardat (AFUP Day 2019 Rennes)[:]
- [:fr]La parole est aux speakers : Stéphane Hulard (AFUP Day 2019 Lyon)[:]
- [:fr]La parole est aux speakers : Kévin Verschaeve (AFUP Day 2019 Lille)[:]
- [:fr]La parole est aux speakers : Gabriel Pillet (AFUP Day 2019 Lyon)[:]
- [:fr]La parole est aux speakers : Grégoire Hébert (AFUP Day 2019 Lille)[:]
- [:fr]La parole est aux speakers : Vincent Lainé (AFUP Day 2019 Rennes)[:]
- [:fr]La parole est aux speakers : Freek Van Der Herten (AFUP Day 2019 Lille)[:]
- [:fr]La parole est aux speakers : Julien Deniau (AFUP Day 2019 Lyon)[:]
- [:fr]La parole est aux speakers : Frédéric Bouchery (AFUP Day 2019 Rennes)[:]
- [:fr]La parole est aux speakers : Julien Pauli (AFUP Day 2019 Lille)[:]
- [:fr]La parole est aux speakers : Alex Rock (AFUP Day 2019 Lyon)[:]
- [:fr]La parole est aux speakers : Damien Alexandre (AFUP Day 2019 Rennes)[:]