Partage d'expérience : Documentation / Guides d'utilisation d'un document

Bonjour, durant le Club Utilisateur·ices du 31 mars, plusieurs Gristeur·euses ont partagé leurs documents, et différentes méthodes pour aider d’autres utilisateur·ices à se les approprier :

  • Guide d’utilisation
  • Documentation
  • Notes de version …

Je pense notamment au Grist de @mathieugimenez , qui, pour accompagner à l’utilisation 189 utilisateurs sur 7 rôles différents, contient des vues Markdown spécifiques au rôle de chacun·e.

Je lance donc ce post pour des personnes qui voudraient partager ici leurs pratiques en terme de documentation intra-Grist :slight_smile:

4 « J'aime »

Hello, j’en profite pour alimenter la discussion avec un « changelog » que je tiens à jour pour suivre les évolutions des gros documents Grists.

Un peu comme si on faisait évoluer du code, j’ai trouvé pertinent de noter toutes les améliorations et évolutions d’un Grist, surtout quand celui-ci est d’un niveau de complexité élevé et devenu comme un « produit ».

Ça permet de garder l’historique des évolutions et aussi de mieux collaborer si on est plusieurs « Builders » à travailler sur le doc.

Afin de ne pas polluer les utilisateurs, je garde cette page dans les Données Sources, invisible à tous sauf pour les propriétaires du document.

Un exemple ci-dessous :

3 « J'aime »

Ici un exemple de note de version :


Et ici un exemple de page introductive à un ensemble de vues :

La donnée source ressemble à ça et nous permet de créer autant de page que l’on souhaite par rôle (en général une c’est déjà bien, sauf pour les rôles de supervision) :

1 « J'aime »

Bonjour !

Super conversation à côté de laquelle j’étais passée !

Alors pour notre part pour l’instant on essaie déjà de mettre en place un simple widget « Bloc-notes » avec une table « Documentation » associée.

L’idée serait d’avoir une documentation fonctionnelle (et j’aime bien l’idée d’en avoir une spécifique par rôle) et une documentation technique plus dédiée aux admins/propriétaires du document.

Enfin ça serait bien de profiter du widget « Tables et permissions » pour construire cette doc.

1 « J'aime »