Indications pour la révision de la conception et du code
Mise à jour : novembre 2007
Les indications suivantes fournissent plusieurs techniques pour la révision de la conception et du code.
Obligatoire
Prenez votre temps pour effectuer la révision.
Le but de la révision est de bien comprendre et analyser la conception et le code. Consacrez à la révision la moitié du temps que vous avez consacré à écrire le code ou à planifier la conception à l'origine.
Laissez les relecteurs diriger la révision.
Les relecteurs et leurs commentaires doivent diriger une révision. Si les développeurs sont autorisés à effectuer des révisions de leur propre travail, les autres relecteurs risquent de ne pas détecter les problèmes.
Lisez le code ou le document de conception avant la réunion de révision.
À moins que l'objectif de la réunion soit la révision de quelques modifications mineures, préparez suffisamment à l'avance les réunions de révision. Si les relecteurs ne préparent pas les réunions de révision à l'avance en lisant le code ou la conception, tous les participants perdront leur temps.
Utilisez Team Project Portal pour les révisions de groupe.
Publiez vos documents de conception sur un portail de projet où tout le monde peut les trouver et les réviser facilement. Envoyez un pointeur vers le document publié aux relecteurs et demandez-leur d'ajouter leurs commentaires à l'aide de la fonctionnalité de discussion d'Internet Explorer. Si vous souhaitez que votre code soit révisé de la même façon, collez-le dans un document Word et publiez-le également sur un site SharePoint. Pour plus d'informations, consultez Utilisation du portail du projet d'équipe.
Utilisez une liste de vérification.
Il est facile de se laisser accaparer par certains aspects d'une révision, par exemple en se concentrant exclusivement sur la sécurité, la gestion des erreurs ou le style. Vous pouvez être tenté de passer à d'autres tâches après avoir passé en revue un seul point. Les listes de vérification vous rappellent tous les aspects différents que vous devez couvrir dans votre révision.
Suivez tous les problèmes trouvés lors de la révision d'un code.
Documentez les problèmes sous la forme d'éléments de travail, de commentaires dans le code ou de problèmes dans les documents de conception. Sinon, les problèmes risquent d'être ignorés et vous n'aurez rien gagné pour le temps investi dans une révision de code. Pour plus d'informations, consultez Comment : ajouter de nouveaux éléments de travail.
Évitez de
Modifier le code ou la conception sans informer les relecteurs.
Vous pouvez trouver des erreurs dans votre conception ou votre code après l'avoir envoyé en révision, mais vous devez résister à la tentation de résoudre les problèmes avant la réunion de révision. Si vous modifiez le code ou la conception avant la réunion, cela créera une confusion et vos réviseurs le prendront probablement mal. Traitez plutôt les erreurs que vous trouvez comme si vous étiez le relecteur ; notez-les et suivez-les avec tous les autres commentaires de révision.
Recommandé
Faites participer des représentants de toutes les disciplines.
Bien que faire participer diverses disciplines, en dehors des développeurs, à la révision des conceptions et du code ne soit pas toujours faisable, des représentants d'autres disciplines peuvent aider à découvrir des problèmes difficiles à détecter. Il suffit d'avoir une, voire deux personnes, par discipline. La participation d'un nombre plus important de personnes rendrait les révisions longues et difficiles à gérer.
Révisez tout le code et les conceptions.
Pour garantir la qualité de votre produit, faites réviser le code et la conception de tous vos projets. Les révisions doivent inclure la vérification par le compilateur, des tests unitaires et la documentation de la conception dès le départ.