J'ai découvert récemment Write the Docs, une infolettre et une communauté qui ont des perspectives inspirantes que je souhaitais vous partager. Peut-être qu'une porte de sortie du « paradigme du document » serait le « paradigme de la documentation »?
L'écriture technique pour tous
D'abord, j'étais au fait de l'écriture simple, mais Write the Docs utilise davantage écriture technique (technical writing), un terme qui manquait à ma culture. Ça m'a ouvert les yeux sur tout un champ de connaissances, comme les principes du minimalisme en communication technique ou des ressources comme les cours gratuits de Google à ce sujet.
Partager les bonnes pratiques d'écriture correspond à un principe récurent pour Write the Docs : tout le monde peut devenir un·e « ami·e de la documentation (friends of the docs) ». Plutôt que de laisser la rédaction de la documentation à un nombre restreint de personnes, ils encouragent les ingénieur·euse·s, les équipes de support et les chargé·e·s de projet à activement contribuer à ces documents. Toutes les personnes impliquées peuvent laisser des commentaires, des précisions ou même en écrire de la documentation. Pour moi, c'est une forme de savoir ouvert.
Doc as code
Mais comment inviter une diversité de parties prenantes à collaborer sur une même documentation?
Les wikis sont une manière de faire, je réalise maintenant que ce monde est plus vaste que je ne croyais. Pour Write the Docs, ils « traitent la documentation comme le code » (Docs as Code). Je suis fasciné par tous les moyens qu'ils mettent en place pour que plusieurs personnes puissent travailler sur un même document!
Bon, c'est une communauté créée autour de la documentation de logiciels, donc plusieurs outils m'échappent (comme CI/CD ou git), mais je crois que leurs principes peuvent être bénéfiques pour d'autres champs de connaissances.
- Par exemple, nous pourrions avoir des évaluations de programme social annotées et améliorées par les personnes qui sont directement impliquées (un peu à la manière d'une enquête conscientisante en continu).
- Une autre idée serait simplement de faire évoluer une même note pour nous assurer qu'elle reste à jour ou qu'elle s'améliore avec le temps.
En ce sens, je crois que nous pouvons rendre les outils d'En commun encore plus collaboratif (j'y reviens souvent). J'aimerais vous laisser avec certaines questions que pose Jodie Putrino dans sa conférence « Treating Documentation like Code: a Practical Account » (voir à 18 min). Je traduis ici :
- Comment gérer les versions?
- Comment avoir de la rétroaction sur la documentation?
- Comment publier?
- Comment travailler avec des versions bêta?
- Comment gérer les versions (encore)?
Pour moi, ces questions sont au cœur de la question de la collaboration numérique et elles restent encore sans réelles réponses dans l'environnement En commun, d'où mon enthousiasme à l'idée de vous partager ces ressources! Je trouve que la communauté Write the Docs propose des façons nouvelles et inspirantes de travailler à plusieurs dans une perspective ouverte.
Je serais curieux de savoir s'il y a des personnes qui connaissaient cette communauté et j'aimerais en parler davantage si vous souhaitez!
