Compte-rendu personnel de la BoF « Documentation »

JRES a également vu la tenue d'un certain nombre de BoF (réunions informelles). Par exemple, celle sur la documentation du travail quotidien d'ingénieur système a permis un grand défoulement car le cadre relativement informel de la BoF permettait à tout le monde d'avouer ce qu'il faisait... qui était parfois loin des Bonnes Pratiques.

Les Wiki semblent avoir le vent en poupe, la majorité de ceux qui ont parlé en utilisent pour la documentation quotidienne. Mais deux ou trois citaient aussi les outils de gestion de tâches comme Request Tracker. Un participant s'est inquiété de ce que l'on ose laisser la documentation sur un Wiki, que « n'importe qui pouvait modifier » et où il n'y avait pas de validation mais cette inquiétude ne semblait pas partagée.

Pour les images et plans du réseau, la solution plébiscitée semble être de tracer le plan ou le schéma sur un tableau blanc, de le photographier avec un appareil numérique et de mettre le JPEG sur le Wiki. Bref, on est loin de SVG et des méta-données :-) Un participant fait la même chose pour son plan de câblage : on photographie les locaux techniques (cela a nécessité l'achat d'un appareil spécial, à grand angle) et cela tient lieu de plan.

Parmi les outils plus lourds mentionnés, citons Alfresco (http://www.alfresco.com/) ou Nuxeo (http://www.nuxeo.com/).

La question du stockage des mots de passe a fait l'objet d'un débat animé, avec des solutions techniques (des logiciels qui stockent les mots de passe dans une base chiffrée) ou bien humaines (réunion physique bimestrielle où chacun s'assure qu'il a bien la liste des mots de passe à jour) en passant par le classique papier dans le coffre.

On a aussi évidemment parlé des processus humains (celui qui ne documente pas, celui qui s'obstine à utiliser du texte brut alors que les autres font des mickeys qui bougent ou, inversement, celui qui s'obstine à n'utiliser qu'Excel alors qu'aucun de ses collègues n'a MS Office). La tonalité générale était relativement optimiste : on arriverait toujours, à force d'insistance et d'exemples édifiants, à obtenir que les informaticiens documentent (tenir la documentation à jour restant le plus gros problème, le second étant la capacité de la documentation à être comprise par d'autres que son auteur).



Discussion

pierre-antoine.angelini@univ-rennes1.fr, %2007/%11/%29 %11:%Nov:

nous avons également noté la nécessité de rendre la documentation électronique disponible en tout temps, y compris lorsque “tout est planté”. Les tenants des solutions simples (wiki) et donc plus robustes, se sont opposés aux tenants de solutions plus complexes (nuxeo, alfresco). La notion d‘export des données dans un format lisible (HTML, texte) prenait alors tout son sens. Dans le cas du CRI de Rennes 1, le wiki (mediawiki) est journellement exporté vers une clé USB, qui est lisible sur un ordinateur portable.

Olivier Berger, %2007/%12/%13 %17:%Dec:

Pour info, un bon outil qui permet de faire des images statiques de sites dynamiques : htttrack (http://www.httrack.com/)

Super pour faire un backup périodique d‘un wiki ou de tout autre outil style CMS...

blog/compte-rendu_personnel_de_la_bof_documentation.txt · Dernière modification: 2007/11/29 11:17 par olivier.lumineau@cru.fr
Logo RENATER
Logo CRU
Logo UREC
Logo INRIA