インターン向けの事前オンボード、チュートリアル資料を作成するにあたって意識する5つのこと

色々話の流れを省略すると、今日のmtg中にインターン向けのチュートリアル資料(フロントエンドエンジニア向け)があったらいいなという話なりました。前職でもインターン向けの資料やプログラムを比較的作っていたことが多かったので、考えていることを一度まとめようと思い、記事にしました。

では意識していること5つです。

これは、参照を適切に使い、自分で全て説明を書かない、という意図で書いています。特に、公式チュートリアルなどに書いてあることと同じことを書いてしまうことが最たる良くないケースだと思います。もしも既にあなたが説明したい何かが上手に説明されている資料がある場合は、そちらの資料に目を通して頂いた方が無駄や、変なミスも起きないので良いです。但し、いかに読んでもらいたい資料が多くとも、非常に参照をただ羅列するだけでは、読んでいただくことは難しい(Slackにただただ流れるリンクをあなたが全て読まないように)です。なぜこの資料が良い、大切なのかという補足や説明を加えることは良いと思います。

これはプログラミング、技術系の資料に共通することです。言語やフレームワークは当然アップデートしていきます。特定のバージョンの言語やフレームワークを利用した実際のコード例などを記載していく場合は、どこかで使えなくなったり、動かなくなったりするでしょう。本だと保険的な対策として、バージョンを明記する場合が多いと思います。但し、仮に古いバージョンを利用した資料を使ったとして、インターンとして入社後にそのバージョンのプロダクトを触らないのであれば、古いバージョンに触ってもらう意義はほとんどありません。なので、そういった資料を作る場合は、基本的に依存する言語やフレームワークの更新に応じて、資料をメンテナンスする必要が出てくるということです。全く経年劣化しない資料を作成するのは難しい場合もありますが、最新バージョンのリングが固定の場合は、そちらにナビゲートし、最近の環境で試してもらえるような資料を維持する方が良いでしょう。

1とやや関連しますが、逆に書かないと意図が伝わらないこともあります。それは、課題をどこまで理解してもらうことを期待しているのか、なぜこの技術を事前に学んでおいてほしいのか、といった理由づけの部分です。ここには、それぞれの会社や部署独自の背景がある場合が(おそらく多く)、それを説明することで、より実際に仕事したり、プロジェクトに入っていただく上で必要だということを伝えることができます。

甘いという人もいるのかもしれませんが、次にやる側にとって辛いのは、1-100まで全部やってくれ、それ以外はない。という感じの資料です。目的にもよりますが、大抵の場合、チュートリアル資料を配布する理由は、

チュートリアル資料を全て完了させる(課題や宿題のイメージ)

ではなく、

チュートリアルを利用することで、会社に必要な技術、知識を得ることを楽にする

ことにあると思います。

チュートリアルを作り込んでいくと、多大な愛が注ぎ込まれて、全部やってくれまじで、、という感じになることも多いと思いますが、全部やってくる前提の資料をくばり、いざ現場に来て頂いた時にやってなかった場合、ここでお互いに色々コストが発生し、あまりうまくいくイメージがありません。

できるだけ確実にやってほしいことは絞り、それ以外は、もしも事前に理解していただけたら業務上役に立つ、こういったことができるようになるという流れで追加項目を用意しておくのが良いです。そして、追加項目こそ丁寧に、かつ大量に用意しておいても良いと思います。たまにはまってめっちゃ学習してきてくれて、即戦力な感じできてくれることもあります。

4に記載している

>チュートリアルを利用することで、会社に必要な技術、知識を得ることを楽にする

とも関連しますが、基本的に、エンジニアはどこかのタイミングで自走して学習していくようになります。それは公式チュートリアル、公式のドキュメントを読めるようになったタイミングであったり、自分でいくつかのプロダクトを作る過程であったり。自走してもらえる人には、チュートリアルはいりません。というか、そういう人にも意味があるチュートリアルを書くというのは、非常に高い品質のチュートリアルであることが求められる、という言葉が正しいかもしれません。

以上、簡単になりますが、意識していることです。チュートリアルや、オンボード向けの資料を作られる方の助けになれば幸いです。