AFUP Forum PHP 2019 Baromètre Planète PHP

La parole est aux speakers : Sarah Haïm-Lubczanski (AFUP Day 2019 Rennes)

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 v2

La 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é.

Le speaker

Sarah HAÏM-LUBCZANSKI
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

En poursuivant votre navigation sur ce site, vous acceptez l’utilisation des cookies pour améliorer votre navigation. plus d'infos

1. Qu’est-ce qu’un cookie?

Un Cookie est un petit fichier texte enregistré sur votre terminal (ordinateur, tablette, smartphone, etc.), à l’occasion de la consultation d’un service en ligne grâce à votre logiciel de navigation. Il permet à son émetteur d’identifier le terminal dans lequel il est enregistré, pendant la durée de validité ou d’enregistrement du Cookie. Lors de la consultation de notre site Internet, des informations relatives à la navigation de votre terminal sont susceptibles d'être enregistrées dans ces fichiers dits "Cookies". Ces derniers sont installés sur votre terminal, sous réserve des choix que vous auriez exprimés concernant les Cookies et que vous pouvez modifier à tout moment.

2. A quoi servent les cookies émis sur notre site ?

Seul l’émetteur d’un cookie est susceptible de lire ou de modifier les informations qui y sont contenues.
Les cookies utilisés sur notre site permettent :

3. Vos choix concernant les cookies

Vous disposez de différents moyens pour gérer les cookies. Tout paramétrage que vous pouvez entreprendre sera susceptible de modifier votre navigation sur notre site et sur Internet en général et vos conditions d'accès à certains services de notre site nécessitant l'utilisation de cookies. Vous pouvez à tout moment exprimer et modifier vos souhaits en matière de cookies, par les moyens décrits ci-dessous. L'accord sur les cookies L'enregistrement d'un cookie dans un terminal est essentiellement subordonné à la volonté de l'utilisateur du terminal, que celui-ci peut exprimer et modifier à tout moment et gratuitement à travers les choix qui lui sont offerts par son logiciel de navigation. Si vous avez accepté dans votre logiciel de navigation l'enregistrement de cookies dans votre terminal, les cookies intégrés dans les pages et contenus que vous avez consultés pourront être stockés temporairement dans un espace dédié de votre terminal. Ils y seront lisibles uniquement par leur émetteur.

Le refus des cookies Si vous refusez l'enregistrement de cookies dans votre terminal, ou si vous supprimez ceux qui y sont enregistrés, vous ne pourrez plus bénéficier d'un certain nombre de fonctionnalités qui sont néanmoins nécessaires pour naviguer dans certains espaces de notre site. Tel serait le cas si vous tentiez d'accéder à votre compte ou à votre abonnement qui nécessite de vous identifier. Tel serait également le cas lorsque nous, ou nos prestataires, ne pourrions pas reconnaître, à des fins de compatibilité technique, le type de navigateur utilisé par votre terminal, ses paramètres de langue et d'affichage ou le pays depuis lequel votre terminal semble connecté à Internet. Le cas échéant, nous déclinons toute responsabilité pour les conséquences liées au fonctionnement dégradé de nos services résultant de l'impossibilité pour nous d'enregistrer ou de consulter les cookies nécessaires à leur fonctionnement et que vous auriez refusés ou supprimés. Les choix offerts par votre logiciel de navigation Vous pouvez configurer votre logiciel de navigation de manière à ce que des cookies soient enregistrés dans votre terminal ou, au contraire, qu'ils soient rejetés, soit systématiquement, soit selon leur émetteur. Vous pouvez également configurer votre logiciel de navigation de manière à ce que l'acceptation ou le refus des cookies vous soient proposés ponctuellement, avant qu'un cookie soit susceptible d'être enregistré dans votre terminal. Pour la gestion des cookies et de vos choix, la configuration de chaque navigateur est différente. Elle est décrite dans le menu d'aide de votre navigateur, qui vous permettra de savoir de quelle manière modifier vos souhaits en matière de cookies. Selon votre navigateur, consultez le lien ci-dessous pour configurer votre navigateur et refuser les cookies :