技術を伝える授業や技術ハンズオンの資料づくり 2023 年振り返りのメモ

この記事は DevRel Advent Calendar 2023 の 11 日目の記事です。技術を伝える授業や技術ハンズオンの資料づくり 2023 年振り返りのメモです。

DevRel において授業資料やハンズオン資料は大事

技術を伝える上で URL ですぐ見られる資料は、その技術を知りたい人に、当日スムーズに理解が進んだり、ハンズオンや授業の開催途中に見返すことができたり、後日確認して再度その技術に触れることができたりと良いつながりを生むことができます。

この記事では、私が 2023 年に行った授業やハンズオンを軸に、資料作成ツールの運用や実際の資料を振り返ります。

HonKit は便利に使っています

授業資料やハンズオン資料に使っている HonKit の設定メモ 2022 年 12 月版

授業資料やハンズオン資料に使っている HonKit の設定メモ 2022 年 12 月版こちらで以前もまとめた仕組みについては、私の色々な DevRel 活動で活用できています。

Microsoft Build Japan で AI ハンズオンの講師とサポートをしてきました

Markdown で書けて GitHub Pages で公開できます。GitHub のテンプレート機能を使っているので、環境もそろえやすく資料ページ構築までスムーズにできています。

とくに、Microsoft Build Japan で AI ハンズオンの講師とサポートでは、かなり似た流れのハンズオン資料を 2 つ作るときに、まずメインの資料を作って GitHub でフォークするような形で対応できました。

また、複数の人で資料を調整していくときにも、Git リポジトリでうまく対応できたところがよかったです。

その他にも、以下のような技術を伝える対応で活用することができました。

HonKit で作られる DevRel の資料の雰囲気をぜひ確認してみてください。

Zenn Book も良い

HonKit は引き続きお気に入りではあるのですが、並行して Zenn Book のほうも触っています。

Zenn は技術記事を書くツールとして有名ですが、オンラインの書籍を書くことができ、これがそのまま技術を伝えるためのハンズオン資料や授業にもうまく使えることに最近気づけました。

Zennで本を執筆する！Webからの本作成マニュアル

このように書籍に作り方も公式ドキュメントがわかりやすく、こちらで学びながら自分の Zenn 作業用のリポジトリをつくってコンテンツを同期させる仕組みが簡単に作れます。

つまり HonKit で行っている Git リポジトリからコンテンツを作成するような流れがこちらでもできますMarkdown も素直に書けるので HonKit で途中まで書いていたものを Zenn Book に移植するようなこともできちゃいます。
コンテンツの確認などで Zenn CLI をいれる必要はありますが、セットアップは HonKit と同じくらい。いや、すこし楽かなくらいで使いやすいです。

とくにチャプター機能が作りやすいところは好きで、こちらを組んでおけばこのようにキレイにレイアウトしてくれて、一気にしっかりした公開資料だぞ感をだしてくれるところはお気に入りです。

2023 年では Zenn Book を、このように授業資料で活用しました。

こちらも HonKit と同じく Zenn Book での授業資料の雰囲気を感じてみてください。

どちらの仕組みでも自分的に一番効果があるなと感じるところ、それは「初動」

こののように HonKit も Zenn Book はどちらも便利で、技術系のハンズオンや技術を伝える授業のような DevRel シーンで役立ちます。ですが、なにより「初動」に効果あるなと感じています。

というのも、ハンズオン資料も授業資料も、内容の目次や Markdown による文書構造といった最初の体裁づくりと、どこかに URL を決めて公開するところ。これがどちらも素早く行えるところが良いです。このスタートダッシュが早めに決めれると、イベントや授業の告知ページに素早く資料のお知らせができ、参加者への注目を集め、その技術を知ろうとする気持ちを高めることができます。

さらにいえば、ハンズオンや授業で大事なポイントとなる事前準備をお願いするページも、先ほど言ったようなページをまず公開するスタートダッシュの高揚感のまま用意することができているので、技術を伝える DevRel 活動において良い方向に働いています！