Comment réaliser une revue

Il existe plusieurs types de revues.

Quatre variétés vont être présentées un peu plus loin dans cette section.

Une revue peut être plus ou moins formelle selon la rigueur qui est accordée à sa réalisation.

On choisit d’appliquer un type de revue plus ou moins formel selon les contraintes légale ou réglementaire du projet ou la maturité du processus de développement.

Si le projet a des exigences légales ou réglementaires fortes ou que le processus de développement est mature alors les revues seront des revues formelles ou « systématiques ».

Si le projet est nouveau et n’a pas de contraintes légales ou réglementaires alors les revues peuvent être plus informelles.

On choisit le niveau de formalisme aussi selon les objectifs de la revue :

Trouver des défauts
Augmenter la compréhension et former les testeurs et les nouveaux membres d’une équipe : parce que la documentation revue est un entrant majeur des tests et le test ne peut pas être efficace si les testeurs n’ont pas compris le besoin initial et comment doit se comporter une application.
Organiser la discussion et décider par consensus

Une revue formelle doit comporter :

Les acteurs du projet qui vont réaliser la revue
Une procédure avec des instructions claire pour les relecteurs sur comment mener la revue
Les résultats de la revue sont formellement tracés et communiqués.

1. Phases d’une revue formelle (K1)

1. Planification :

 Définir les critères de revues : Définir ce que les caractéristiques auxquelles les relecteurs feront attention lors de la revue

 Choisir le personnel : Choisir les participants qui vont réaliser les revues

 Allouer les rôles : Affecter des rôles précis aux participants : qui sera Manager, qui sera le Modérateur, Qui est l’Auteur, Les réviseurs et le Scribe : tous ces rôles seront détaillés un peu plus loin.

 Définition des critères d’entrée et de sortie pour des types de revues plus formels (p.ex., inspections) :

Dans un projet, il faut prendre constamment des décisions de quand commencer les tests et quand il faut les clôturer. Pour cela on utilise les critères d’entrée et de sortie.
Les critères d’entrée sont des éléments objectifs sur lesquels s’appuyer pour décider de commencer les revues
Les critères de sorties sont des éléments sur lesquels l’équipe se base pour décider objectivement d’arrêter les tests

 Sélectionner la partie des documents à revoir : sélectionner les documents à relire et les chapitres qui seront ciblés en priorité.

 Vérification des critères d’entrée (pour des types de revues plus formels) : Une fois la planification est effectuée il est temps de vérifier si les conditions sont réunies pour commencer les revues.

2. Lancement:

Le lancement est le moment où les participants vont découvrir la documentation à revoir et le mode opératoire de la revue qu’ils vont réaliser. C’est à cette étape que les documents seront distribués aux participants et qu’une présentation leur sera faite sur les objectifs et le déroulement de la revue.

 Distribuer les documents

 Expliquer les objectifs, le processus et les documents aux participants

3. Préparation individuelle :

Pendant cette étape, chaque participant pourra relire le document de son côté avant la réunion de revue et préparer ainsi ses remarques, commentaires et questions.

 Préparer la réunion de revue en revoyant le(s) document(s)

 Ecriture des défauts potentiels, questions et commentaires

4. Examen/évaluation/enregistrement des résultats (réunion de revue):

C’est au cours de cette étape que la revue est réalisée. Les différents participants parcourent collectivement le document en soulevant les points de discussion, en détectant les défauts et en faisant des recommandations sur les corrections potentielles. Cette réunion peut se faire en présentiel ou à distance avec les outils de communication disponibles.

 Discuter ou enregistrer, avec des résultats ou minutes documentés (pour des types de revues plus formels)

 Noter les défauts, faire des recommandations concernant le traitement des défauts, prendre des décisions à propos des défauts

 Examen/évaluation et enregistrement pendant toutes les réunions physiques ou enregistrement de toutes les communications électroniques

5. Re travail :

Cette étape regroupe les travaux de correction des défauts détectés lors de la revue

 Correction des défauts détectés (réalisé généralement par l‟auteur)

 Enregistrer le statut modifié des défauts (dans les revues formelles) : par exemple la production d’une nouvelle version corrigée de la documentation revue.

6. Suivi:

Le Manager pilote les processus de revue, il suit les travaux de correction en vérifiant la prise en compte des défauts détéctés, qu’il n’y a pas de défaut qui a été oublié.

Les participants à la revue fournissent des indicateurs d’avancement sur les documents revues, les défauts détectés et les défauts corrigés.

Ces métriques sont collectés par le Managerpour vérifier (grâce aux critères de sorties définies lors de l’étape de la planification) si les conditions sont réunies pour clôturer le processus de revue.

 Vérifier que les défauts ont bien été traités

 Récolter les métriques

 Contrôle sur la base des critères de sorties (pour des types de revues plus formels)

2. Rôles et responsabilités (K1)

Il y a 5 rôles principaux que les participants à la revue peuvent endosser :

Le Manager est la personne qui doit prendre des décisions sur quand commencer ou arrêter chaque étape du processus de revue.

Le modérateur est un rôle important dans le processus de revue, le modérateur facilite les interactions entre les participants à la revue, il anime toutes les réunions de l’étape de la planification jusqu’à l’étape de suivi.

L’auteur est celui qui a écrit le document qui sera l’objet de la revue. Si l’auteur n’est pas disponible ce rôle peut être porté par une autre personne qui aura la responsabilité principale sur le document à revoir.

Les réviseurs sont les personnes qui vont concrètement relire les documents pour détecter les défauts. Il est conseillé que les réviseurs aient des profils différents pour multiplier les perspectives. Un document pourrait ainsi être vérifié par un utilisateur qui va vérifier que le document couvre bien un besoin réel, un testeur vérifie que des cas particuliers et des cas limites sont bien pris en compte, un profil technique vérifie bien que ce que décrit le document est techniquement réalisable. Tous les réviseurs émettent des questions et des remarques ou remontent des défauts potentiels.

Le Scribe garantie la traçabilité, note enregistre tous les points identifiés pendant la réunion.

Des check-lists peuvent être utilisés pour garantir que tous les aspects d’une revue ont été vérifiés, cela permet aussi de rendre les revues plus industrialisées et plus rapide en parcourant les points d’une check-list préétablie.

3. Types de revue

Il existe plusieurs types de revue.

Un document peut faire l’objet de plusieurs types de revue.

Le syllabus définit 4 types de revue de la moins formelle à la plus formelle :

La revue informelle
La relecture technique
La revue technique
L’inspection

La revue informelle :

La revue informelle est la revue la moins contraignante,
Elle n’obéît pas à un processus préétablie.
Elle peut se dérouler par la programmation par paires ce qui correspond à deux développeurs qui travaillent ensemble sur une même tâche sur le même poste. Cela diminue fortement le risque d’erreur.
La revue informelle peut aussi être effectuée simplement quand un profil technique relit seul le document de conception technique ou le code de l’application.
Les résultats de la revue peuvent être documentées mains ce n’est pas une obligation, les défauts peuvent être corrigés directement au fur et à mesure de leur détection.
Ce type de revue peut varier d’utilité selon les réviseurs, il n’y a pas de contrainte qui oblige à multiplier les réviseurs et ainsi varier les perspectives : utilisateur, testeur, développeur et opérateur.
L’objectif principal étant d’améliorer la qualité avec un minimum d’investissement.

La relecture technique :

La relecture technique est dirigée par l’auteur du document à revoir
La réalisation de la relecture technique peut être structurée sur la base des scénarios, en traitant le périmètre scénario par scénario, en faisant des répétitions à blanc pour comprendre et assimiler le contenu ou en impliquant des pairs càd des réviseurs qui ont le même profil que l’auteur et qui peuvent apporter un regard critique et enrichir le document revu.
Il n’y a pas de limite de durée définie pour ce type de revue
Ce type de revue peut être plus ou moins formel. Il est possible que les réviseurs préparent la revue au préalable mais cela reste facultatif ainsi que la présentation d’un rapport de résultats de revue et la participation d’un scribe.
Les objectifs de ce type de revue peut-être la relecture pour découvrir et apprendre le contenu du document, la compréhension et l’assimilation du comportement attendu de l’application si c’est un document de spécifications ou tout simplement de trouver des défauts.

La revue technique :

La revue technique est une revue documentée dont le formalisme varie aussi en pratique de quasiment informelle à très formelle.
Elle a comme objectifs de regrouper des pairs pour discuter du contenu des documents revus, évaluer les alternatives possibles, recommander des améliorations et décider des corrections.
La réunion de préparation est incluse.
Des check-lists peuvent être utilisées.
Un modérateur formé peut animer la revue
Un rapport de revue est présenté à la suite de la réunion de revue.

L’inspection :

L’objectif de l’inspection est de trouver des défauts

L’inspection est le type de revue le plus formel de cette liste.

Il inclut toutes les étapes du processus de revu présenté précédemment :

La planification, Les rôles, l’étape de préparation, le rapport de revue, les check-lists, le suivi et les métriques.

4. Facteurs de succès des revues (K2)

Pour qu’une revue soit une réussite :

Il faut que ses objectifs soient définis à l’avance et assimilés par les participants à la revue.
Il faut mettre les bonnes personnes aux bons postes
Plus on teste tôt mieux c’est, les revues interviennent tôt dans le processus de développement, si les testeurs sont impliqués dans les revues, c’est une occasion pour eux d’accéder et d’analyser au plus tôt la documentation de référence (base de test) et ainsi commencer à préparer les tests dès le début du projet.
Les défauts qu’ils soient détectés lors d’une revue ou lors d’un test classique, doivent être décrits de façon factuelle et neutre pour être acceptés et corrigés par les auteurs ou les développeurs.
Les interactions avec l’auteur du document revu doivent être respectueux et objectifs. Il ne doit se sentir jugé ou critiqué. Les remarques et commentaires exprimés lors des revues doivent être réalisés avec tact. Les participants doivent alimenter une ambiance de confiance.
Le choix du type de revue doit prendre en compte les objectif et le contexte du projet.
Quand le niveau de risque est critique et le niveau de qualité attendu dans un projet est relativement grand, le niveau de formalisme des revues doit s’y adapter. Introduire des check-lists rendra alors les revues plus efficaces ainsi que la définition de rôles précis pour les participants.
Les participants peuvent suivre des formations ou ils apprendront les responsabilités liées à ces différents rôles, comprendre le processus de revue et apprendre les différentes techniques de revue. Si les revues sont réalisées par un personnel formé, cela ne peut qu’améliorer l’efficacité de détection de défauts.
Les revues sont des activités à part entière qui doivent être correctement inclus dans le cycle de vie du projet et planifiés par l’encadrement.
La maturité des activités de revues augmente grâce à l’amélioration continue, les participants à la revue peuvent échanger sur le déroulement des revues précédentes et suggérer des actions pour améliorer l’efficacité des prochaines revues.