Documentation fonctionnelle et procédures
La documentation fonctionnelle consiste à formaliser le fonctionnement d’un outil ou d’un processus : étapes à suivre, responsabilités, règles de gestion, décisions prises et comportements attendus.
Elle permet de rendre les pratiques compréhensibles au-delà des échanges oraux et d’éviter qu’une information importante dépende uniquement de la mémoire d’une personne.
Ma pratique
Je documente les éléments nécessaires pour qu’un utilisateur, un collègue ou un prestataire puisse comprendre la solution et reprendre son fonctionnement.
Selon le contexte, cela peut inclure :
- une procédure étape par étape ;
- la description d’un workflow ;
- les règles conditionnelles d’un formulaire ;
- les rôles et validations attendus ;
- les paramètres importants d’une application ;
- les décisions prises pendant le projet ;
- les actions à réaliser en cas d’erreur ;
- un support de formation ou de prise en main.
J’adapte le niveau de détail au lecteur. Une procédure destinée à un utilisateur ne doit pas ressembler à une documentation technique, tandis qu’une équipe chargée de la maintenance doit disposer d’informations plus précises.
Mise en pratique
Pour mes projets Odoo, j’ai produit des supports permettant aux utilisateurs de gérer leurs contenus, leurs publications, leurs formulaires ou leurs modules en autonomie.
Dans le cadre d’un ETL entre HubSpot et Odoo, la transmission comprenait également la documentation du mapping des données, des workflows Airflow, des fréquences d’exécution, des logs et des principales opérations de maintenance.
Outils associés
Odoo Connaissances pour documenter les configurations, les parcours utilisateurs et les procédures d’utilisation lors des intégrations Odoo ;
Google Drive et Google Docs pour créer des supports partagés, accessibles et faciles à faire évoluer ;
GitHub ou GitLab pour conserver la documentation directement liée au code, aux configurations et aux déploiements ;
Postman pour tester les API et documenter leurs endpoints, paramètres, exemples de requêtes et réponses ;
Sphinx pour produire une documentation structurée autour de développements Python, avec gestion des versions et possibilité de diffusion indépendamment du dépôt de code ;
des schémas de flux, captures d’écran, checklists et supports de formation pour rendre les procédures plus visuelles et directement utilisables.
✅ Mon réflexe
" Je rédige une documentation pour la personne qui devra l’utiliser plus tard, pas seulement pour celle qui connaît déjà le projet.
J’ajoute donc le contexte, les points de vigilance et les étapes de vérification qui évitent les interprétations. "
Les postes associés
Cette compétence est utile dans les fonctions qui assurent la continuité des outils, la transmission des connaissances et l’accompagnement des utilisateurs, tels que :