AFUP Forum PHP 2018 Baromètre Planète PHP

La parole est aux speakers : Sarah Haïm-Lubczanski

Jusqu’au PHP Tour Montpellier 2018, retrouvez nos interviews de speakers pour mieux comprendre leur parcours et le sujet qu’ils aborderont lors de leur conférence !

La conférence

Sans documentation, la fonctionnalité n'existe pas !

La nouvelle fonctionnalité est prête, tout le monde est ravi. Les utilisateurices vont-ils savoir s’en servir ? Si vous pensez que le changelog et la PHPDoc suffisent, je voudrais vous demander : pourquoi priver vos utilisateurices des meilleures parties de votre logiciel ? Je vous propose de définir la qualité minimale attendue pour une documentation 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.

Salle Morpheus
17/05/2018
15:15-15:55

Le speaker

Sarah Haïm-Lubczanski
Sarah Haïm-Lubczanski
Technical Writer chez eZ Systems, Sarah Haïm-Lubczanski a toujours préféré le contact des informaticiens spécialistes à celui du grand public, et cela a bien fonctionné puisqu'elle écrit la documentation du logiciel opensource, que produit son entreprise. 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.

Tu es ‎Technical Writer, ce qui un poste peu fréquent. Peux-tu nous en parler ?

En résumé : je suis en charge de la documentation technique du logiciel, open source, que produit mon entreprise.

Dans la communauté de la documentation (hé oui, elle existe), un terme a été trouvé qui paraît plus juste pour mon métier, il s’agit de Documentarian. Ce nouveau terme reflète mieux le fait que l’écriture de documentation est la moins fréquente de mes tâches. La majorité de mon travail est de l’architecture d’information, et de la communication avec le reste des personnes qui permettent au logiciel d’exister (les développeurs, les responsables de produits, les consultants, etc.).
Chez eZ Systems, je fais partie du département Ingénierie et je travaille avec des développeurs PHP et frontend. Ayant moi-même un passé de développeuse PHP, je me sens à même de comprendre leurs contraintes et leur boulot.
Je ne travaille pas seule, nous sommes 3 dans la Team Doc et nous collaborons au jour le jour avec la quinzaine de développeurs de la Team Dev.
Les points communs avec les développeurs PHP est que je résous des problèmes pour les utilisateurs. Je travaille au rythme des releases de notre logiciel. Les sprints rythment mes périodes de travail, et je participe à la démo et à la retrospective.

Une des difficultés dans la documentation est sa mise à jour : pour toi qu’est ce qui est le plus important pour qu’elle soit à jour ? Les outils ou les processus ?

Est-ce une question piège ?
Les outils permettent, et je n’apprends rien à personne, d’être plus efficace, une fois qu’on les maîtrise. Les processus permettent de simplifier le traitement des informations.
Par exemple, je suis ravie d’utiliser une documentation générée depuis un format texte (Markdown en l’occurence), car cet outillage a permis d’avoir un design du site web réalisé par la Team Web, qui respecte notre charte graphique et la Team Doc peut se concentrer sur le contenu sans avoir à gérer la présentation.
Et je suis également rassurée de savoir que la partie QA se fera après la Doc : notre processus est tel qu’il y a d’abord le développement, puis la documentation et ensuite la Team QA qui teste aussi la doc en regard de la fonctionnalité.
S’il fallait choisir, je conseillerais de réfléchir en premier aux processus qui peuvent être plus longs à mettre en place, que les outils.

Tu as participé à la création de plusieurs groupes d’utilisateurs locaux. Quels enseignements en retires-tu ?

Un des premiers enseignements personnels que j’en ai tirés est que j’appréciais de réunir des gens et de les voir collaborer. J’aime aider les gens, cela me réjouit.
Une autre chose que j’ai apprise est que le premier pas est le plus coûteux. Faire juste un pas est le début.
Par exemple, à Lyon, mes collègues se plaignaient qu’il « ne se passait rien » dans le PHP, alors que le précédent ApéroPHP, l’année d’avant, avait réuni 30 personnes Les développeurs Ruby, Java, Python et autres avaient des groupes actifs. J’ai donc proposé d’organiser un apéroPHP, puis un suivant, et les participants sont venus, toujours plus nombreux. La communauté PHP lyonnaise avait envie de se réunir, il suffisait de lancer un mouvement.
C’est une immense fierté que d’avoir monté la première antenne locale AFUP, et le fait que l’antenne continue de fonctionner des années après est toujours une source de satisfaction pour moi. Bravo à ceux qui ont pris la relève et qui continuent à être bénévoles.
Je crois vraiment que 2 personnes motivées peuvent monter des chouettes événements d’envergure, faites le premier pas, restez raisonnables et humbles, et les gens intéressés viendront aider. C’est ce qui s’est passé pour la Game Dev Party
La toute première édition de la Game Dev Party que j’ai organisée réunissait 15 personnes, en 2 équipes. La 13è game jam, la dernière en date à laquelle je n’ai pas participé du tout, puisque je me suis dégagée de mes responsabilités depuis quelques années, a accueilli 8 équipes ! Entre temps, la Game Dev Party a proposé des cours de jeux vidéos, un projet dans une classe, a invité des professionnels du secteur pour des conférences, et des centaines de personnes se sont rencontrées autour de la création de jeu vidéo.
N’hésitez pas à vous lancer, et essayez, car au pire, que se passera-t-il ?

La conférence

Sans documentation, la fonctionnalité n'existe pas !

La nouvelle fonctionnalité est prête, tout le monde est ravi. Les utilisateurices vont-ils savoir s’en servir ? Si vous pensez que le changelog et la PHPDoc suffisent, je voudrais vous demander : pourquoi priver vos utilisateurices des meilleures parties de votre logiciel ? Je vous propose de définir la qualité minimale attendue pour une documentation 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.

Salle Morpheus
17/05/2018
15:15-15:55

Le speaker

Sarah Haïm-Lubczanski
Sarah Haïm-Lubczanski
Technical Writer chez eZ Systems, Sarah Haïm-Lubczanski a toujours préféré le contact des informaticiens spécialistes à celui du grand public, et cela a bien fonctionné puisqu'elle écrit la documentation du logiciel opensource, que produit son entreprise. 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 :