Documentation : la clé pour surmonter les défis techniques majeurs

En cas de problème majeur impliquant différentes équipes, le principal défi est souvent la communication. Le bon document, même bref, répondant aux questions brûlantes peut complètement changer la donne. Voici quoi écrire et partager :

Illustration abstraite d'un professionnel du référencement technique découvrant les vertus de la documentation

La paperasse

Faire l’éloge de la documentation n’est pas un exercice facile pour moi, car j’ai une aversion pour la création de documents et de présentations inutiles, parfait refuge pour une productivité 0 et le micromanagement.

La documentation est un outil, pas une fin en soi, mais s’avère extrêmement efficace dans certains cas précis pour fluidifier la communication et ne pas retarder des actions par manque de compréhension ou de contexte.

Je ne crois pas que la documentation doive être systématique, car elle a un coût en temps important. En revanche, plus l’impact d’une action est élevée et plus elle implique de monde, plus elle s’avère nécessaire voire critique pour mener un projet à bien.

Avec le bon équilibre de documents, je suis parvenu à réduire des délais d’exécution de plusieurs semaines, parfois de plusieurs mois, sans que cela perturbe outre-mesure ma capacité à me concentrer sur d’autres tâches cruciales.

Quand l’utiliser ?

Créer un document dédié pour chaque tâche n’a aucun sens, hormis si le but est d’en faire une activité à temps plein.

Les meilleurs moments pour en créer un sont :

  • En cas d’urgence impliquant plusieurs équipes
    • Par exemple : votre trafic est en chute libre et vous avez identifié l’élément perturbateur, dont une autre équipe à la charge. Afin de régler le problème, vous devez leur faire comprendre rapidement le souci, mais également à votre manager/client, et potentiellement à d’autres équipes jouant un rôle connexe.
  • Pour un projet avec niveau d’effort important et impact élevé
    • Par exemple : vos projections pour le projet Y sont très bonnes mais il s’étendra sur plusieurs trimestres avec différentes actions à prendre à des moments précis.
  • Pour un changement de cap
    • Par exemple : votre stratégie ne fonctionne pas et vous désirez pivoter, ce qui inclura potentiellement des ressources différentes à des périodes différentes
  • Pour demander des ressources
    • Par exemple : Le projet P est prometteur et vos calculs garantissent un retour sur investissement conséquent. il vous faut 2 développeurs et un designer pendant 2 mois pour y parvenir et vous n’avez en temps normal pas accès à ces ressources.

En sélectionnant ces moments critiques où le défi est de taille, on priorise les actions à plus fort impact et l’on économise ses efforts pour ne se focaliser que sur ce qui a de l’importance, sans tomber dans un puits sans fond de rédaction stérile.

Comment l’utiliser ?

Un Google Docs fera l’affaire. Il suffit simplement d’expliquer à un public qui n’a pas votre expertise en SEO technique de quoi il retourne, sans utiliser de jargon inutile.

Voici une structure simple qui marche à tous les coups :

Titre

Résumé en une phrase de la raison d’être du document

TL;PL (« trop long; pas lu », c’est-à-dire les points les plus importants du document)

  1. Point crucial 1
  2. Point crucial 2
  3. Point crucial 3

Que se passe-t-il ?

Deux paragraphes explicatifs

Pourquoi c’est important ?

Deux paragraphes explicatifs

Solutions à apporter

Plusieurs paragraphes détaillés

Impact

Chiffres et graphiques

Conclusion

Deux paragraphes explicatifs


Et c’est tout ! Idéalement le document fera une page, maximum deux.

Ensuite, il suffit de le partager le plus possible : par e-mail, Slack, lien texte, etc… pour s’assurer que le plus de monde touche les informations. Souvent, des collaborateurs éloignés auxquels on ne pensait pas font bouger les lignes à la lecture de votre document

En résumé

La documentation est cruciale pour influencer un grand nombre de décideurs et d’acteurs, sur un projet ou un problème particulier.

Elle est un outil puissant pour un usage ciblé, un poison si utilisée à outrance.

Bien souvent, un projet d’ampleur mené à bien passe un ou des documents explicatifs, qui par leur simplicité vont toucher tous les publics et ouvrir les portes qui restaient fermées jusqu’ici.

Laisser un commentaire/Leave A Comment

S’abonner à la newsletter

Inscrivez-vous à la newsletter du Copain Référenceur et recevez tous les lundis les dernières actualités Tech SEO ainsi que des conseils pratiques pour optimiser et monétiser votre site web :