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

Publié le

Jusqu’au Forum PHP 2022, 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

Sauve un-e dév, écris une doc !

Vous êtes développeur ou développeuse PHP : vous aimez programmer, réfléchir. Vous aimez créer des applications ou des bibliothèques de qualité. Mais pourquoi personne ne les utilise ? Parce que votre documentation n'est pas à la hauteur !

Justement : je suis Technical Writer et mon métier est de vous aider à valoriser votre logiciel auprès de ses utilisateurs et utilisatrices, à travers une bonne doc. Comprenons comment architecturer, concevoir et rédiger votre contenu. Découvrons les outils qui vous procurerons une aide précieuse. Enfin, facilitons sa mise à jour pour qu'elle soit pérenne.

Dorénavant, vous saurez identifier les passages obligés et ceux où vous pouvez gagner du temps.

Ballroom GHJKLM - Katherine Johnson
13/10/2022
14:40-15:20

Au-delà de l’écrire, comment fais-tu pour savoir si la documentation produite est utilisée ? Est-ce qu’il y a des analytics, like ou autres métriques pour mesurer cela ?

On part déjà du principe que la documentation est connue, accessible et publiée, j’aime cette idée.
Si la documentation est publiée en ligne, sur un site web, on peut utiliser des analytics comme pour un site web de contenu. Après tout, la doc, c’est du contenu !
Sur la partie analytics, par exemple, on peut analyser les entrées qui viennent d’une recherche et utiliser ces mots-clefs comme points d’entrée. Si on propose aussi un moteur de recherche interne, même analyse possible pour choisir de mettre en avant un contenu fortement recherché, que ça soit l’Installation ou une page Troubleshooting. Certains outils suivent le parcours utilisateur sur un site web, et peuvent, par exemple, pointer un décrochage entre les étapes d’un tutoriel.
Donc, on revient à des analyses proches des stratégies SEO.
On peut également utiliser les stratégies d’analyse plus qualitatives, en mesurant le Time To Hello World. On peut aussi utiliser des outils d’analyses de liens pour éviter les liens morts ou incorrects.

Depuis que tu es Documentation Writer/Architect quel est le principal changement / la principale évolution à laquelle tu as assisté ?

Cela ne fait que quelques années que j’ai basculé vers ce domaine spécifique et pourtant, déjà durant ce laps de temps, j’ai vu le métier de Documentation Writer prospérer, signe, selon moi, de maturité du secteur logiciel.
Le changement majeur est lié à la pandémie. La communication et les traces écrites ont repris de l’ampleur. Avec un usage renforcé des solutions en ligne pour collaborer, le besoin de documentation au sens large, c’est à dire expliquer comment fonctionnent les logiciels, incluant des tutoriels, y compris vidéos, a explosé, chacun se retrouvant seul-e face à sa machine.

Tu es très engagée au niveau associatif, est-ce que pour toi ça fait partie du métier ?

Mes activités associatives, c’est, pour une analogie lyonnaise, les pralines dans la brioche. Je peux mener à bien mon métier sans l’associatif, mais c’est meilleur !
Cela me permet de croiser des tas de gens, et d’écouter et découvrir ce que font et pensent les autres, à propos de la documentation, et c’est une aide toujours bienvenue dans mon métier. Mon conseil : ne restez pas seul-e dans votre pratique professionnelle, confrontez-vous aux autres.

Une conférence présentée par

Sarah HAÏM-LUBCZANSKI
Sarah HAÏM-LUBCZANSKI
Documentation Architect 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 opensource, 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.