Comment documenter ?
C'est quoi une documentation ?
Tout projet réalisé partiellement ou intégralement au fablab doit obligatoirement être documenté sur ce wiki ! C’est un peu votre monnaie d’échange pour avoir accès aux outils du Fablab. C’est aussi un prérequis de la Charte des Fablabs.
N'hésitez pas à demander l'aide d'un.e médiateur.ice pour réaliser votre documentation !
La documentation est la trace écrite de toutes les étapes vous ayant permis de réaliser votre projet. Elle vous permet de partager vos erreurs, vos découvertes, vos astuces, vos fichiers... et sera très précieuse pour toute personne cherchant à se former, à s'inspirer, à élaborer un projet similaire.
Elle vous sera également très utile si vous souhaitez revenir plus tard sur ce projet ou sur une des techniques que vous avez utilisée, ainsi que pour communiquer sur ce projet.
Voici les éléments qui doivent obligatoirement figurer sur votre documentation
- Nom du projet
- Coordonnées (nom, prénom, adresse mail, cursus / labo)
- Introduction (date de début, date de fin estimée, objectifs, contexte)
- Matériaux / Outils / Machines (le plus détaillé possible)
- Construction (fichiers, photos, code, texte, paramètres d’usinage etc.)
- Journal de bord (étapes datées du projet, facultatif pour les petits projets)
⭐ Une documentation correcte doit vous permettre de refaire le projet de A à Z plusieurs mois plus tard.
⭐⭐ Une bonne documentation doit permettre à n’importe quel usager de refaire le projet de A à Z.
⭐⭐⭐ Une excellente documentation fait tout ça mais permet aussi de comprendre tout le processus itératif
Où et comment documenter sur ce wiki ?
Pour garder les choses à peu près organisées, on fait la distinction entre deux types de projets :
1. Les petits projets
Ce sont des projets de petite ambition technique, nécessitant un recours ponctuel aux ressources du Fablab, typiquement une seule venue au Fablab, avec peu d'étapes de développement.
Ils doivent malgré tout comporter toutes les informations minimales mentionnées plus haut.
Merci de respecter le processus suivant :
1. Vous rendre dans la section Petits projets, (elle-même dans l'étagère 2-Projets)
2. Créer une nouvelle page en cliquant sur l'action "Nouvelle page" dans le menu latéral
3. Sélectionner un modèle de page en cliquant sur la dernière icône du menu latéral à droite
4. Cela ouvre le menu latéral. Sélectionner le modèle intitulé "Modèle de documentation générique" en cliquant sur l'encadré
5. Cela fait apparaître directement le modèle dans l'éditeur de texte. Tout est prêt pour que vous commenciez à documenter, il ne reste plus qu'à modifier le contenu des différentes sections.
📸 Ne lésinez pas sur les photos et captures d’écran
⛲ N’oubliez pas d’inclure tous vos fichiers sources / votre code
2. Les projets classiques
Projets nécessitant plusieurs venues au Fablab / un développement plus important, les projets classiques ne se rangent pas au même endroit ! Par ailleurs, au lieu d'être rédigés en une seule page, ils contiennent plusieurs pages, qui peuvent même être rangées en chapitres.