En regardant des personnes naviguant sur la docs, cachés discrètement derrière leurs épaules, cela permet de se rendre compte de ce qui est fluide et de ce qui ne l’est pas.
FTUE = First Time User Experience
C’est une expression dédié à mettre en avant l’expérience utilisateurice lors de leur première utilisation d’un outil ou document. En effet, c’est une partie du design d’expérience utilisateurice des plus délicates, car les personnes naviguant sur notre site/application n’ont aucun des codes permettant de les prendre en main.
C’est pourquoi les retours des personnes qui utilisent la documentation pour la première fois sont si précieux.
« logiciel »
@nicolas a remarqué que l’utilisation du nom « logiciel » pour la section des logiciels installés sur le serveur pouvait être comprise comme les logiciels à installer sur son PC pour utiliser tel ou tel service !
Quel nom mettre à la place ? 🤔🤔🤔
courbe de progression au sein d’une page de doc
Une autre remarque que je me suis faite concerne la progression de la difficulté technique au sein d’une page de doc.
Actuellement, on commence souvent une page par des définitions de termes. Cela est lié au fait que l’on souhaite souvent utiliser les vrai termes plutôt que de les abstraire.
Cependant, c’est aussi une façon un peu rude de débarquer sur la documentation d’un service, car on doit déjà apprendre des notions avant même de savoir à quoi peut nous servir un tel service.
Je pense que ça serrait plus humains que se soit une motivations des lecteurices elles même de creuser la définition d’un terme, plutôt que ce soit nous qui « forcions » à les lire en les mettant au début de la page.
Et pour cela, on profiterai totalement de l’utilisation des termes Sphinx qui affiche la définition au survol !
Cela pose la question : où mettre ses définitions ? en bas de page ? au milieu ? ou dans le glossaire. Perso, je penche de plus en plus pour tenter de les mettre dans le glossaire. J’ai l’impression que ça permet d’alléger les pages, ce qui est sympa quand on y retourne souvent pour chercher des infos.
Globalement je me disais que ça serrait pas mal d’avoir une courbe de complexité croissante au sein des pages. C.à.d que plus on s’enfonce dans la page, plus on s’enfonce dans de la technique.
Pour ça, je trouve que la section « logiciels » est très bien à sa place en bas de page.
C’est plus compliqué pour les informations de connexions (tableaux contenant des champs techniques pour remplir des configurations), qui sont à la fois très technique et souvent nécessaires rapidement.