5 raisons pour lesquelles vous devriez utiliser une application d'enregistrement d'écran pour la révision du code

Un développeur passe 5 heures par semaine révision du code. C'est comme 12,5% d'une semaine.

Ce n'est pas une mauvaise chose. En fait, la révision du code est l'une des principales responsabilités des développeurs seniors dans les entreprises informatiques. Pour vérifier les faits, consultez la colonne des responsabilités de ce modèle de description de poste pour le poste de développeur senior.

La révision du code est une excellente pratique car toute l'équipe travaille ensemble pour trouver des fautes de frappe et le plus grand ennemi d'un développeur, les bogues . Cette activité garantit que la qualité est maintenue, que les résultats sont bien documentés et que le produit fonctionne bien.

Pour chaque développeur qui écrit du code et le fait réviser, il s'agit d'une étape importante dans son parcours d'ingénieur logiciel. Dans un environnement typique, la revue de code est effectuée par une équipe de développeurs qui ne font pas partie du même projet. Cela signifie que l'auteur du code a une nouvelle perspective sur les erreurs qu'il commet et sur les domaines qu'il néglige. L'apprentissage est maximal ici car il y a tellement d'occasions de collaborer, de partager des idées et d'absorber de nouvelles techniques des autres équipes.

Envoyer des commentaires sur la révision du code

Bien que nous ayons trouvé beaucoup de contenu sur les bonnes pratiques pour la revue de code, nous n'avons pas été très impressionnés lorsque nous avons recherché différents outils de communication pour partager les commentaires de la revue de code avec l'équipe.

Nous avons pensé que peu de réflexion était consacrée à la partie "comment" de la communication des commentaires sur la révision du code au pair. Étant une pratique régulière, elle a été suivie comme une coutume d'une génération de développeurs à l'autre.

Le but de cet article n'est pas d'attaquer ou de remettre en cause la coutume, mais d'essayer d'apporter un changement positif. Actuellement, la plupart des commentaires sont partagés à l'aide d'e-mails, de captures d'écran, de réunions en ligne, de discussions en ligne et d'appels téléphoniques. Cela couvre la liste complète des outils de communication auxquels vous pouvez penser pour communiquer les commentaires sur la révision du code. Cependant, ils ont tous un côté gris à eux-mêmes.

E-mails - Peut devenir trop long (ou court) et pas très personnel

Captures d'écran - Juste des images statiques, peu interactives

Discuter - Asynchrone, et on passe beaucoup de temps à faire des allers-retours

Réunions et appels - Synchrone, et fatigant car cela peut durer plus longtemps

Pour combler les lacunes créées par ces outils, l'enregistrement d'écran peut être une excellente option pour partager les commentaires sur la révision du code. Avec des outils asynchrones comme les e-mails et les chats, vous pouvez en afficher plus au lieu de taper une série de lignes et de paragraphes.

Le partage d'écran est également une excellente alternative pour limiter le nombre d'appels téléphoniques et de réunions. Vous pouvez discuter des erreurs plus critiques de manière synchrone, et pour le reste, vous pouvez partager une session d'enregistrement d'écran. Cette combinaison garantira que le travail le plus urgent soit effectué immédiatement sans le traîner trop longtemps.

Très bien, allons de l'avant et apprenons-en plus sur les avantages de l'utilisation d'une application d'enregistrement d'écran pour partager les commentaires sur la révision du code.

Gardez-le personnel

En tant qu'enfant, nous courions souvent dans la maison avec enthousiasme pour montrer à tout le monde notre dernière activité créative. Nous avons fait cela pour obtenir leur attention personnelle et leurs commentaires, car cela a été un énorme coup de pouce pour nous. En tant qu'adulte, nous aspirons toujours à ce coup de pouce intrinsèque. Dans un lieu de travail, 98 % des employés ont admis qu'ils se sentiront désengagés si le manager ne donne pas ou très peu de feedback.

Si les commentaires sont si cruciaux, les partager par e-mail, chat ou captures d'écran enlève l'attention personnelle. Par exemple, dans un e-mail autre que le nom du destinataire, vous ne pouvez pas faire beaucoup de personnalisation. Taper beaucoup de mots est une douleur pour le réviseur ainsi que pour l'auteur du code. Avec un outil d'enregistrement d'écran , vous pouvez partager votre écran pour afficher vos commentaires et discuter avec eux. C'est excellent pour l'employé car il peut vous entendre et voir vos commentaires. C'est presque comme avoir une réunion personnelle de manière asynchrone.

Créer des vidéos pédagogiques

Avec l'enregistrement d'écran, vous pouvez aller plus loin que de l'utiliser uniquement pour partager des révisions de code. Compte tenu de la simplicité de création de vidéos avec une application d'enregistrement d'écran , vous pouvez afficher votre écran pour partager les bonnes pratiques en matière de documentation, des extraits de connaissances sur l'architecture du code et la création de flux de débogage. C'est très bien pour le partage des connaissances et pour éviter les futurs obstacles.

Maintenant, imaginez faire tout ce qui précède par appel ou par e-mail. Ce n'est pas seulement intimidant, mais aussi très décourageant par nature.

Créer une bibliothèque dédiée

Si vous utilisez un outil d'enregistrement d'écran gratuit comme Vmaker , vous pouvez créer un espace de travail en tant que base de données pour toutes les vidéos pertinentes. Cela permet de créer des vidéos de révision de code avec des applications d'enregistrement d'écran remonter d'un cran. Vous n'avez pas besoin de passer du temps à rechercher votre dernière session d'enregistrement lorsque vous identifiez un bogue similaire dans un code. Une fois que vous avez une série de vidéos, vous pouvez les partager avec les nouveaux membres de l'équipe ou les réutiliser à d'autres fins de formation.

Annotez les zones cruciales du code

L'annotation est un excellent moyen d'attirer l'attention. Ceci est bénéfique à la fois pour l'auteur du code et pour le réviseur. Il est fortement recommandé que l'auteur du code annote le code source avant de le partager avec les réviseurs, car ils pourraient rencontrer des défauts avant même le début de la révision. Pour un examinateur, il est plus facile pour eux d'identifier où ils doivent regarder exactement. Cela rend la communication plus précise et transparente.

Dans les images statiques comme les captures d'écran, l'annotation fonctionne, mais cela peut devenir fastidieux s'il y a trop de captures d'écran. Dans un enregistrement d'écran, l'annotation reste à l'écran pendant un temps minimal. Cela signifie que la zone est clairement mise en évidence, mais ne reste pas trop longtemps pour gêner l'expérience de l'utilisateur.

Communiquer clairement

Cela aurait probablement dû être le premier point, mais nous voulions garder cela pour le dernier. L'enregistrement d'écran n'est pas seulement un outil de communication vidéo asynchrone. Il promet bien plus que les autres outils que nous utilisons pour les revues de code sur les lieux de travail.

Les outils actuels sont excellents, mais ils ne sont pas aussi multidimensionnels que l'enregistrement d'écran. La révision du code est très utile lorsque vous partagez non seulement des commentaires, mais que vous créez également une ressource pouvant être utilisée pour de futurs cas d'utilisation. Pour l'instant, les applications d'enregistrement d'écran sont les seules à cocher toutes les cases.

En conclusion

Peu importe que vous soyez un auteur de code ou un réviseur, si vous n'avez pas pensé à essayer l'enregistrement d'écran pour partager les commentaires de révision de code, il est grand temps que vous commenciez à y penser.

Écrire du code est un travail difficile, tout comme donner des commentaires. Le processus de révision devient encore plus difficile lorsqu'il y a trop de choses à dire. Les e-mails et les appels téléphoniques deviennent fatigants au bout d'un moment. L'enregistrement d'écran le fait sans effort car il est de nature asynchrone mais personnelle.
Si vous envisagez de vous lancer, consultez ici Vmaker, un outil d'enregistrement d'écran qui vous permet d'enregistrer gratuitement des vidéos d'écran et de webcam.

Guide des bonus pour les équipes de développement :
Comment rédiger un rapport de bogue ? [Outil gratuit + Modèle]
Maîtriser la communication pour les équipes agiles en 2021

Un guide complet de l'enregistreur d'écran