Vers une documentation centralisée pour les utilisateurs de WIMS ?

Le but de cet article est de faire un point sur la documentation de WIMS et de proposer des pistes d’évolution. Il ne concerne que la documentation pour les utilisateurs. Je ne considère pas les aides pour les développeurs. J’écris avec mon expérience de formatrice WIMS …

Une documentation riche mais dispersée

Chacun peut apprécier les aides locales au bout de chaque ligne, en haut de chaque plage … En plus des aides locales qui sont essentielles, diverses documentations sont disponibles.

  • Par le menu « Documentation » de l’Accueil WIMS, on accède au Guide, aux tutoriels, à la FAQ (et à la Doc technique en anglais qui concerne les développeurs).
  • Sur le site de WIMS EDU, on a accès à deux versions pdf des fiches ( version 1 et version 2) et au forum.
  • Sur le wiki de WIMS EDU (lien sur le site de WIMS EDU), les fiches sont accessibles en version html.
  • Pendant plusieurs années, les stagiaires et les nouveaux adhérents à WIMS EDU ont reçu le Guide de Fabrice Guérimand qui a commencé à être mis en ligne (quel accès ?).

Description des différentes aides

  • Le Guide en ligne du menu « Documentation » a été rénové quant à son aspect mais il ne parle ni d’examen, ni de glossaire, ni des nouvelles possibilités de notations.
  • Les tutoriels sont conçus pour une première prise en main et n’ont pas vocation à remplacer une aide complète.
  • Les fiches sont plutôt des mémos basiques sans commentaire ; par exemple des commentaires seraient utiles pour le réglage d’une feuille, la fiche correspondante, comme c’est son objectif, ne donne que les consignes techniques.
  • Le guide de Fabrice apportait des commentaires intéressants avec le défaut d’une documentation papier qui se périme vite.

Tous ces documents demandent un gros effort de mise-à-jour.

Difficultés pour les utilisateurs

Les aides locales sont parfois incomplètes malgré les efforts de Bernadette, Sophie et d’autres mais leur plus grand défaut est d’être accessible uniquement depuis le lieu où elles sont utiles. Par exemple, si vous voulez les détails du fonctionnement d’un examen ou du glossaire, il faut en créer un dans votre classe. Marie-Joëlle a découvert grâce à un étudiant une aide intéressante sur les notes mais elle ne peut y accéder en tant qu’enseignante. Ainsi, il est difficile d’avoir une vue d’ensemble des fonctionnalités de WIMS.

Les utilisateurs se plaignent que la documentation est dispersée (où ai-je lu cette info ?), partielle dans chaque dépôt, que tout n’est pas écrit et que certains « trucs » ne se transmettent qu’oralement. Pour les experts, la mise à jour est lourde.

Proposition

Une grande partie des difficultés vient de la dispersion de l’aide. Il me semble qu’il serait économique et efficace de concentrer nos efforts sur le Guide en ligne (accessible par le menu « Documentation ») pour le compléter par toutes les aides locales qui seraient remplacées par un lien vers le Guide.

On remarque que la plupart des logiciels présente un lien « Aide » pour la totalité de l’aide et parfois aussi un lien « Nouveautés ».

Le projet d’une documentation centralisée dans WIMS me semble de plus en plus nécessaire en effet les utilisateurs réclament de trouver plus facilement l’aide, les experts en sont réduits souvent à signaler le lieu de la réponse à la question pour mener les utilisateurs à l’autonomie. De plus, tout n’est pas documenté.
Voici une tentative de cahier des charges pour ce projet :

  • regrouper l’aide à un seul endroit ;
  • choisir une technologie éditoriale adaptée (DocWIMS, plis, bulle d’aide, bouton d’aide …) ;
  • définir une structure globale (fiche, commentaires …) ;
  • encadrer la rédaction de l’aide et la compléter ;
  • organiser les mises à jour et les modifications des aides à venir.

Il me semble que ce chantier requiert une équipe de réflexion formée d’utilisateurs et de développeurs, comptant au moins un informaticien, pour affiner le projet, ensuite il faudra envisager l’organisation du transfert des aides et de la mise en place des liens qui permettraient de corriger l’aide et de la compléter.
Nous pourrions en parler au colloque d’Amiens.


Marie-Claude DAVID

Au sujet de Marie-Claude DAVID

mathématicienne, maître de conférences retraitée, chargée de mission WIMS à l'université Paris Sud.

3 commentaires :

  1. Merci, Marie-Claude de resoulever le problème.
    La question est en effet la maintenance. Deux exemples: les sources tex du livre de Fabrice ont été mises dans le dépôt wimsmodules sur sourcesup en 2012-2013 (après que je l’ai coupé en morceaux pour qu’il soit plus facilement modifiable et mise en jour) et peut donc être mise à jour ou même compilé en un pdf. Le principe des fiches a été décidé par des adhérents de l’association en mai 2012. Une liste d’adhérents ayant accepté alors de la maintenir a été créée. Quand une erreur a été signalée à cette liste, il n’y a aucune réponse (plus précisément, une des personnes s’étant engagée au départ m’a demandé d’en être enlevée).

    Si vous avez un plan très précis pour le guide général et qu’il est maintenu, il doit être possible de récupérer les aides locales par un script (n’oubliez pas la version anglaise). Les aides locales sont maintenues par l’équipe des développeurs et ce sont les seules qu’elle peut maintenir. Nous sommes bien sûrs preneurs de toute remarque sur une telle aide mal formulée ou inexacte.

  2. Après enquête, la phrase « Marie-Joëlle a découvert grâce à un étudiant une aide intéressante sur les notes mais elle ne peut y accéder en tant qu’enseignante. » est inexacte.

    L’aide en question est accessible an tant qu’enseignant, mais pas en tant qu’élève
    (sur la conséquence des coefficients des exercices d’une feuille sur la note).
    Elle est rédigée en vue des enseignants. En formation, les élèves sont souvent aussi … des enseignants.

    Par contre, il est vrai que cette aide n’est pas « protégée » au sens où un élève en rajoutant ce qu’il faut dans l’url peut obtenir cette aide. C’est peut-être un bogue sans conséquence ou à corriger, je ne sais pas.

  3. Bonjour,

    J’ai effectivement découvert une aide intéressante grâce à un étudiant (master meef) en formation. J’avais l’impression qu’il était connecté comme élève mais peut-être ai-je tort. Quoiqu’il en soit, j’ai été et je suis toujours incapable de retrouver cette page et c’était surtout ce point qui me semblait important.

    Pour ma part, en tant qu’utilisatrice, l’éparpillement des aides pose un vrai problème que ce soit en tant que développeuse occasionnelle, qu’en tant qu’utilisatrice. Je suis d’accord pour y réfléchir pendant le colloque d’Amiens.

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *

*

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.