Rédiger une documentation
Un excellent travail peut s’avérer vain s’il n’est pas documenté !
Dans ce sens, quelle que soit l’orientation, l’informaticien est appelé à documenter son travail afin de laisser une trace pour ses collègues, ses successeurs et ses clients.
“La qualité d’un logiciel se mesure au poids de sa documentation.”
Anonyme
Histoire vraie !
Une école privée a mandaté les services d’un informaticien, orientation développement d’applications, pour développer un logiciel de gestion des résultats scolaires de ses élèves. Le développement a nécessité 2 années de travail et à coûté plusieurs dizaines de milliers de CHF.
Durant plusieurs années, le logiciel donna entière satisfaction jusqu’à qu’un changement structurel nécessita une intervention de la part de l’informaticien.
Hors, suite à un accident de moto, l’informaticien en question était décédé !
Ses collègues cherchèrent partout la documentation de son logiciel, ainsi que les mots de passe permettant d’accéder au code source. En vain, rien n’a été produit ! A juste titre, l’école a intenté un procès contre la boîte informatique, et à dû de toute façon faire appel à un autre prestataire pour re-développer son logiciel de gestion.
Moralité
Quelle que soit son orientation (Opérateur, développement d’applications, infrastructure), l’informaticien doit documenter son travail pour les raisons suivantes :
-
-
- Conserver une trace de son travail ;
- Définir les étapes d’un projet ;
- Faciliter la compréhension et la collaboration avec les collègues ;
- Laisser une ressource pour le client ;
- Améliorer la détection des erreurs et des problèmes
-
En somme, la documentation de votre travail dans le domaine informatique est essentielle pour assurer la compréhension, la collaboration et la maintenance de vos projets, tout en démontrant votre professionnalisme. Alors n’hésitez pas à prendre le temps de bien documenter votre travail, cela en vaut vraiment la peine !
Objectif : à la fin de ce module, vous saurez …
- Installer physiquement une caméra de surveillance
- Produire la documentation pour le client
Vous trouverez le matériel dans les endroits spécifiés ci-dessous
Site Orif/Vaulruz
Caméra TAPO avec carte SD 32 Ggb (Armoire de matériel dans la zone atelier)
WiFi de la section informatique : APTVSI1
MdP : SectionInfo2022
Site Orif/Aigle
Armoire « Matériel formation » située dans l’espace atelier.
Servez-vous librement et restituez le matériel en bon état et nettoyé après usage.
Mandat pratique
Description du mandat
Un client vous mandate afin d‘installer une caméra de surveillance, puis de produire un petit mode d’emploi expliquant les fonctionnalités de base de la caméra gérée depuis son Smartphone.
Vous trouverez toutes les informations d’installation et de configuration sur internet, MAIS, vous devrez produire un document original de votre rédaction, maximum 1 page, sur la base du modèle de document Orif.
Avant toute chose
Afin de présenter votre caméra dans sa configuration d’origine, procédez à une réinitialisation. (Mise à zéro des paramètres d’usine)
Vous trouverez les informations en cliquant sur ce lien.
Nous vous suggérons de procéder comme suit :
- Installez physiquement la caméra ;
- Recherchez et installez les applications recommandées par le fournisseur ;
- Explorez intuitivement le produit, ou en suivant les modes d’emploi sur internet ;
- Rédigez votre mode d’emploi idéal et sympa sans tenir compte de la limitation d’une page ;
- Faites la mise en page définitive sur 1 page.
Restitution
- Présentation de la caméra, explications sur son installation
- Document Word basé sur le modèle de document Orif, max 1 page avec une ou plusieurs illustrations