Documentation informatique : quelles conventions adopter pour les dénominations ?

Imaginez que chacun des techniciens d’une équipe informatique utilise sa propre convention de dénomination pour documenter ce qu’il crée dans l’outil de gestion de la documentation informatique. Cela irait à l’encontre de l’objectif même documenter les applications et systèmes informatiques de vos clients (serveurs, stations de travail, imprimantes, switchs, routeurs, firewalls, etc.) et conduirait à des informations dupliquées, à un éparpillement des données et à une perte de temps supplémentaire et inutile pour vos employés… Vous connaissez le cauchemar de la recherche d’informations ? 😱

Pour que la documentation informatique fonctionne au sein d’une société de services informatiques, vous devez veiller à la cohérence des conventions de dénomination. Cela doit commencer dès que vous déployez un logiciel de documentation. Ne mettez pas votre équipe dans une situation où elle doit parcourir chaque document et le renommer. Si vous déterminez des conventions pour les appellations (et que vous vous y tenez !), il sera plus facile pour votre équipe de déduire le contenu d’un document en lisant simplement le nom du fichier. 

Conseils éprouvés sur les conventions de dénomination pour la documentation IT

Pour que la documentation informatique puisse exercer toute sa magie, il existe des bonnes pratiques éprouvées en matière de convention de nommage de la documentation. Nos partenaires, des prestataires de services informatiques, appliquent ces conseils : vous aussi, vous pouvez les mettre en œuvre immédiatement. Ces conseils sont principalement axés sur les principales différences et similitudes observées dans vos opérations et projets quotidiens.

• Établissez un format de date standard comme AAMMJJ ou AAAAMMJJ.
• Veillez à ce que les noms soient courts et clairs. 
• Évitez d’utiliser des caractères non alphabétiques et non numériques tels que &, @, etc. 
• Utilisez des traits de soulignement, des tirets, des mots sans séparation ou avec des majuscules plutôt que des espaces entre les mots
• Veillez à ce que chaque nom soit unique pour le même périmètre
• Définissez des termes standard pour désigner les fichiers et les emplacements afin d’éviter toute confusion. 
• Veillez à ce que les conventions de dénomination soient accessibles afin que vos coéquipiers puissent les consulter rapidement.
• Formez votre équipe avant de commencer et mettez en place des quiz pour vous assurer que tout le monde est sur la même longueur d’onde. 
• Spécifiez le style de numérotation des versions que vous envisagez de mettre en œuvre. 
• S’il y a plus de neuf fichiers en ordre séquentiel, envisagez d’ajouter des zéros devant les numéros de version pour maintenir l’ordre correct (par exemple, 001, 002, 003, etc.). 

Quelques points à garder à l’esprit pour rendre vos conventions de nommage plus efficaces 

Bien qu’il ne s’agisse pas de règles absolues, leur respect devrait réduire la confusion et vous aider à tirer le meilleur parti de votre documentation. 

Utilisez le nom de l’organisation lorsque cela est nécessaire

Si vous fournissez des services informatiques pour plusieurs clients, il est judicieux d’ajouter le nom de l’organisation aux noms de fichiers. De cette façon, vous aurez au moins un élément de différenciation si deux clients utilisent le même appareil et sont également basés dans la même ville. Ce pourrait être « organisation-localisation-type d’équipement-numéro« . Toutefois, si vous dirigez une équipe informatique interne, cela peut ne pas être nécessaire.

Incluez des abréviations pour rendre les noms facilement compréhensibles

Les noms plus longs sont plus difficiles à déchiffrer. Le résultat final est que cela ralentira votre équipe. Mettez plutôt en place des abréviations pour des variables telles que le nom de l’organisation, le lieu, le type de dispositif, entre autres. Par exemple, un équipement de fire-wall pourrait être abrégé en FW, qui serait ensuite suivi du nom du modèle. Une fois que vous vous êtes mis d’accord sur les abréviations, continuez à les ajouter à un glossaire accessible de manière centralisée.

Assurez-vous que les conventions restent cohérentes sur toutes les plateformes  

IT Glue vous permet de synchroniser les informations provenant du reste de votre stack technologique. Par exemple, la synchronisation avec les outils RMM et PSA vous aide à automatiser la documentation informatique autant que possible. Ces intégrations peuvent vous faire gagner un temps fou. Toutefois, les conventions de dénomination doivent rester cohérentes d’une plateforme à l’autre. Si elles varient d’une plateforme à l’autre, la cohérence de la documentation en pâtira et les doublons risquent de s’accumuler. Avant de commencer activement à synchroniser les informations, assurez-vous de faire un bilan de l’existant dans vos systèmes.

Obtenez l’adhésion de votre équipe

En fin de compte, ce sont vos ingénieurs et vos techniciens du support informatique qui créeront et utiliseront la documentation. S’ils ne savent pas clairement pourquoi ils doivent respecter ces conventions de dénomination, ils seront moins enclins à le faire. Le manque d’adhésion peut compromettre l’ensemble de l’exercice. Prenez le temps de démontrer la valeur des conventions de dénomination – comment elles simplifient la recherche d’informations, accélèrent le temps de résolution des incidents, favorisent l’autonomie, etc. Une fois que vous aurez obtenu leur adhésion, vous pourrez commencer à les former.

À lire aussi : “Document or Die” : comment inciter votre équipe à documenter ?

En conclusion

Ne sous-estimez jamais l’importance des conventions de dénomination. C’est la base d’une documentation efficace. Au fur et à mesure de votre croissance, vous devrez adapter vos efforts pour documenter les systèmes informatiques et applications de vos clients. N’oubliez pas que si vous ne prenez pas le temps de définir des conventions d’appellation dès le départ, vos progrès seront freinés.

La plateforme de documentation primée d’IT Glue permet le stockage et une collaboration efficace de toute la documentation informatique dont un prestataire de services managés a besoin pour accroître son efficacité et rationaliser ses opérations. Réservez une démo dès aujourd’hui !