Ma définition
En informatique, les documentations permettent de collecter et d’archiver un ensemble de spécificités techniques. Sans documentation, ces informations peuvent se perdre au fil des années, suite aux départs de certains collaborateurs par exemple.
Une entreprise se doit de porter un grand intérêt à la documentation. La rédaction d’une documentation en entreprise représente un coût financier réel dû notamment au temps consacré à la rédaction et à la vérification de celle-ci. Les avantages à procéder à un inventaire des spécificités de son infrastructure permet à l’entreprise d’être réellement maîtresse de son système d’information et de ne pas être dépendante d’un ou de plusieurs acteurs (employés, alternants, stagiaires) extérieurs à l’entreprise.
Un article du site altassian.com intitulé “L’importance de la documentation (parce que c’est bien plus qu’une formalité)” nous informe que seulement 4 % des entreprises documentent systématiquement leurs processus. Il met également en lumière le fait que si une entreprise souhaite rompre un contrat avec l’un de ses employés, celui-ci peut partir avec des informations importantes. L’entreprise devient ainsi dépendante de son salarié et peut rencontrer des problèmes de fonctionnement en son absence. Cet article évoque également les apports que représente une documentation pour l’ensemble des employés. Ils peuvent ainsi en bénéficier pour se former et monter en compétences.
Mes éléments de preuve
J’ai compris l’importance de la documentation grâce à mon BTS SIO. Pendant mon Baccalauréat professionnel Systèmes Numériques, j’ai dû réaliser beaucoup de documentations dans le cadre de mes stages et de mes travaux pratiques en classe, cependant, c’est pendant le BTS que j’ai vraiment compris que ce n’était pas une contrainte. J’ai même fini par apprécier de rédiger des documentations au fil des années.
Je vais vous partager trois anecdotes concernant cette compétence. La première s’est déroulée pendant la réalisation du projet GSB dans le cadre de mon BTS SIO. La seconde et la troisième ont été effectuées dans le cadre de la licence professionnelle ASR. Il s’agit des réalisations “E-Lawvation” et “Projet CMDB”.
Durant le projet scolaire de BTS nommé GSB, deux autres étudiants et moi avions un datacenter à mettre en œuvre. J’ai réalisé la documentation de toute l’infrastructure que nous avions conçue. La gestion de la documentation a été réalisée en deux grandes étapes. La première a consisté en l’inventaire sur feuilles papier des spécificités de tous les équipements réseaux et les serveurs de l’infrastructure. J’ai réalisé sur Google Docs un modèle de fiche de documentation d’un élément réseau. Dessus, j’y ai inscrit différentes informations utiles comme le nom du technicien qui a réalisé l’installation de l’équipement, la date, l’heure, les logiciels installés et les configurations réalisées avec l’emplacement des fichiers de configuration. Nous avons utilisé cette démarche pendant plusieurs mois, car elle était simple et que le temps nécessaire pour réaliser ces documentations n’était pas élevé. Dans un second temps, nos enseignants nous ont informé qu’un ITSM (logiciel de gestion des services informatiques) était requis dans notre parc informatique. J’ai par conséquent réalisé l’installation de GLPI (Gestion Libre de Parc Informatique) et nous avons utilisé les fonctions intégrées à l’outil pour documenter le parc informatique. Les documentations papier sont restées consultables (en guise de références), car elles avaient été intégrées à l’ITSM. J’ai ainsi pu valider l’objectif de maîtriser le concept de documentation, car l’ensemble des équipements réseaux et des serveurs étaient documentés.
Le projet scolaire E-Lawvation a été effectué dans le contexte de la licence ASR (Administration et Sécurité des Réseaux) à l’Université de Toulon. Il a été réalisé en équipe de cinq étudiants. Nous devions rédiger un document technique comprenant différentes hypothèses répondant aux besoins de notre client. Lors de cette réalisation, j’ai documenté individuellement trois hypothèses d’infrastructures Cloud. Les autres étudiants ont quant à eux documenté les autres hypothèses en lien avec des infrastructures physiques. Pour établir la documentation de chacune des trois hypothèses, j’ai créé des schémas d’architecture détaillés et une description du rôle de chaque élément réseau ou des applicatifs employés. J’ai enfin réalisé des tableaux de coûts prévisionnels en fonction de chacune des hypothèses. J’ai beaucoup aimé concevoir ces prévisions de coûts et approfondir mes connaissances en la matière. Le fait que nous ayons documenté avec détails les différentes hypothèses nous a permis de rendre un document professionnel au client qui en a été pleinement satisfait.
La réalisation “projet CMDB” a été effectuée dans le cadre d’un stage chez SEA TPI pendant mon année de Licence ASR. J’avais pour objectif principal de rédiger une expression de besoins à destination du service industrialisation de SEATPI. Ce projet a été lancé suite au constat que trop de machines virtuelles de l’entreprise n’étaient pas en conformité avec ses usages. Il s’avérait que certaines machines virtuelles ne respectaient pas les conventions de nommages ou n’étaient pas présentes dans le monitoring, dans le DNS ou dans l’inventaire du parc informatique. J’ai alors réalisé une documentation complète comprenant l’ensemble des automatismes que le service industrialisation devrait développer. Rédiger cette documentation a été pour moi l’occasion de maîtriser réellement le cycle de vie d’une machine virtuelle dans une grande entreprise. Dans le cadre de ce stage, j’ai également réalisé des documentations d’utilisation de la CMDB (base de données de configuration). Mes compétences en documentation m’ont permis de remplir les objectifs fixés par mon responsable de stage dans le délai imparti.
Mon autocritique
J’ai un niveau “confirmé” en matière de documentation. J’aime réellement documenter des architectures systèmes et réseaux qui sont complexes. Mon goût pour cet aspect de l’informatique vient du constat qu’en documentant, je parviens à mieux comprendre les infrastructures.
Je sais toutefois qu’il me reste encore à maîtriser certains logiciels sur lesquels j’ai peu manipulé comme Microsoft Visio. Je pense qu’acquérir de l’expérience me permettra de réaliser des schémas toujours plus clairs et pertinents.
Un expert en ingénierie des systèmes d’information doit être capable de réaliser des documentations professionnelles. Cette compétence est capitale pour travailler sur l’ensemble des systèmes d’information. Avec l’expérience que j’ai aujourd’hui en matière de documentation, je recommande à ceux qui ne sont pas à l’aise avec la documentation de débuter par la prise de quelques notes. Par exemple, rédiger de simples README (documentations sous forme de fichiers texte) dans le dossier d’un script réalisé permet de lister les méthodes d’emploi du script et d’apporter des informations nécessaires au bon fonctionnement de celui-ci, et de favoriser sa maintenabilité.
Mon évolution dans cette compétence
Je souhaite devenir architecte Google Cloud et être capable dans les prochaines années de concevoir des architectures complexes pour des entreprises. Maîtriser la documentation est très important pour mon projet professionnel, car un architecte Cloud doit-être apte à schématiser et à documenter les architectures Cloud qu’il confectionne.
Pour améliorer ma compétence en matière de rédaction des documentations, je vais réaliser la formation d’OpenClassroom intitulée « Écrivez la documentation technique de votre projet », car elle aborde les aspects de documentation, de code et d’architecture. Je suis convaincu que je pourrais y découvrir de nouvelles astuces pour simplifier mes documentations.