現場で使えるエンジニア引き継ぎ資料の作り方

ドキュメント 現場で使える

概要

アジャイル開発が中心となっているこのご時世、エンジニアは引き継ぐことが非常に多くなってきています。 そんな中で、引き継ぎ資料作成は何のためにやるのか。そしてどうやって作成するのか、をまとめたいと思います。

引き継ぎで喜ばれることは

引き継ぎは無駄になることが非常に多いです。 もちろん途中になっている仕事を口頭で引き継ぐことで役に立つこともあります。 しかし、今までの知見を資料として残すものは結局役に立ててもらえない...ということが多いと感じます。 では、引き継ぎをやるモチベーションはどこか...

その資料あってよかった〜と言ってもらえることです。

引き継ぎ資料作成の軸

引き継ぎ資料作成は形骸化しやすいランキングベスト10に入ると思っています。 ですので、引き継ぎの目的、軸を認識するのが大切かなと思っています。

軸は主に3つ

  • 自分しか知らない情報を資料に残す
  • 次の開発に役立つ情報を資料に残す
  • 現状をしっかり資料に残す

この3つを意識することで、あってよかった〜につながるはずです。

軸について

自分しか知らない情報を資料に残す これは、知らない情報で業務に支障をきたすと判断されるものは残すべきです。 当然といえば当然ですが、漏れやすいものです。 漏れないテクニックは、1つしかありません。 常日頃からメモを取っておく...です。

次の開発に役立つ情報を資料に残す 引き継ぎでけっこうあると嬉しいのは、その開発のアドバイスです。 ここが肝でこうこう対応すると良いと思います、といった辞める人の意見・方向性があると良いです。 その意見が採用も良いですが、さらに良いのがその意見があることで違うB案,C案と考えが広がる軸を作れたというのがさらに良いことだと思います。資料を残す側も、別に採用されなくてもいいや、という気持ちで残すぐらいでいいと思います。

現状をしっかり資料に残す 引き継ぎによくあるのが、引き継ぎ内容はたくさん書いてあるのだが...「で？」というものです。 引き継ぎ資料で知りたいのは、現在の状態であることが多いです。 あとは何をやるべきなのかを残すのがメインです。

引き継ぎページをリンクのみ

引き継ぎ資料を作るとき、その資料1つに壮大なものを作ることがあります。 それは、ただただ見にくい、読みにくい、読みたくない...となります。

引き継ぎ資料と呼ばれるものはリンクのみでOKだと思っています。 簡単に言えば、索引(インデックス)を作るのみです。

では内容はどうするのか？

内容は社内資料

内容は社内資料の中に埋もれさせましょう。 埋もれていいのか...私はいいと思っています。 理由は明確に1つあります。

資料はその資料と関連性がある箇所に置くのが良い

というのも、引き継ぎ資料として１つの資料に残すと、それを見にいくという意図がない限り、そこには辿り着けないからです。検索すれば偶然辿り着けることもあるかもしれませんが、関連しているところから辿り着くほうが全ての人が発見することが可能です。これはプログラミングでいうなら 集約 です。その資料が関連するコンテキスト内に配置し、凝集度を高めることで、変更容易性・保守性を高めるといった感じでしょうか。 前述していますが、引き継ぎは形骸化します。引き継ぎの資料は誰も見なくなるものという認識を持つことで、集約について考えることができます。

まとめ

  • 引き継ぎ内容は軸を意識する
  • 引き継ぎ資料は索引(インデックス)を作るのみ
  • 引き継ぎ内容は関連性の高いところに残す