Outils pour utilisateurs

Outils du site


wiki:tutoriels:tutodoc

Documentation des projets

Pourquoi documenter les projets?

La raison pour laquelle nous vous demandons de documenter vos projets est principalement par esprit communautaire: vous utilisez le matériel et les locaux du FABlab, mais en échange vous devez permettre à d'autres personnes venant après vous de refaire vos projets et éventuellement de les modifier à leur sauce. Ensuite, cela permet de garder une trace de ce qui se fait dans le lab, et ça nous permet aussi éventuellement de mettre ce que vous avez fait en exergue, ce qui peut vous donner aussi de la visibilité.

Exigences générales

Le premier objectif de votre documentation est qu'elle soit suffisamment explicite (avec si besoin des schémas) pour permettre de refaire votre projet étape par étape (en prenant les mesures de sécurité approprié) dans sa totalité, quitte à ce que ce soit uniquement technique et à ne pas expliquer dans leur totalité le fonctionnement des sous systèmes. Il est nécessaire de réserver une partie liés aux difficultés que vous avez rencontrés à chaque étape, de façon à ce qu'un utilisateur du lab puisse savoir si une erreur ou un problème qu'il a a déjà été rencontré ou si il y existe une solution.

Si vous ne savez pas comment vous y prendre

La référence actuelle en terme de documentation est la page du projet de polarimètre mené au lab dans le cadre des ateliers de recherche encadrés.

wiki/tutoriels/tutodoc.txt · Dernière modification: 2018/03/20 22:41 de lasmartresa