先日、プロジェクト参画3ヶ月めにして、協力会社さんの契約終了が決まり、諸々引継ぎを受ける必要が出てきました。
その時に実施した内容について、それ以前の経験も踏まえ、覚え書きを兼ねて記事にしておきます。
概要
引継ぎについて、
- 引き継ぎをする側の作業
- 引き継ぎを受ける側の作業
に分けて書いています。
今回、自分は引き継ぎを受ける側でした(ので、そのような書きっぷりになっている点、ご了承ください。)
実際の作業
1. 引き継ぎをする側の作業
まずは、引き継ぎをする側の作業について
今回、前任者や協力会社さんに依頼して実施いただいた作業になります。
(1) プロジェクト概要の説明を受ける
今回はプロジェクトに参画してそこそこ期間がたっていたため対象外でしたが、参画して間もないプロジェクトを引き継ぐ場合は、必ず前任者からプロジェクト概要について整理してもらい、説明を受けるようにします。
そんなの当たり前でしょ? と思われるかもですが、時間がない時や参画して間もなく右も左も分からない時など、どさくさに紛れて実施されずに終わってしまった、なんてこともあるもの。
意識しておくとよいでしょう。
(2) ドキュメントの最新化、ブラッシュアップ
引継ぎを受けるに当たって、いちばん重要なのでは? と思うパートがコチラ。
ドキュメントを現状に合わせて最新化、更に、内容をよりわかりやすくブラッシュアップされていれば、言うことナシ。
ザッと以下のようなものが対象でしょうか。
①WikiやREADMEの最新化、ブラッシュアップ
重要なのに、意外と放置されがちなのが、WikiやREADMEの最新化。
プロジェクトの在籍期間がそこそこ長くなってくると、あまり見なくなってしまうからか・・?
何はともあれ、初めて見た人が理解できるか?という視点から、手直しをお願いしましょう。
②各種設計書、仕様書の最新化
追加開発などがあった場合、更新を忘れがち。
最新の内容に沿っているか? 確認してもらい、合っていない場合は修正してもらいます。
③ソースコードへのドキュメンテーションコメントの追記(ない場合)
ソースコードにドキュメンテーションコメントの記載がない場合は書いてもらうとよいです。
ソースコードの内容を把握でき、また、設計書化もできるようになるので、一石二鳥!
ただし、コメントの書きすぎはかえってコードが見づらくなってしまうので、粒度についてはよい感じに調整してください。
④システム構成図の最新化
コチラも意外と放置されがち。
後々も手軽に修正できるよう、draw.ioなど、編集しやすいツールを使って更新してもらうようにしましょう。
⑤虎の巻の作成
引継ぎを受ける側が知見の薄い分野について、チュートリアル的なものを作ってもらうとよいでしょう。
普通のチュートリアルなら、公式サイトを見れば? というお話になるかと思いますので、プロジェクト特有の内容も盛り込んでもらうのがベター。
(3) 優先度の高いタスクの消化
引継ぎではないですが、引き継ぎ作業を実施してもらいながら、優先度の高いタスクの消化も忘れずに。
特に終盤は、工数との兼ね合いで、やる/やらないを決めるようにします。
(4) システム監査対策
プロジェクトの進度にもよりますが、システム監査対策がなされているかもヒアリングしておきましょう。
具体的には、
- テスト仕様書と証跡の保管場所/方法
- リリース手順とリリース後確認の方法/記載場所
- ログの取得方法、保管先と保管期間
あたりでしょうか。
2. 引き継ぎを受ける側の作業
引き継ぎを受ける側、今回は、自分側の作業です。
(1)ドキュメントレビュー
1-(2)で最新化してもらったドキュメントをレビューします。
体裁に関する指摘だけでなく、レビューの中で、疑問点が出てくれば質問するようにすると◎。
(2) 実際に開発、リリースしてみる
実際に開発をして、引き継ぎする側にレビューをしてもらうようにします。
レビュワーがどういう観点でレビューをしているか、にも注目しましょう。
リリース作業まで実施して、手順を確認しておくのが吉。
(3) 適宜不明点を質問する
Google Sheetsなどで質問票(一問一答形式でもOK)を作り、適宜記入してもらうとよいかと。
必要に応じて突撃インタビュー(直接聞く)のもアリ。
(4) 新体制に向けての準備
新規メンバー参画が控えている場合は、準備も怠らないように。
ザッと以下のような内容でしょうか。
①各種アカウントの開設等
手続き系は、承認フローとの兼ね合いから、思った以上に時間がかかることがあります。
余裕をもって実施するようにしましょう。
②技術スタックの共有
事前に、プロジェクトの技術スタックを共有しておきます。
可能であれば事前に少しかじっておいてもらうと、参画後、スムーズに開発に着手してもらえるハズ。
ただし、他の業務との兼ね合いもあるはずなので、強制はしないこと。
③説明資料の準備と実施
-
事前説明
可能であればプロジェクト参画前に少し(最大30分程度)時間をもらって軽くプロジェクトについて説明をするとよいでしょう。- プロジェクト概要: どういったモノを作るか(コトをするか?)
- プロジェクトの沿革: 今どういったフェーズなのか、体制の変遷など
- 技術スタック: ②の内容と被りますが、口頭でも伝えるようにするとよいです。
-
参画後の説明準備
事前説明よりも詳細な説明を準備します。- システム構成、フロー
- 各種ドキュメントのありか
- 開発のお作法
などなど、開発を進めるにあたって必要な知見を説明します。
終わりに
今回、引き継ぎに使えた時間は1ヶ月。
比較的余裕はあった方かと思いますが、、引き継いでもらう内容がパッとは思い浮かばず、実は、一部の作業で、やり残しが出てしまいました・・・。
自戒の意味も込めて、本記事を執筆。
今後、同じ二の轍を踏まないようにしたい・・・!
また、後々、この点足りなかったな、という内容が出てきたら随時追記したいと思います。