Faire de la documentation en s'amusant
L'instant musical
Relou ...
Faire de la doc utilisateur, c'est souvent considéré comme une tâche ingrate, chiante à faire. Pour les utilisateurs, pas sûr que ça soit mieux, lire de la doc n'est pas la tâche la plus épanouissante du monde ...
Est-ce qu'on ne pourrait pas rendre l'écriture et la lecture un peu plus fun.
Vos personnages de films ou de séries préférés
Je pense que tout le monde connait ça, que ça soit pour des tests unitaires ou pour donner des exemples d'appel à une API, on a besoin d'un dataset pour illustrer nos use cases.
On connait le bon vieux John Doe, le Pierre Dupont ou encore les jeux de mots douteux type Monsieur / Madame genre Harry Covert ou autre parfois à la limite de la blague de tonton. Ça dépanne, mais c'est perfectible.
Sur notre projet, on gère des données de personnes, de foyers et de structures juridiques, on devait rédiger de la doc sur l'utilisation de nos APIs et on se disait qu'on pourrait utiliser des personnages de série pour illustrer nos cas métiers.
Après quelques échanges pour savoir si on devait prendre les personnes de game of throne ou breaking bad, finalement, on est parti sur les Simpsons.
La doc était plutôt cool à écrire, c'est très rigolo de choisir les bons persos pour illustrer les cas et c'est rigolo de mettre certains persos en situation.
Un des avantages des Simpsons, c'est que tout le monde connait ! Ça rend donc les cas documentés facilement compréhensibles.
En plus il y a tellement des personnages, de lieux etc que c'est assez simple de trouver des cas pour toutes les situations !
Comme exemple, voici une capture de l'intro d'une doc sur la gestion des autoentrepreneurs :
Voilà, c'était tout, j'espère que ça vous donnera envie et des idées pour vos docs à écrire !