Ma définition

Une documentation permet de transmettre un savoir le plus simplement possible, afin qu’il puisse être compris rapidement et facilement par n’importe qui. Dans un environnement professionnel, elle est indispensable pour assurer la continuité des projets et faciliter le partage des connaissances. Une documentation bien réalisée décrit les processus, explique les manipulations techniques et fournit des détails utiles pour reproduire des tâches sans risque d’erreurs.

Au cours de mon cursus scolaire et professionnel, je réalise une documentation pour tout type de manipulation technique. La plupart du temps, elles me permettent de me souvenir de ce que j’ai fait et comment je l’ai fait, mais également pour mon équipe qui peut se retrouver à faire ces mêmes manipulations. Avec une documentation, on gagne du temps et on améliore la productivité en évitant de rechercher quelque chose qui a déjà été fait auparavant.

1ère anecdote

Durant mon stage en entreprise, l’un de mes projets fut de réaliser une petite infrastructure comportant deux machines virtuelles. Les machines communiquent entre elles et comportent toutes les deux de multiples configurations, tant au niveau des caractéristiques « physiques » comme le stockage ou encore la mémoire vive par exemple, qu’au niveau des paramétrages internes tels que les logiciels installés par exemple.

J’ai pu créer ma documentation tout au long de la réalisation pour que je puisse me souvenir de ce que j’ai fait dans un premier temps. Puis dans un deuxième temps cette documentation a pu servir à certains de mes collègues au sein de mon entreprise qui voulaient essayer ce que j’avais fait.

Grâce à un renseignement chronologique des étapes et en faisant preuve de simplicité et de précision dans la rédaction, ma documentation a rempli son objectif. Elle a permis à deux de mes collègues de réaliser rapidement et simplement, une infrastructure comportant de multiples configurations. Cette documentation est ainsi transmise aux nouveaux arrivants comme entraînement pratique pour la mise en place de machines virtuelles dans un environnement contrôlé et sécurisé.

2ème anecdote

Lors de mon alternance en entreprise, j’ai pu identifier un problème récurrent, de nombreux utilisateurs créaient des tickets à notre support pour un souci déjà connu concernant la gestion des tokens sur Ansible. Chaque fois, mon équipe et moi devions leur expliquer comment générer et utiliser ces tokens, ce qui nous faisait perdre un temps considérable et ralentissait la résolution d’autres problèmes plus complexes en parallèle.

Pour résoudre cette situation, j’ai pris l’initiative de rédiger une documentation claire et accessible à tous les utilisateurs de la plateforme sur le Confluence public de notre projet. Cette documentation explique d’abord ce qu’est un token de manière simple, avant de détailler, étape par étape, le processus de génération et d’utilisation d’un token avec l’API d’Ansible. J’ai également intégré des captures d’écran et des exemples concrets pour illustrer chaque étape, rendant la démarche facile à suivre même pour ceux ayant peu de connaissances techniques. L’objectif était de permettre à un utilisateur non expert de résoudre ce problème sans avoir besoin de contacter notre support.

Le résultat a été très positif. Nous ne recevons depuis, plus de tickets sur les tokens, ce qui a allégé la charge de travail de mon équipe. Non seulement nous avons gagné du temps, mais cette documentation a également permis aux utilisateurs de devenir plus autonomes, tout en renforçant l’efficacité de notre service de support. Cette documentation est maintenant utilisée régulièrement comme référence et est mise à jour en fonction des nouvelles versions d’Ansible, garantissant ainsi sa pertinence dans le temps.

Mon autocritique

En évaluant ma compétence à rédiger une documentation, je considère avoir atteint un niveau avancé d’expertise, avec une capacité à créer rapidement des documents précis et pertinents.

L’apprentissage de cette compétence a été significatif grâce aux projets scolaires et en entreprise. Cependant, il me reste des aspects à explorer comme l’utilisation d’outils de documentation modernes comme Notion ou Markdown qui permettent de créer des documents dynamiques.

Dans mon rôle d’Expert en Ingénierie, savoir rédiger une documentation est une compétence cruciale pour garantir la cohérence des processus et pour favoriser la collaboration entre les membres d’une ou plusieurs équipes.

Ma vitesse d’acquisition de cette compétence a été rapide car j’aime beaucoup transmettre mon savoir à l’écrit. Une documentation réussie est, pour moi, une documentation comprise.

Avec le recul que j’ai aujourd’hui, je conseille de toujours intégrer la documentation comme une composante essentielle dès le début de tout projet. Cela permet d’avoir une traçabilité et minimise les efforts de rétro-ingénierie souvent nécessaires quand la documentation n’est pas faite ou négligée.

Pour ceux qui souhaitent développer cette compétence, je recommande de mettre l’accent sur la clarté, la précision et la mise à jour régulière des documents. On peut également s’amuser à créer des documentations pour la famille, en expliquant par exemple à ses grands-parents comment allumer un ordinateur et se connecter sur son navigateur pour aller consulter sa boîte mail. Cela permettra d’améliorer sa capacité à expliquer des choses qui peuvent être simples à première vue, mais qui ne le sont pas forcément pour les autres.

Mon évolution dans cette compétence

Je souhaite monter en progression pour être confirmé en rédaction de documentation, niveau que je peux obtenir en utilisant l’outil Notion et en suivant la formation « Notion de A à Z » par Orga Milena et en suivant les nombreux guides mis à disposition sur le site officiel de Notion.

Cela me permettra de mieux structurer les informations et également de rendre plus esthétique mes actuelles et futures documentations.