Comment documenter ? [Projets d'UE]

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.

Dans le cadre des projets d'UE, elle peut aussi parfois servir d'outil d'évaluation de votre 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)

⭐ 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

Dans le cadre des projets d'UE, votre enseignant.e peut également vous faire des demandes spécifiques sur la documentation, en particulier quand celle-ci sert de support à votre évaluation. Rapprochez-vous de celui-ci / celle-ci pour vous assurer des critères d'évaluation de votre documentation.

Où et comment documenter sur ce wiki ?

Dans le cadre de la documentation des projets d'UE, merci de respecter le processus suivant :

1. Vous rendre dans la section Projets d'UE 2022-2023, (elle-même dans l'étagère 2-Projets)

2. Cliquer sur le chapitre correspondant à votre UE et créer une nouvelle page dans ce chapitre en cliquant sur l'action "Nouvelle page" dans le menu latéral. Cela ouvre une nouvelle page vierge dans un éditeur de texte.

3. Toujours dans l'éditeur, sélectionner un modèle de page en cliquant sur la dernière icône du menu latéral à droite. Cette étape n'est pas obligatoire mais vous permet de plus rapidement inclure les éléments essentiels attendus.

4. Cela ouvre un volet 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

On insère une image en cliquant sur l'icône d'image dans le menu du haut de l'éditeur.

6. Ajoutez un / des tags à votre page.

Entrez les premières lettres du tag puis sélectionnez-le. Vous pouvez ajouter plusieurs tags. Au besoin voici comment afficher la liste des tags existants. Une fois que c'est fait, vous pouvez refermer le volet en cliquant sur la flèche rouge.

Attention de bien sélectionner un mot-clé existant et de ne jamais en créer un nouveau pour éviter le chaos général !

Si le mot-clé que vous cherchez n'existe pas et que vous pensez qu'il mériterait d'apparaître sur ce wiki, rapprochez-vous d'un.e médiateur.ice ou d'un.e responsable de l'espace.

7. N'oubliez pas d'ajouter vos fichiers sources !! Pour cela cliquez sur l'icône de trombone dans la menu latéral de droite. Le volet s'ouvre. Cliquez sur "Uploader un fichier" et glissez-le dans la boîte grise.

   

Bonne documentation et merci de la part de la communauté des usager.ères du Fablab !