Documentation des projets

De
Révision datée du 5 septembre 2019 à 20:00 par Burcadus (discussion | contributions) (→‎Prêts? Partez!)
(diff) ← Version précédente | Voir la version actuelle (diff) | Version suivante → (diff)
Sauter à la navigation Sauter à la recherche

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? Y a t'il des trucs que vous avez découvert et qui vous auraient fait sauver du temps? Vous pouvez aussi ajouter des suggestions d'améliorations à faire.

Une licence, c'est important

Quelles sont vos conditions pour permettre l'utilisation de ce que vous avez développé? Est-ce que vous souhaitez être cité? Est-ce que vous accepteriez que votre projet soit modifié? Est-ce que vous accepteriez qu'il soit employé de façon commerciale?

Les licences Creative Commons sont faciles à utiliser. Plus d'infos ici.

Prêts? Partez!

WikiFactory est une plate-forme collaborative servant à documenter les projets Open Source... Très puissante, elle permet d’intégrer des fichiers 3d, de commenter, de publier, de réviser, de gérer les versions des fichiers. Le mouvement des Fablabs a adopté WikiFactory comme moyen de documentation. Vous êtes invités à faire de même pour les projets développés au Fabbulle.

Instructions sur l'usage de Wikifactory