En ce moment, je me suis abonnée à plusieurs newsletters. Surtout via Substack, qui quand tu es abonnée à une newsletter, te propose de t’abonner à d’autres en rapport avec le contenu, ou plus largement.
Je reçois donc du contenu dans mes e-mails et… je le lis. Avec plaisir, parfois avec retard, mais je lis tout. J’aime bien l’idée qu’on m’écrive à moi. Évidemment que ma boîte e-mail est également pleine de spams.
Je consomme ces messages comme les flux RSS des blogs auparavant. Enfin, je continue à lire des blogs via mon lecteur de flux RSS, en l’occurrence Feedly, que je paye une année sur deux environ, selon mon envie de soutenir l’outil et mes finances.
Vous aimeriez savoir, je suppose, à quelles newsletters j’ai souscrites ? Pour en citer quelques unes, voici : au départ, j’ai souscrit à Absolument Tout : https://absolument-tout.net qui comme son nom l’indique va parler de sujets variés mais toujours en creusant un peu.
Autour de mon métier (documentation logicielle et écriture de contenu, et plus largement l’informatique) :
Est-ce que j’ai eu envie de publier moi aussi, une newsletter ? Tout à fait. Est-ce que je me suis également souvenue de ce blog ? Absolument. Et j’ai donc renoncé à cette affaire de newsletter au profit de ce billet qui déclare mon intérêt pour des newsletters.
On me promet que l’IA va remplacer le travail des Technical Writers, en écrivant la documentation à leur place. Je souris et réponds que j’ai hâte de partir en vacances prolongées. Et je me rappelle qu’on avait promis la même chose aux Traducteurs et Traductrices professionnelles : les outils de traduction automatisées allaient faire disparaître leur métier. J’imagine que cela a pu ébranler et faire évoluer la profession de traduction…mais je crois que l’expertise et la qualité sont toujours attendues par les professionnels.
En octobre, j’ai eu la chance de donner une conférence au Forum PHP 2022 sur la documentation technique.
De mon côté, je peux raconter que cette aventure était fort sympathique. Il faut commencer par comprendre que mes idées de conférences, j’en ai une note remplie. Je dois avoir 25 à 30 sujets notés, avec plus ou moins de détails. J’ai eu la chance de pouvoir discuter de mes 10 sujets préférés avec une Duchess qui avait proposé de mentorer des oratrices sur des sujets techniques et d’aider à trouver des sujets. J’en ai plein, des idées. Le plus dur est de les évaluer !
L’idée derrière cette conférence
Un des premiers titres de cette conférence était « Soigner son projet : comment bichonner sa documentation ? »
Mon idée était de dire que la documentation apporte de la valeur ajoutée au logiciel. C’est une idée que je défends à chaque prise de parole en public lors de conférences. Aucune surprise sur le thème et la thèse défendue.
La préparation de cette conférence
Répondre au CFP demande de la confiance en soi, surtout. Savoir que l’on sera capable d’assurer une conférence. D’avoir le temps et la disponibilité de préparer la conférence.
Ne pas rater la date limite est la principale difficulté logistique. Il faut aussi vérifier que l’on sera disponible aux dates de ladite conférence. Ce serait ballot de postuler si l’on sait déjà que l’on ne pourra pas y aller.
Préparer le contenu
Je ne peux que remercier infiniment la patience de mes collègues, qui m’ont aidée à ciseler un sujet pour répondre au CFP de l’AFUP, avec des mots percutants, mais en conservant mes choix, mes idées et mes mots favoris.
Pour préparer le contenu, je me suis appuyée sur ce que je passais du temps à répéter à mes collègues, sur Twitter, en Meetup, bref dans toutes mes conversations professionnelles. J’ai tâché de respecter ce que j’annonçais dans mon sujet en divisant le contenu en 3 parties : Architecturer, Écrire la documentation et Améliorer la documentation existante.
Évidemment, je me suis bien prise la tête pour deux éléments qui sont mes points d’amélioration constants pour les conférences : avoir des parties d’importance équivalentes en temps, et le storytelling. Les parties se devaient d’être équivalents en importance, car chaque partie touche en fait une audience un tout petit peu différente.
Je prépare donc un plan, de plus en plus détaillé, jusqu’aux idées que j’afficherai sur mes diapos.
À chaque fois, j’essaye de prévoir un plan d’histoire, un format pour structurer mon discours. Je rêve d’avoir un storytelling en spirale, avec une boucle d’histoire qui se referme sur elle-même à la fin. J’en suis encore loin. Si loin qu’en préparant, je voulais faire une blague sur la série « Heroes« , où une phrase est répétée « Save a cheerleader, save the World », et en testant auprès d’une copine, elle m’a fait remarquer la date de la série télé. La copine m’a demandé l’âge du public-cible, et on en a conclu que la blague serait totalement perdue.
Répéter, encore et encore
Une fois que le contenu est prévu, que j’ai répété. Par parties au départ. Puis, en enchaînant deux parties, pour bosser la transition. Et, ensuite, à chaque fois que possible, je l’ai répétée en entier, le chronomètre à la main. Je note dans les Notes de Conférencière les temps auxquels je suis censée me trouver lors des transitions notables (après l’introduction, après chaque partie, car toutes les parties ne sont pas toujours de la même durée).
L’avant-conférence
En fait, le Forum PHP dure deux jours. Et puis, en tant qu’oratrice, je suis invitée à dîner la veille, et je voyage en train, avec des collègues qui vont aussi donner une conférence. On pourra donc parler des Jours J au pluriel.
Quoi qu’il en soit, nous arrivons à Eurodisney (oui, le nom actuel est Disneyland Paris, je suis une vieille personne, que voulez-vous), et déjà, je suis tendue. Le monde factice et forcé que me propose Disney n’est pas du tout mon truc. Le pire reste la musique dans les rues du Village. Pourtant, j’ai les cheveux violets, je porte des tee-shirts avec des références pop culture, et des accessoires kawaii. Je peux me fondre dans le décor des fans de Disney sans problème. Avec mes collègues, nous décidons de nous installer à l’hôtel avant d’aller prendre un apéro, visiter le Disney Village et rejoindre le restaurant.
L’hôtel me plaît pour un ensemble combiné de raisons : je ne vais que rarement seule dans ma chambre à l’hôtel, c’est un luxe pour moi. Il y a une piscine, et me baigner est une de mes activités favorites. Et la décoration est sur le thème Tic&Tac et rangers canadiens. La déco dans les tons forêt et sous-bois me tranquillise. Bref, je déballe mes affaires, puis je rejoins les autres.
Je retrouve avec plaisir l’équipe de l’AFUP, d’ancien-nes collègues, et le dîner est chouette comme tout, tant au niveau des plats que de la convivialité.
Le jour J
Ma présentation est programmée l’après-midi du premier jour. C’est chouette, car je sais que le soir même, je serai détendue, et le lendemain libre d’assister aux autres conférences sans tension ni stress. Évidemment, la programmation aurait été différente, j’aurais quand même tâché de tirer le meilleur parti de mon placement dans le programme.
Le jour J, je revêts ma tenue confortable que j’avais préparée en amont. Manque de bol, j’ai vu ensuite à la vidéo que ma jupe à carreaux « vibre » un peu trop à l’image. C’est la vie ! J’ai répété le contenu, mais je n’ai pas répété… ma tenue ! Ensuite, j’essaye de manger, boire et respirer. Quand la tension devient trop forte, je me réfugie dans la super salle Speakers.
Je répète une dernière fois pour me rassurer, plus que pour vérifier, que le timing est correct. C’est le cas, je fais un « perfect ». Me voilà un peu plus détendue.
À la pause précédent mon intervention, je branche mon ordinateur et je teste le passage des diapos, cela permet aussi à la régie et aux orgas. de voir que tout va bien. Etant moi-même dans l’équipe d’orga de certaines conférences, je sais que c’est mieux.
Durant ma conférence, je suis d’abord impressionnée par le nombre de personnes dans l’audience. Je prends les gens en photo, et après avoir été présentée par un membre de l’orga, je commence à parler. Évidemment, quelques couacs surviennent, la télécommande pour passer les diapos ne fonctionne plus. Et, dès que je commence à parler, le silence se fait, me voilà avec environ 300 paires d’oreilles attentives, qui vont m’écouter parler de la doc et donner mon avis et mes préconisations pour faire une doc de qualité. Je suis lancée, je déroule mes idées, les répétitions devant des gens réels m’ont permis de savoir quand prendre mon temps et détailler, quand passer à la suite. Tout se déroule comme attendu.
Comme toutes les autres conférences que j’ai données, cela passe bien assez vite. Je ne me souviens quasiment pas de ce qui s’est passé.
Juste après la conférence
Je respire, je savoure. J’accueille les questions. Je me rafraîchis, puis je file sur le stand de mon entreprise pour accueillir les questions suivantes. Des personnes viennent me parler de leur documentation, demander des conseils, poser des questions, lancer des débats.
C’est toujours très intéressant et j’en apprends énormément. Et puis, je suis enfin libérée et je peux profiter des animations du Forum PHP.
J’ai même testé la piscine de l’hôtel où je résidais, Euro Disney oblige, je voulais tester.
Ce que j’en retire
Déjà, de la fierté : j’ai parlé devant 300 personnes de mes idées sur la documentation. C’est une sorte d’achievement.
Ensuite, je suis ravie des interactions post-conférence, où des personnes sont venues me demander leur avis sur leurs projets, me dire un mot gentil et me remercier d’avoir exposé mes idées.
Enfin, je suis contente d’avoir participé à la communauté de l’AFUP et PHP, celle dans laquelle j’ai fait mes premiers pas. Je suis aussi contente d’ajouter des femmes au programme de conférences informatiques, étant persuadée que la représentation compte. J’ai le (pas si) secret espoir d’inspirer d’autres informaticiennes à se lancer.
Écrire et produire du contenu est un travail. C’est un fait. Écrire sur le Web, écrire pour partager des idées, écrire pour optimiser la trouvabilité par des humains, par des moteurs de recherche, toute forme d’écriture demande de l’investissement. En temps, en énergie.
C’est la raison pour laquelle, j’aime Twitter et son format court, synthétique. J’aime ciseler des messages percutants, citer mes collègues dans leurs propos les plus embarrassants hors-contexte.
Cependant, avoir ma propre plate-forme pour écrire et publier mes idées me semble important ; d’autant plus que je prends de l’espace ce faisant. Et considérant que je trouve mes idées et points de vue importants, prendre de l’espace « sur les autres » est un acte politique.
Qui sont ces autres que j’estime prendre trop d’espace ? Vous l’aurez deviné, on est dans « les mecs de la Tech ». Je fais pourtant partie de cet univers professionnel depuis 20 ans. Je n’ai pas les idées les plus novatrices, les plus fraîches. Je reste persuadée que si je consigne mes pensées ici, je pourrais relire, évoluer, discuter et progresser. Au final, j’aime apprendre des nouvelles choses, je ne pense pas être « aboutie » ou dans ma forme finale.
Je reçois beaucoup de questions sur les outils à utiliser. J’ai décidé d’y répondre ici.
Comment documenter de façon économique un projet open-source, fait sur le temps libre ?
Les générateurs statiques sont très efficaces, et en version hébergée pour vous, il n’y a pas, en 2020, tant de solutions que cela. Mes recherches ont été faciles.
En fait, j’ai identifié 4 solutions pratiques qui supportent le Markdown :
Github Pages : un Jekyll rattaché à vos projets hébergés sur Github
Gitlab Pages : à vous de choisir le générateur statique qui vous convient.
ReadTheDocs (gratuit pour les projets open-source) : choisissez entre deux parfums, un Sphinx ou un MkDocs, pour utiliser le format de fichier qui vous convient le mieux.
Gitbook (gratuit pour les projets open-source) : solution propre, l’équipe est à Lyon.
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 ? »
La faute de l’orthographe par Arnaud Hoedt Jérôme Piron
Nous avons été prof de français. Sommés de nous offusquer des fautes d’orthographe, nous avons été pris pour les curés de la langue. Nous avons écrit pour dédramatiser, pour réfléchir ensemble et puis aussi parce qu’on a toujours pensé que l’Académie Française avait un vrai potentiel comique.
La NASA publie des documents des misisons Apollo, à l’occasion des 50 ans de cette mission, notamment les « Flight Journals » et les Kit de Presse, avec les budgets, les listes des appareils mais aussi les observations sur le sommeil des participants, etc.
Toute la documentation, quoi ! https://www.nasa.gov/specials/apollo50th/press.html
Les ponctuations rarement utilisées (désuètes, pourrait-on dire)
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 ? »
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 ? »
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 ? »
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 ? »
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 ? »
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 ? »
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 ? »
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 ? »
Les « sushis » imprimés en 3D
En fait, toute une réflexion sur la texture et l’automatisation, par une entreprise Japonaise : Open Meals http://www.open-meals.com/