はじめに
この記事はエムスリーキャリア FY22 AdventCalendarの2日目の記事です。
社内でオンボーディング用の資料を作成したら、思いのほか評判が良かったので、作成時に意識したことをまとめてみます。
下記のようなストーリーになるように気をつけました。
- ユーザとして見えるシステムの仕様・用語を説明する
- ルールがなぜそうなっているのかを伝える。あるいは不文律として伝わっているルールを資料に明文化して伝える
- 中心となるシステムの役割を伝え、全体のデータの流れを伝える
- それらが分かったら、システムの裏側を触ってもらう課題にチャレンジしてもらう。
- たとえば、システムの管理画面を触りながら、ユーザデータを触ったりしながら、システムが参照するデータについて理解を深める。
なお、私の場合は、すでに社内でいろんな方がガイダンス資料を作成されていたので、今回はそれらをパッチワークのように組み合わせつつ、補足したり課題を追加したりして資料を作成しました。
ストーリーの流れ
ユーザとして見えるサービスの仕様・用語を説明する
まずはユーザ目線でサービスを概観するようにしました。また、社内用語やドメイン用語などについても説明するようにしました。
いきなり、システムの内部の話をしても、何をしているのかわからないと思うので。
また、自分たちが触るサービス以外にも、社内の中心となる他サービスについても説明するように心がけました。
ルールがなぜそうなっているのかを伝える。あるいは不文律として伝わっているルールを資料に明文化して伝える
ルールについてきちんと伝えます。事故を発生させないためには、なぜそのルールが必要になったのかをきちんと理解してもらうことが必要です。
そこで、ルールを説明する際には、それが必要になった背景や経緯（過去の事故事例など）についても触れます。
例えば、社員が本番環境を触る際には少なからずルールが存在すると思いますが、その際のルールについて理由などを説明します。その際、サービスの仕様でルールに関連する仕様を説明しておくとより納得感が増します。
中心となるシステムの役割を伝え、全体のデータの流れを伝える
サービスの概要が掴めたら、内部のシステムの説明に移ります。
弊社の場合、マイクロサービスで連携する形構成されているため、どんな登場人物が出てくるのか、それらはどういう通信をしているのかというデータの流れについて中心に説明します。
その際、実際のサービスを動かしながら説明すると、理解が深まると思われます。
それらが分かったら、システムの裏側を触ってもらう課題にチャレンジしてもらう。
理解度を確認してもらうため、なんらかのシナリオに基づいて操作を行ってもらいます。シナリオは課題として用意しておき、その課題を理解してもらうのに必要な情報を、前項までで説明するように資料をデザインするように心がけます。
例えば、「テスト環境で会員を登録→管理画面から操作→DBの会員情報を確認」といった操作をしてもらいます。
こうすることで、実際に手を動かせるので、なんとなく、どんなふうにデータが流れるのかが体感できると思われます。
ただ、実際に手を動かしてもらう際には、資料の説明以外にも接続情報など多数の環境固有の説明が必要かと思いますので、その点のフォローも忘れないようにします。
最後に
ストーリーを持って段階的に構成を説明し、課題を用意して手を動かしてもらうことで、理解を深めてもらうという流れがあると、理解がスムーズになるかと思います。
よろしければ参考にしてください。