Disclaimer: j’ai emprunté ce terme de Vendredÿ chez Alsacreations.

Pour moi, il s’agit d’une veille des choses qui m’ont faite rire, étonnée et interpellée. Je l’envoie par e-mail chaque semaine à mes collègues, et je me suis dit « Pourquoi ne pas en faire profiter tout le monde ? »

Publicités

Vendredÿ : human pomodoro, manger du riz en chantant, jeux vidéo pour tous et LinkedIn lingo

Disclaimer: j’ai emprunté ce terme de Vendredÿ chez Alsacreations.

Pour moi, il s’agit d’une veille des choses qui m’ont faite rire, étonnée et interpellée. Je l’envoie par e-mail chaque semaine à mes collègues, et je me suis dit « Pourquoi ne pas en faire profiter tout le monde ? »

Vendredÿ: un peu de LSF, le kilo-girl et PHP est très vieux

Disclaimer: j’ai emprunté ce terme de Vendredÿ chez Alsacreations.

Pour moi, il s’agit d’une veille des choses qui m’ont faite rire, étonnée et interpellée. Je l’envoie par e-mail chaque semaine à mes collègues, et je me suis dit « Pourquoi ne pas en faire profiter tout le monde ? »

Vendredÿ: cœurs sur vous, LSF, crabe et anglais

Disclaimer: j’ai emprunté ce terme de Vendredÿ chez Alsacreations.

Pour moi, il s’agit d’une veille des choses qui m’ont faite rire, étonnée et interpellée. Je l’envoie par e-mail chaque semaine à mes collègues, et je me suis dit « Pourquoi ne pas en faire profiter tout le monde ? »

Vendredÿ : mise à jour de voiture, record de feuilles de calculs et 2e aux Jeux Olympiques

Disclaimer: j’ai emprunté ce terme de Vendredÿ chez Alsacreations.

Pour moi, il s’agit d’une veille des choses qui m’ont faite rire, étonnée et interpellée. Je l’envoie par e-mail chaque semaine à mes collègues, et je me suis dit « Pourquoi ne pas en faire profiter tout le monde ? »

Vendredÿ : Wonder-Woman attachante, la pêche omoul et ultra-distance cycliste

Disclaimer: j’ai emprunté ce terme de Vendredÿ chez Alsacreations.

Pour moi, il s’agit d’une veille des choses qui m’ont faite rire, étonnée et interpellée. Je l’envoie par e-mail chaque semaine à mes collègues, et je me suis dit « Pourquoi ne pas en faire profiter tout le monde ? »

[talk] Sans documentation, la fonctionnalité n’existe pas !

Voici la vidéo, les slides et surtout les liens complémentaires de la conférence que j’ai eu l’honneur d’animer au PHP Tour 2018 à Montpellier. J’avais intitulé ma session Sans documentation, la fonctionnalité n’existe pas ! et le titre avait déjà amené beaucoup de débats avec mes pairs. Je vous laisse donc m’écouter, me lire et, si le sujet vous intéresse, approfondir la question par vous-même.

La vidéo de la session

Les slides de « Sans documentation, la fonctionnalité n’existe pas »

J’ai pris soin de garder les animations, c’est pourquoi vous avez un grand nombre de diapos : quand il y a deux versions, c’est que j’ai gardé les versions avant et après l’animation.

 

Les liens complémentaires

Durant ma présentation, je cite des outils ou je référence le travail d’autres personnes, voici les liens complémentaires.

 

Mon interview dans le podcast Echo : gérer et maintenir une documentation

J’ai été interviewée par le podcast Echo, qui compte déjà 4 épisodes, lors du PHPTour à Montpellier, ce qui m’a donné l’opportunité de dire à haute voix ma vision de la documentation au quotidien. Si vous avez 7 minutes devant vous, c’est l’occasion d’écouter ma voix.

 

Qu’ai-je appris dans mes études supérieures qui me sert encore aujourd’hui ?

Qu’avez-vous appris dans vos études supérieures qui vous serve encore aujourd’hui ?demande Eric Daspet.

Je voudrais répondre à cette question précise car, contrairement à beaucoup de mes collègues passés, présents et futurs(?), je suis allée à l’Université. Vous trouverez sur mon profil LinkedIn/Viadeo le détail de mon cursus.

J’ai appris l’usage de Linux, ce qu’est l’opensource, lire des textes de lois (pour lire le code du travail) et les comprendre, faire une synthèse de mes idées, et à l’inverse développer mes idées, présenter à l’oral devant un public pas intéressé, travailler en binôme ou en petit groupe, lire la doc/chercher de l’aide, préparer mon boulot avant de m’y mettre, être fière de mon boulot, et LE truc précieux : faire des sauvegardes de mon travail. Cela me sert encore aujourd’hui dans mon métier.

Woman in Blue Reading a Letter, Johannes Vermeer painting

Johannes Vermeer [Public domain], via Wikimedia Commons

Ah je n’ai pas été en école d’ingé mais à la fac, c’est peut-être le détail. Les élèves en école d’ingénieur que j’ai côtoyé étaient parfois un peu trop choyés pour se rendre compte de la chance qu’ils avaient au niveau des moyens fournis.

Sur les savoirs plus informels, qui me servent encore, mais pas forcément dans mon métier, j’ai appris à m’y retrouver sur un campus universitaire et cela m’a appris à m’orienter (parfait quand tu es formatrice/consultante et que ton lieu de travail n’est pas fixe) et à demander mon chemin pour être à l’heure, boire du café, ne pas préjuger des compétences des gens selon leur apparence (quand le sysadmin de ton université ressemble à un clochard et le prof de réseaux à un poivrot, au hasard), écouter et prendre des notes (utile durant les conférences), mémoriser des tas de trucs grâce à des techniques de mémorisation, apprécier le bon café, partager l’information, et dénicher les bons livres dans les bibliothèques.

Investir et former

Même le stage de fin d’étude n’est qu’une autorisation à être un peu moins productif ou à passer quelques jours à lire des documentations.

Hé bien, là encore, mon stage de fin d’études a été prétexte à une offre d’embauche, et j’ai mis les mains dans le code, si je puis dire, sur une partie annexe et non-commerciale du projet.

FEMA - 19762 - Photograph by Greg Henshall taken on 11-28-2005 in Louisiana

Je comprends néanmoins ce que soulève Eric Daspet comme problème : l’investissement (monétaire, eh oui) sur les savoirs et le fast-savoir.
Les formations sont très bien comme démarreurs, ensuite, il vous faudra digérer tout ce qui a été vu, le refaire. Ce n’est pas après quelques jours sur une technologie ou une méthode que vous serez au point. Pire, il faudra être confrontée à l’échec pour apprendre. (Comment croyez-vous que j’ai appris pour les sauvegardes ?)
Et dans le pire des cas, il est attendu que vous sachiez déjà, ou que vous soyiez prêt à vous former par vous-même, sur votre temps personnel.

C’est un sujet de longue haleine, sur lequel je peine à me faire un avis, la veille techno sur temps de travail et hors temps de travail, donc je ne développerai pas mes idées maintenant.

La Documentation comme une punition

L’autre matin encore, j’ai entendu mes collègues parler de leurs tâches possibles pour les prochaines heures, et l’un dire à l’autre : « Tu peux écrire la documentation de telle Story, si tu veux » et l’autre répondre : « Non, je ne suis pas désespéré à ce point. »

Mes collègues sont formidables et ils me donnent l’occasion de parler de cette tradition de voir la documentation de ses développements comme une punition. Évidemment, ce n’est pas la partie la plus sexy du code de se taper la Documentation. Evidemment, c’est pas l’fun de devoir expliquer ce qu’on a brillamment conçu avec son cerveau super-intelligent pour que d’autres péons puissent comprendre le fonctionnement, sinon l’intention de votre création.

Pillory (PSF)

Cloué au pilori, la punition

Simplement, si vous avez fait vos développements super-cools, qui va savoir les utiliser hormis vous ? Qui va savoir qu’ils existent si vous n’en faites aucune promotion ?

Pour moi, la documentation sert à plusieurs personnes :

  •  Le développeur qui est forcé d’expliquer et remettre à plat l’utilité et le fonctionnement de son oeuvre.
  • Les utilisateurs qui veulent s’en servir, qu’ils soient utilisateurs techniques ou non
  • Les autres collègues, incluant le développeur lui-même dans le futur, qui sont parfois forcés de reprendre le code de quelqu’un d’autre. On disait parfois en riant : « ça a été difficile à écrire, ça doit être difficile à lire », en réalité, c’est une blague, faut pas le faire.
  • La partie marketing qui peut ainsi affirmer que la fonctionnalité existe et qu’il est possible de s’en servir

Quand vous voyez la Documentation comme une punition, en réalisé, vous punissez les personnes que je cite dans ma courte liste. Et quand j’évoque la Documentation, cela ne se limite pas aux pages écrites dans un bon anglais/français, avec des jolis exemples théoriques de code. Cela inclut les bons messages d’erreurs, les informations retournées par l’API, et les commentaires dans le code, ainsi que les diagrammes concernant l’architecture et le pourquoi de ces choix.

Le CommitStrip m’y a refait penser au point que je me suis dit que j’allais écrire un billet sur le sujet : http://www.commitstrip.com/fr/2016/07/27/documentation-just-before-vacation/

Il est temps de réfléchir et mûrir un peu sur ce sujet, ne croyez-vous pas ?