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

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 ajoutez plusieurs tags. 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.

7. N'oubliez pas d'ajouter vos fichiers sources !! Pour cela cliquez sur l'icône de trombone dans le volet de droite 

Un volet apparaît. Cliquez sur "Uploader un fichier" et glissez-le dans la boîte grise.

Un grand merci de la part de toute la communauté !

 

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.

1ère possibilité : utiliser un modèle de livre

Merci de suivre le processus suivant :

A. Se rendre dans l'étagère 2 - Projets

B.1. Créer un nouveau livre depuis le menu latéral en cliquant sur "Créer livre" OU dupliquerOuvrir le livre Modèle de Projet en cliquant sur lece livrelien (ou en questionle puischerchant dans l'étagère 2-Projets)

2. Dupliquez-le en cliquant sur "Copier" dans le menu latéral

Si3. vous choisissez de dupliquer le livre Modèle de projet :

Attention à bien renommer levotre livrecopie dès lacette copieétape poursinon nevous pasrisquez de confondre le modèle et la copie

4. Déplacez votre copie !!

Par ailleurs il ne va malheureusement pas se copier directement dans l'étagère 2-"2 - Projets"

Pour cela :

• • se rendre dans l'étagère 2 - Projets
  où
  • cliquer ilsur doit"Editer" êtredans rangéle menu latéral
  • Retrouvez votre projet dans la liste de droite et glissez-le dans la liste de gauche pour l'ajouter à l'étagère des Projets
  • Cliquez sur "Enregistrer"

5. L'étagère "2-Projets" s'ouvre : cliquez sur votre projet nouvellement créé et déplacé, ilet vac'est doncparti falloirpour déplacerrédiger cevotre documentation 🔥🔥🔥

6. Cliquez sur "Editer" dans le menu latéral et changez la couverture de votre livre aupour bonune endroit.image liée à votre projet. 

A7. SUIVRE.Profitez-en pour ajouter des mots-clés en les sélectionnant dans la liste des tags. Il est interdit de créer de nouveaux tags pour ne pas créer le chaos !!

8. Vous pouvez désormais cliquer sur chaque page du template. Pour la modifier et la compléter, cliquez sur "Editer".. 

📸 Ne lésinez pas sur les photos et captures d’écran !

9. N'oubliez pas d'ajouter vos fichiers sources !! Pour cela cliquez sur l'icône de trombone dans le volet de droite lorsque vous êtes dans l'édition d'une page. Ils seront ainsi joints à la page (sans apparaître dans le corps du contenu)

Vous pouvez réorganiser l'ordre des pages en cliquant sur "Trier" dans le menu latéral (lorsque vous êtes au niveau du livre et pas à l'intérieur d'un chapitre ou d'une page).

Si vous choisissez de ne pas partir d'un livre vierge :

• Choisissez une image de couverture
• Vous pouvez ajouter des mots-clés dès maintenant (attention à ne pas créer de nouveaux mots-clés mais à sélectionner un mot-clé existant !!)
• Créez des pages et des chapitres