Documentation AOP Tous Makers¶

À la fin de l'AOP Tous Makers, la note sera basée sur la documentation produite sur ce wiki.
La documentation doit permettre à un tiers de reproduire votre expérience avec le même résultat ou d'en tirer une version modifiée.
Voici un guide et un exemple de documentation.

Vidéo tuto sur la documentation : https://tube.aquilenet.fr/w/9jLwLWXNagcJJJr2Xj4f8n

Pourquoi documenter ?¶

Si vous ne documentez pas ce que vous essayez c'est un vécu .
Si vous le documentez de manière à ce qu'il soit reproductible, cela devient une expérience .

En résumé, documenter permet :

Pour soi:

• se rappeler même du jour au lendemain où l'on s'en est arrêté dans des essais,
• de ne pas reproduire les même,
• de s'assurer qu'on a bien tout essayé,
• de ne pas refaire toute la recherche pour résoudre un problème que l'on avait déjà rencontré.

Pour les autres:

• reproduire votre projet tel quel ou en l'adaptant,
• permettre aux autres de participer au projet,
• écarter des pistes de recherche parce qu'elles ne fonctionneront pas.

Où documenter?¶

• vous recevrez par mail vos identifiants et mots de passe pour ce wiki.
• une page dédiée sera attribuée à chaque binôme
• tous les documents, et les liens doivent être sur cette page

Que documenter?¶

Il est aussi important de documenter ce qui ne marche pas que ce qui marche !

Il y a deux phases dans la documentation, la prise de notes et la re-documentation

La prise de notes¶

Pendant la conception et le prototypage de votre création, il est nécessaire de prendre des notes, elles se prennent sur votre page projet sur le wiki du fablab coh@bit.

Ces notes peuvent être :

• des photos par exemple une photo des câblages avant de démonter pour se rappeler de quel câble allait où.
• vos fichiers sources (freecad, inkscape ...) qui permettront de reproduire le projet à l'identique ou de le modifier.
• liens vers ressources externes (tutos, fiches techniques etc...)
• photos, vidéos, sons des étapes de réalisation, captures d'écran, vidéos d'une manipulation.
• schémas, croquis, feuilles de calcul, plans d'expériences...
• code informatique et lignes de commandes (si il y en a...), ça permet de se rappeler de ce que l'on déjà essayé et d'éviter de tout recommencer.

Mais aussi: Tout ce qui vous paraîtra nécessaire et qui peut être déposé sur le wiki, il n'y a pas de manière universelle de documenter, elle doit être adaptée pour vous et votre projet.

La re-documentation¶

Si la prise de notes permet surtout de faciliter votre conception ou celles de gens qui s'inspirent de votre projet, la re-documentation consiste à mettre "au propre" le strict nécessaire pour reproduire votre projet à l'identique et de la manière la plus didactique possible.

Paramètres de fabrication: N'oubliez pas de noter tous les réglages et paramètres de fabrication que vous avez utilisé.
Exemples :

• Pour la découpe laser : type du matériau, épaisseur, vitesse et puissance de découpe laser, temps de machine nécessaire, ...
• Pour l'impression 3D : type et modèle de la machine, type de filament, températures du plateau et de l'extrusion, quantité de filament et temps de machine nécessaires, ...

Exemple de documentation¶

Étapes	Méthode de documentation	Exemple
Réflexion sur la pièce à réaliser	Texte retraçant la réflexion + schémas ou croquis avec les côtes
Création et conception d'une pièce en 3D	Captures d'écrans + commentaires décrivant les étapes de la conception	positionnement du cylindre au centre du cube
Exportation de la pièce et tranchage	Paramètres d'impression choisis et justification	Température d'extrusion = 210°C car on utilise du filament PLA et que c'est la température préconisée par le fabricant
Impression de la pièce	photo de la pièce en cours d'impression + commentaires + éventuellement les réglages de la machine	L'impression avance bien, mais il a d'abord fallu régler l'horizontalité du plateau
La pièce est terminée	Photo de la pièce + analyse : répond-elle au cahier des charges initial ?	Pièce terminée avec succès mais qui comporte néanmoins quelques défauts qu'il va falloir retirer avec une petite lime
La pièce est ratée	Analyse critique et poser des hypothèses pour essayer de comprendre pourquoi la pièce est ratée	La pièce est trop petite, il faut vérifier ses dimensions dans le logiciel de conception et dans le logiciel de tranchage
La pièce est réussie	Photo de la pièce assemblée dans le projet complet	Déposer les fichiers de construction et de fabrication dans la page wiki du projet avec des commentaires si par exemple l'impression 3D nécessite un réglage du trancheur particulier

Si une des étapes ne passe pas ou si la pièce est ratée, il faut repartir en arrière sur une des étapes précédentes et refaire le processus. Un diagnostique de ce qui a fait rater le processus est un 'plus' non-négligeable.

Matériaux consommés¶

Ne pas oublier d'insérer dans la documentation d'un projet, un récapitulatif de l'ensemble des matériaux consommés.

Par exemple :

Matériaux ou matériels	Quantité	Utilisation	Temps machine
Filament PLA	35 m	pièces support	4.5 heures
Filament TPU	22 m	roues robot	2 heures
Planche MDF 5mm	2	châssis du robot	25 minutes
Colle		assemblage des éléments
Peinture verte	1 bombe environ	peinture du châssis