6.2 La documentation utilisateurices
La documentation utilisateurices
À la différence de la documentation technique, les documents utilisateurices sont généralement assez éloignés des aspects techniques (code utilisé, administration serveur) du service numérique et décrivent simplement la manière dont on peut l’utiliser.
Une documentation utilisateurices décrit chaque caractéristique du service et les différentes étapes nécessaires pour l'utiliser. Une bonne documentation peut aussi aller jusqu'à fournir une assistance minutieuse en ligne. Il est très important que les documents ne soient pas confus et qu'ils soient mis à jour à chaque changement de version de l’outil. Il n’est pas nécessaire de les structurer d'une façon particulière, mais il est très important qu'ils aient une logique, une sommairisation et une arborescence précises.
Quels contenus dans une documentation ?
Dans une documentation, on retrouve traditionnellement du contenu texte. Mais il est également conseillé de compléter ce texte, surtout dans le cas de tutoriels, par l’ajout d’images, de gifs, voire de vidéos, permettant d’être parfois plus précis et moins long.
Attention toutefois à l’excès de vidéos ! Comme le rappelle le pouet ci-dessous (et l’enfilade qu’il a suscité), ce format ne présente pas que des avantages, surtout si la vidéo est longue. Un conseil, variez les contenus et leurs formats. Si vous faites des vidéos, privilégiez des vidéos courtes et pensez à les retranscrire par souci d’accessibilité.
Les différentes formes de documentation
Vous pouvez présenter votre documentation sous différents formats et supports. Votre site web peut déjà inclure un certain nombre d’informations sur vos services numériques, leurs fonctionnalités, et même des modes d’emplois (sous forme de PDF par exemple, comme proposé par certains sites tels que Chorus Pro et l’Institut national du Patrimoine pour Moodle).
Le plus souvent, toutefois, un espace de documentation dédié est proposé, souvent sur un sous-domaine ou une extension. Ce site web dédié peut alors prendre de nombreuses formes.
Découvrons ensemble les principaux formats utilisés pour partager de la documentation à ses utilisateurices. Ces formats, au demeurant assez proches, ont toutefois des logiques, des arborescences et des outils dédiés différents.
La documentation « classique »
De nombreux CMS (content management system, ou système de gestion de contenu) permettent d’héberger des systèmes de documentations destinées à des utilisateurices avancées ou au grand public. Ces CMS sont dédiés à cette tâche et leur ergonomie (souvent minimaliste), leur UX design et leur arborescence sont donc particulièrement bien adaptés. Notons notamment la logique d’arborescence progressive dans la barre latérale qui permet de cheminer dans les chapitres, puis dans les sous-parties, permettant ainsi de facilement s’y retrouver et d’apprendre.
Il existe plusieurs CMS dédiés à la documentation. Citons Readthedoc, qui propulse par exemple la documentation de Nextcloud, et propose une version gratuite pour les projets open source. Ou encore Gitbook et l’extension WordPress Heroic Knowledge Base. Notons également que de nombreux CMS statiques open source et gratuits proposent des thèmes dédiés à la documentation, comme Hugo, Grav, ou Jekyll. Bien sûr, il est tout à fait possible de développer son propre outil de documentation.
Exemple : Nextcloud
Le wiki
Le wiki peut être légèrement détourné de sa fonction initiale (être un espace de connaissances pour toustes, rédigé par toustes), afin de servir d’espace de connaissances pour les utilisateurices d’un service, et rédigé par les parties prenantes dudit service.
Ainsi Mediawiki, Yeswiki, ou encore Dokuwiki, peuvent devenir de parfaits espaces de documentation. Si ces outils ne sont pas initialement dédiés à la documentation d’un outil numérique, ils sont tout à fait indiqués, en prévoyant quelques détournements UX et graphiques, notamment dans l’arborescence, pour qu’il soit facile de se repérer dans les guides et permettre une certaine progression.
Les outils de wiki sont conçus à la base pour que tout le monde puisse créer et éditer des pages. Selon votre stratégie communautaire, cette possibilité technique pourra être activée ou non.
Exemple : Movilab, la documentation libre (et mutualisée) des Tiers Lieux
La base de connaissances
Les bases de connaissances sont en général des services fournis
dans des suites logicielles dédiées au support client incluant un
système de ticketing, un chatbot et une base de connaissances, les
trois systèmes étant reliés.
Dans une base de connaissances, une part importante est donnée à la recherche par mot clé. C’est pour cela également que, souvent, les systèmes de support fonctionnent de pair avec la base de connaissances. Ainsi, quand l’utilisateurice fait une demande de support (par mail ou via un formulaire de contact), ses mots clés sont analysés pour lui proposer des fiches de la base de connaissances lui permettant éventuellement de résoudre son problème en toute autonomie.
C’est la principale distinction entre une base de connaissances et une documentation plus « classique » comme celle que nous avons présenté plus haut.
Exemple : Infomaniak
La documentation auto-portée
La documentation « auto-portée » est le principe d’une documentation qui est présente un peu partout dans le service/logiciel plutôt qu’à un seul endroit centralisé. C’est une autre forme d’affordance : on profite de certains espaces du service numérique pour transmettre des informations à ses utilisateurices.
Exemple : Framaspace
Le service Framaspace, basé sur l’outil Nextcloud, propose de la documentation auto-portée. Ainsi, c’est tout en utilisant le service que les utilisateurices accèdent à des informations sur son fonctionnement. Par exemple, sur Framaspace, c’est la partie éditable située en en-tête d’un dossier qui est utilisée pour donner des informations sur la nature du dossier partagé.
Exemple : YesWiki
Le logiciel YesWiki propose lui aussi une documentation auto-portée depuis la version doryphore 4.3. La documentation, accessible
directement depuis chaque wiki, suivra les évolutions liés aux
changements de version. Il est possible d'y accéder en
ajoutant à l'url de chaque wiki /?doc (ex : https://monwiki.fr/?doc). Pour en savoir plus, vous pouvez visionner la vidéo ci-dessous :
Mettre à jour la documentation
L’un des pièges de la documentation, c’est sa propension à s’étaler dans tous les sens, et à ne plus être mise à jour. Or les logiciels et services numériques évoluent en permanence, et les documentations doivent suivre. C’est un véritable effort qu’il ne faut pas sous-estimer.
Pour vous faciliter le travail, voici quelques pistes :
- Programmer une tâche récurrente (1 ou 2 fois par an : relire, nettoyer et mettre à jour la documentation).
- À chaque mise à jour de service, inclure une tâche de mise à jour de la documentation.
- Éviter de doublonner les informations dans votre documentation. N’hésitez pas à renvoyer vers des pages dédiées plutôt que de recopier l’information, cela fera deux fois moins d’information périmée et à mettre à jour.
- Proposer un moyen facile à vos utilisateurices de vous suggérer des erreurs, liens cassés et autres éléments à revoir dans votre documentation.
- Réfléchir aux liens externes que vous insérez dans votre documentation (quelle pérennité peut-on espérer ?) et les vérifier de temps en temps.
L'importance de la documentation en interne
Au delà du fait qu’une bonne documentation permettra à vos utilisateurices de plus facilement appréhender vos services numériques, l’intérêt de cette documentation se retrouve également en interne.
En effet, c’est en naviguant dans votre propre documentation que vos chargé⋅es de support client répondront aux demandes, en s’aidant de copier/coller de certains passages. La documentation permet également à chacun⋅e, toujours en interne, de rester à la page des outils et services numériques. D’ailleurs, il y a des enjeux à documenter les choix techniques, mais aussi stratégiques, de communication. Pour garder trace, pour faciliter l’arrivée de nouvelleaux salarié⋅es dans votre structure, etc.
Quelques exemples de documentation
Notre avis :
Une arborescence très claire et détaillée. La documentation est poussée, avec des différences de niveau entre “prise en main”, “prise en main détaillée”, voire “prise en main très détaillée”. En revanche, toute la documentation ne respecte pas forcément la même logique d’arborescence, ce qui peut être un peu perturbant.
Notre avis :
Une page d’accueil aux couleurs du service, très compréhensible qui permet d’accéder rapidement aux contenus. Ces derniers sont présentés de manière hiérarchisée, par type d’outil, et au sein de chacun en partant des fonctionnalités les plus courantes à celles plus avancées. On apprécie le souci de simplicité, le design et le fait de pouvoir naviguer facilement au sein des contenus.
Notre avis :
Là encore, une documentation très complète. Une très intelligente page Quoi de neuf pour les utilisateurs de Nextcloud latest. Une arborescence claire. En revanche, certaines pages sont non traduites, ce qui pour un logiciel aussi démocratisé que Nextcloud, peut être mal perçu.
Déléguer ou mutualiser la documentation
Il est possible de déléguer la réalisation de la documentation à des partenaires qui sauront faire ce travail de synthèse et de pédagogie mieux que vous. Vous n’avez peut-être pas la compétence en interne, ni la possibilité de recruter un profil de ce type. Dans ce cas, déléguer peut être une bonne option.
Vous pouvez aussi demander à la communauté de vous aider dans la réalisation de cette documentation. Sur le site https://contribulle.org/ vous pouvez publier des appels à contribution et trouver des personnes vlontaires pour participer à la réalisation de votre documentation.
Il y a également la possibilité de mutualiser cette activité avec des structures qui partagent les mêmes services que les vôtres. Dans ce cas, vous pourriez mutualiser un seul site de documentation (incluant la FAQ – les questions les plus posées), voire un forum d’entraide. Vous pourriez alors mutualiser un poste dédié à l’entretien de cette documentation avec les autres structures concernées.
Un groupe de travail a commencé à réfléchir à ce sujet au sein du collectif CHATONS. N’hésitez pas à prendre connaissance de la discussion sur le forum et du compte rendu de la réunion.
Pour aller plus loin :
- Guide Comment créer une base de connaissance ? par Zendesk.
- Article Comment créer un manuel d'utilisateur sur Wikihow.
- MOOC Rédiger une documentation utilisateur par la Direction des usages numériques de l'Université de Strasbourg.