793
modifications
Différences entre les versions de « Documentation des projets »
Aller à la navigation
Aller à la recherche
Documentation des projets (voir la source)
Version du 5 septembre 2019 à 23:59
, 5 septembre 2019 à 23:59→Comment documenter
| Ligne 13 : | Ligne 13 : | ||
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?). | 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? | 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! | ||
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. | 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. | ||