リモートチームでのデスクチェック

開発者として、できる限り大規模なプルリクエスト（PR）は避けたいと思っていますが、タスクの規模が大きいため、または小さく分割することが難しいために常に可能ではありません。そうは言っても、とても大きく複雑な同僚のPRをレビューする状況に置かれたことはありませんか？コードを理解して機能をテストし、品質基準をチェックして建設的なフィードバックを提供するために数時間が必要に感じたり、多くのファイルの中で迷子になりそうになったことはありませんか？このようなことをもっと迅速かつ効果的に実行する方法を知りたくはありませんか？

これらの質問に「はい」と答えたならば、「デスクチェック」と呼ばれる技術が役に立つでしょう。この投稿では、デスクチェックとは何か、その利点、そしてその適用方法について説明します。

デスクチェックとは何か？

デスクチェックは、PRの著者と一人または複数のレビュアーとの間で行われる同期セッションを含むコードレビューの実践です。このセッション中、著者は自分の作業を提示し、その決定を説明し、実装された機能を実演し、レビュアーの質問に答えます。

デスクチェックの目的は、コードの理解を容易にし、提案されたソリューションを検証し、潜在的な問題や改善点を特定し、PRの承認プロセスを迅速化することです。

デスクチェックの利点は何か？

デスクチェックは、著者とPRレビュアーの両方にとってチームにいくつかの利点を提供します。その中には次のようなものがあります：

• コード品質の向上: 他の人に作業を提示することにより、開発中に見落とされたエラーや矛盾、特にビジネスロジックに関するものに気付くことがあります。加えて、レビュアーは改善点を提案したり、著者が考慮しなかった欠点を指摘することができます。
• レビュー時間の削減: 複雑なコードを何時間も読んでテストする代わりに、15分から30分のデスクチェックセッションでPRの概要を把握できます。これにより、レビュアーは無関係な詳細に迷わされることなく、最も重要で関連するポイントに集中することができます。
• 協力と学習の促進: デスクチェックを通じて、チームはコードと問題の領域に関する知識、経験、およびベストプラクティスを交換できます。これは継続的なフィードバックの文化を育て、チームメンバー間で最適なソリューションを普及させるのに役立ちます。
• 信頼と満足の増加: それらの作業に対して積極的で建設的なフィードバックを受けることは、著者の自信とモチベーションを高めます。同時に、レビュアーは自分自身がチームにより参加し、価値を置かれていると感じます。

リモートチームでデスクチェックを実施する方法は？

リモートチームでデスクチェックを実施するためには、いくつかのツールとヒントが必要です。それらを見てみましょう。

ツール

• ビデオ通話ツール: デスクチェックセッションのビデオ通話とオーディオ通話、スクリーンシェアに使えるツールが必要です。選択肢には、Slack、Google Meet、またはMicrosoft Teamsなどがあります。
• コード管理ツール: PRを作成、レビュー、承認するためにツールが必要です。選択肢には、GitHub、GitLab、Bitbucket、またはAzure DevOpsなどがあります。
• タスク管理ツール: PRの進行に関連するタスクを追跡するためのツールが不可欠です。選択肢には、Jira、Trello、Asana、またはNotionなどがあります。

ヒント

• 事前準備: デスクチェックセッションを開始する前に、エラーやバグのない状態でコードを提示できるように準備してください。環境が正しく設定されていて、依存関係がインストールされ、データが更新されていることを確認してください。また、プレゼンテーション中に何を示し説明するか、主要な点を強調してアウトラインを作成してください。
• 都合の良い時間を選ぶ: 参加者全員にとって都合の良い時間を選んでください。
• 明確かつ簡潔に: プレゼンテーション中は、参加者の時間を無駄にしないように、直接的かつ明確、簡潔にコミュニケーションを取ってください。何を、なぜ、どのように行ったかを説明してください。成功と失敗の両方のシナリオを含め、実装された機能をデモします。レビュアーの質問には正直かつ敬意を持って答えてください。
• 受け入れとオープンである: フィードバック中には、レビュアーの提案や批判に対して受け入れ、オープンにしてください。PRに費やされた時間と注意に感謝してください。観察を個人的に捉えるのではなく、改善の機会として捉えてください。提起されたポイントをメモして、それらに対処するか改善するかに取り組んでください。

結論

要約すると、デスクチェックは特に大規模なPRにとって多くの利点をリモートチームにもたらすことができるコードレビュー技術です。デスクチェックを通じて、コード品質を高め、レビュー時間を短縮し、協力と学習を促進し、チームの信頼と満足を向上させることができます。

しかし、デスクチェックは万能薬ではなく、すべてのチームや状況に常に適しているわけではありません。伝統的なコードレビューを完全に取って代わるものではありませんので、ケースごとに評価することが大切です。私は以下の場合に良いオプションだと考えています：

• 非常に大規模なPR: 伝統的に一行一行レビューを行うことは、レビュアーにかなりの認知負荷を課し、結果としてレビューの品質や、それに続くコードの品質を損なう可能性があります。
• 通常のレビューを補完する: ロジックと決定を抽象的に評価するため、または他のレビューステップが終了した後の追加の検証として、通常のコードレビューに加えてデスクチェックを行う。

この投稿が役立ったことを願っています。気に入ったら、チームの同僚と共有してください。もし質問や提案があれば、お気軽に連絡してください。

読んでいただきありがとうございました。また次回まで！😊

こちらの記事はdev.toの良い記事を日本人向けに翻訳しています。
https://dev.to/viniciusnyp/desk-check-in-remote-teams-3em7