skillup

技術ブログ

ドキュメント作成 プロジェクト管理

レビューについて

投稿日:2022年8月31日 更新日:

以前、コードレビューそのもののポイントについてはコードレビュー時のポイントでまとめましたが、レビュー自体の体制の注意点やそこでの気づきなど。

目的

基本ルールに則っているかどうかを見るといった初歩的な意味もありますが、人間の思考の漏れを検証するといった意味あいが強いため、多人数で行わないとそもそもの意味がない・・・と思います。

定型的なものはチェックリストを

これについてのなるべく頭を使わずに自動ではじける仕組みが大切。

  • ドキュメントの体裁→チェックリストやなるべく標準のテンプレート、標準の修正機能で防げるようにしたい
  • 規約的なものは例えば規約ツールで自動ではじくなど

このレベルで毎回指摘する、指摘事項が変わる。。。などがないようにしたい。

レビュアーの負担軽減

  • 仕様が複雑だったり、粒度が大きいものは対面でまずざっくりとレビュイーが説明をし、改善点に関しては回覧レビュー(メッセージのやり取りだけ)を行う
  • 当事者意識を持たせるために、レビュアーにノルマを付与するといいかも(一回のレビューの際に必ず何らかの指摘事項をもうけるなど・・)
  • リマインダーなどで自分の分を告知する仕組みが必要かも(Slackへの告知など)
  • 参加する際の前提知識やそもそもの仕様の共有が最も大切
  • そもそもの人間関係を壊さないような文化づくり(根本的にある信頼関係の構築)が最も大切
  • 神学論争的なものは最終決定権のある人間に決めてもらう(当人同士で争わないように)

レビューポイントについて

  • 見るポイントを各人で担当制にする(仕様的な部分、コードの設計的な部分)
  • できればファイルなどを細かく分割して、小分けにする
  • 必ずなおす、直してほしい、できたら、のようにウェートをつける
    (理想論でいえば全て直してほしいが、そのタスクがブロックになってしまい、後続タスクへの影響などをなくすため。できたら・・などは別タスクとして別途レビューをする)
  • 指摘事項で多いもののリストアップ→なるべく他のメンバーでもレビューをできるようにする、見れるようにするため
  • 余裕があればレビューの指摘事項で上がっているものの類型化など

-ドキュメント作成, プロジェクト管理

執筆者:


comment

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

関連記事

no image

リーダーがボトルネック(リソース不足)になっているケース

プロジェクトでの頻出問題点と自分なりの対策などではプロジェクト全体を見渡して起こりがちな問題点などをまとめたのですが、リーダーのリソース不足でプロジェクトがまわっていないというケースもかなりあり、これ …

no image

コレクションの頻出処理に関して

PHPでコレクションを使っていますが、慣れると本当に便利ですね・・・まあforeachとかでグリグリやってもいいのですが、無駄にコードが長くなります。 自分がコレクションでよく使う再頻出のメソッドなど …

no image

プロジェクトマネジメントについて

ある程度、大規模なプロジェクトを経験させていただき、経験だけでなくプロジェクトマネジメントを体系的に理解しておきたいため、ポツポツと本を読んでます。 比較的初心者でも読みやすいと思った本としてを2冊メ …

no image

API仕様書に関する注意事項

API仕様書を作っていて、基本的な点についてのまとめ コードと連動できれば理想(現実的には設定ファイルをJSONかYamlで作るぐらいが限界だと思う) 型のチェック、必須チェック、桁数チェック、日付の …

no image

EntityとValue Objectについて

ドメイン駆動設計に関して勉強しています。参考にしている本がやたら難しいんで、トピックごとにネットで調べつつ進めていくのがよさげです。 今回はEntityとValueObjectについて Content …

アーカイブ