新加入メンバーへの説明

」新たに開発チームに加わるメンバーは、担当するソフトウェアの設計に関する情報をほとんど持たずにチームに加入します。加入当初から新メンバーが、独力だけでソースコードを読み進めるのは、効率の良い方法ではありません。ソースコードのみから設計の意図を読み取るのは難しいからです。

多くの場合、当該ソフトウェアの設計に精通した既存メンバーから、新加入メンバーへ口頭で説明を行うことになるでしょう。しかし、一から全てを口頭で説明するのは大変ですし、さらに設計に精通したメンバーは忙しく、何度もつかまえて十分な説明をしてもらうのは難しいかもしれません。

こんな時もJIGドキュメントを使えば、効率的に設計に関する情報を新加入メンバーに伝えられます。既存メンバーは口頭説明の際に毎回手作業で設計を図解せずとも、ソースコードから設計を可視化するJIGドキュメントを使えば説明が楽になります。新加入メンバーが初めて見るJIGのドキュメントを独力で読み解くのは難しいでしょうが、設計に精通した既存メンバーがJIGドキュメントとともに設計を口頭で説明すれば、新加入メンバーがソースコードを読み解くスピードも速くなるでしょう。

新規加入メンバーがJIGドキュメントを見る順番として、例えば最初にアーキテクチャ図やサービスメソッド呼び出し図でソフトウェア全体の構造を把握し、 ユースケース複合図や機能一覧でそのソフトウェアがもつユースケースを把握するなどが考えられます。既存メンバーと話し合いながら、パッケージ関連図や区分図、ビジネスルール関連図などを参照すれば、ビジネスルールパッケージ以下のクラスを素早く理解できるはずです。そうすれば、新規加入メンバーがソースコードを後から自分で読み解く際も、ずっと簡単に読み解けます。

JIGは会話を促進するツールなので、是非既存メンバーと新規加入メンバーの間の会話をスムーズにすることにも利用してください。 「会話に使用するには難しい」「もう少しこうなっていれば使いやすいのに」と言ったことがあれば、ぜひissueなどでご意見ください。