Différences entre les versions de « Documentation des projets »
m |
|||
| Ligne 2 : | Ligne 2 : | ||
* Pour s'en souvenir si jamais on doit refaire ou modifier. | * Pour s'en souvenir si jamais on doit refaire ou modifier. | ||
* Parce que le partage de connaissances est la base même du mouvement des Fablabs : après avoir appris des autres, on aide son prochain. | * Parce que le partage de connaissances est la base même du mouvement des Fablabs : après avoir appris des autres, on aide son prochain. | ||
* Pour profiter du retour des autres : améliorations, aide... | * Participez au progrès de l'humanité! Peut-être que votre lance-patate version 2.0 vous semble insignifiant mais qui sait? Peut-être quelqu'un repartira t'il de votre travail et réussira à mettre une patate en orbite et fondera l'Agence Spatiale Louperivoise... | ||
* Pour profiter du retour des autres : améliorations, aide... | |||
== Quoi documenter? == | == Quoi documenter? == | ||
* Dès qu'un projet comporte un élément de nouveauté, ça vaut la peine de le documenter. | |||
* Si vous en êtes suffisamment fiers pour le montrer à votre entourage, ça vaut la peine de documenter. | |||
* Si vous avez expérimenté une nouvelle technique... | |||
== Comment documenter == | == Comment documenter == | ||
La documentation, c'est le journal intime de votre projet. Attendriez vous d'avoir 80 ans pour commencer un journal sous prétexte de l'écrire au propre une fois pour toutes? N'attendez pas la fin de votre projet pour documenter! Le premier usager de votre documentation, ce sera certainement vous! Une documentation lancée au tout début vous permettra de retracer certaines informations importantes (Quels étaient les réglages de la découpeuse? Où ai-je acheté ce truc? Comment ai-je fait pour que le machin et le bidule puissent s'assembler ensemble?). | |||
Pensez au lecteur! Serez-vous encore capables comprendre vos notes dans cinq ans? Avez-vous oublié de spécifier une étape essentielle? | |||
Une image vaut mille mots. Vous avez un téléphone intelligent? Servez-vous en! | |||
Après le projet : mettez au propre! Quel était le nom du bon fichier? Test1? Test6? VersionFinale? VersionFinale2? VersionFinaleFinale? | |||
== Prêts? Partez! == | |||
WikiFactory et instructions | WikiFactory et instructions | ||
https://drive.google.com/open?id=13rLmerH4few-AYYGvPqY4CNOCmr4CgIOgbCG3AzUitU | |||
https://reso-nance.org/wiki/_media/projets/documentation-fablab.pdf | https://reso-nance.org/wiki/_media/projets/documentation-fablab.pdf | ||
Version du 5 septembre 2019 à 23:17
Pourquoi documenter?
- Pour s'en souvenir si jamais on doit refaire ou modifier.
- Parce que le partage de connaissances est la base même du mouvement des Fablabs : après avoir appris des autres, on aide son prochain.
- Participez au progrès de l'humanité! Peut-être que votre lance-patate version 2.0 vous semble insignifiant mais qui sait? Peut-être quelqu'un repartira t'il de votre travail et réussira à mettre une patate en orbite et fondera l'Agence Spatiale Louperivoise...
- Pour profiter du retour des autres : améliorations, aide...
Quoi documenter?
- Dès qu'un projet comporte un élément de nouveauté, ça vaut la peine de le documenter.
- Si vous en êtes suffisamment fiers pour le montrer à votre entourage, ça vaut la peine de documenter.
- Si vous avez expérimenté une nouvelle technique...
Comment documenter
La documentation, c'est le journal intime de votre projet. Attendriez vous d'avoir 80 ans pour commencer un journal sous prétexte de l'écrire au propre une fois pour toutes? N'attendez pas la fin de votre projet pour documenter! Le premier usager de votre documentation, ce sera certainement vous! Une documentation lancée au tout début vous permettra de retracer certaines informations importantes (Quels étaient les réglages de la découpeuse? Où ai-je acheté ce truc? Comment ai-je fait pour que le machin et le bidule puissent s'assembler ensemble?).
Pensez au lecteur! Serez-vous encore capables comprendre vos notes dans cinq ans? Avez-vous oublié de spécifier une étape essentielle?
Une image vaut mille mots. Vous avez un téléphone intelligent? Servez-vous en!
Après le projet : mettez au propre! Quel était le nom du bon fichier? Test1? Test6? VersionFinale? VersionFinale2? VersionFinaleFinale?
Prêts? Partez!
WikiFactory et instructions
https://drive.google.com/open?id=13rLmerH4few-AYYGvPqY4CNOCmr4CgIOgbCG3AzUitU
https://reso-nance.org/wiki/_media/projets/documentation-fablab.pdf
Les licences