Les choses à faire et à ne pas faire en matière de documentation agile
En gardant tout cela à l’esprit, voici quelques conseils stratégiques pour aborder votre documentation agile :
À faire : documenter continuellement votre travail
La documentation est souvent critiquée comme étant un processus intensif qui prend du temps sur le travail réel de programmation et de développement du produit. Pour autant, ce n’est pas une fatalité.
Un article récent d’InfoQ propose une approche de la documentation continue qui repose sur le couplage de votre documentation à votre code et sur le moment choisi pour la rédiger – par exemple, immédiatement après la correction d’un beugue, plutôt que suivant l’achèvement d’un grand projet. Et les articles de Lucid sur les référentiels d’innovation suggèrent une approche permettant de transformer tout le travail de brainstorming, de planification et d’exécution que vous effectuez déjà en un « modèle vivant » de la manière dont votre entreprise concrétise ses meilleures idées.
Envisager la documentation de cette manière en fait une extension naturelle du processus de conception, de programmation, de sécurité, de test, de vente et de marketing, et non une tâche distincte que l’on accomplit à contrecœur. Il est également plus efficace de documenter votre travail au fur et à mesure, car vous pouvez prendre des notes sur les processus pendant qu’ils sont encore frais dans votre tête.
Ne pas faire : créer de la documentation par principe
Tout au long du processus de documentation agile continue, il est important de vous poser les questions suivantes pour éviter d’entrer dans une pratique sans intérêt :
- Quel est l’objet de cette documentation ?
- À qui s’adresse ce document, et comment sera-t-il utilisé ?
- Ce document existe-t-il déjà ailleurs ?
Adopter un état d’esprit de documentation agile continue ne signifie pas que vous devez réaliser un travail redondant. Au contraire, il convient de rechercher les occasions de compléter et d’améliorer des documents existants chaque fois que cela est possible.
La résolution des problèmes de version, l’optimisation d’un document difficile à trouver ou à lire pour en faciliter la découverte et la compréhension, ou l’ajout de captures d’écran et de diagrammes à un document riche en texte sont autant de moyens importants de renforcer la base de connaissances de votre entreprise au-delà de la simple création de nouveaux documents.
À faire : automatiser la documentation lorsque c’est possible
L’ajout d’une base de données et d’autres intégrations peut réduire les erreurs et les malentendus qui surviennent lorsque vous devez mettre à jour votre documentation manuellement, en particulier pour les diagrammes entité-association (EA) ou toute autre documentation représentant des relations de données complexes.
L’automatisation peut également vous permettre de gagner du temps et d’économiser des efforts en actualisant des parties clés de votre documentation sans même que vous y pensiez (ou que vous sachiez que cela se produit). Le fait d’avoir les données les plus récentes à portée de main plutôt que de devoir les chercher peut vous aider à générer plus efficacement des informations exploitables et à découvrir des schémas que vous n’auriez peut-être pas remarqués autrement.
Ne pas faire : attendre la fin de votre projet pour le documenter
Attendre la fin d’un projet pour le documenter présente le risque d’oublier des informations, augmente la marge d’erreur et ajoute une charge inutile au terme d’un sprint laborieux, lorsque l’enthousiasme pour accomplir « encore une petite chose » n’est plus vraiment au rendez-vous.
En abordant la documentation agile sous l‘angle de la création d’un référentiel d’innovation à la fois sur le moment et dans le temps, celle-ci devient une composante naturelle du projet – de l’idéation et de la planification à la conception et au lancement – plutôt qu’une tâche marginale ajoutée à la fin.
Ne pas faire : produire des documents de manière cloisonnée
Il n’est pas efficace de passer du temps à créer des documents individuellement, puis d’attendre que le projet soit bien avancé pour recueillir des commentaires. Si le périmètre de votre documentation est erroné ou si des détails essentiels manquent, un remaniement important risque de s’imposer, travail qui aurait pu être évité.
Le fait d’impliquer vos collaborateurs dès le début, par le biais d’entretiens ou de réunions visant à déterminer la documentation réellement nécessaire, ou en coopérant sur les documents eux-mêmes, vous fera gagner du temps et vous épargnera des difficultés par la suite.
À faire : créer de la documentation en collaboration avec l’équipe
La documentation ne doit pas être un travail solitaire, surtout lorsque vous la rédigez à partir d'un code, de tableaux de brainstorming, de cartes de planification ou d’autres documents que vous avez déjà créés en équipe.
Le fait d’impliquer d’autres personnes dans le processus permet de les sensibiliser et d’obtenir leur adhésion en adoptant une approche collaborative. Cela génère également un sentiment de responsabilité collective quant à la rigueur de la documentation dans votre organisation et renforce l’importance de la mise à jour des documents pour l’équipe. Pour les employés les moins expérimentés, participer au processus de création peut également être une expérience d’apprentissage très enrichissante.
