技術書典で本を出展するまでにやって良かったこと・やっておけば良かったこと
こんにちは、エンジニアの加藤(@tomo_k09)です。
少し前に開催された技術書典15で、『LINE botを題材にRustでのアプリケーション開発』という本をPharmaXエンジニアチームの有志メンバーで執筆し出展しました!!(パチパチ)
*電子版のみの販売です
技術書典で本を出展というのはPharmaXにとって初めての試みだったので、出展までの過程に反省点がたくさんありました。そこでこの記事では、今回の出展で出てきた反省点をふりかえろうと思います。
「これから技術書典で本を販売してみたい!」という方の参考になると思うので、ぜひ読んでみてください。
技術書典で出展する本の執筆をどのように進めたか
技術書典で本を出展するまではの流れは以下の通りです。9/28にキックオフミーティングを開き、執筆の完了が11/07だったので、コンセプト決めから1ヶ月ちょっとで完成させました。
<出展までの流れ>
1.サークル申し込みをする
2.本のコンセプトを決める
3.目次を決める
4.執筆スケジュールを引く
5.執筆環境を構築する
6.表紙を作成する
7.執筆をする
8.サンプルリポジトリの作成をする
9.社内レビューをする
10.審査に出す
1. サークル申し込みをする
最初にやることは技術書典の公式ページから参加申し込みをすることです。どのような本を執筆する予定なのかを記載した上で申し込みをします。
申し込みをすると審査に入ります。
無事に審査を通れば、技術書典で本を出展できるようになります。
2. 本のコンセプトを決める
サークル審査が通ってすぐにキックオフミーティングを開き、今回出展する本のコンセプトを決めました。
PharmaXの一部のサービスはRustで実装されており、これからさらにRustに力を入れていこうという段階です。そのため、今回はLINE botの開発を通してRustを学べるというテーマで本を書くことにしました。
3.目次を決める
本のコンセプトを決めたあとは、本の目次を決めました。
目次を整理した上で、この章は誰が書くかの担当決めもしました。
キックオフミーティングの時に考えた目次
4.執筆スケジュールを引く
次にやったのが執筆のスケージュールを引くことです。出展までに何をやらなければいけないか整理をした上で、ざっくり執筆スケジュールを引きました。
ここまでをキックオフミーティング時に行い、その後は週1回の進捗確認ミーティングで進捗を確認するようにしました。
5.執筆環境を構築する
技術書典で出展されている本の多くは、Re:VIEWという執筆ツールが使われているようです。そのため、私たちも先人たちの残した知見の恩恵を得られるようにRe:VIEWを使って執筆しました。
Re:VIEWにはいくつかテンプレートがあるのですが、技術サークルのTechboosterさんが公開しているRe:VIEWの執筆用テンプレートが良さそうだったので、それを使って執筆をしました。READMEがとても丁寧に書いてあるので、技術書を書いたことがない人でも使いやすいと思います。
6.表紙を作成する
今回は社内のデザイナーさんにお願いしました。表紙の解像度は1092 × 1542が良いとのことだったので、1092 × 1542で作成してもらいました。
7.執筆をする
執筆環境を作ったら、ひたすら執筆です。執筆期間は3週間ほどで、120ページ弱を4人のメンバーで書きました。
8.サンプルリポジトリの実装をする
今回出展した本は「LINE botの開発を通してRustを学ぶ」というコンセプトだったため、サンプルリポジトリもあったほうが良いという話になりました。そのため、執筆と並行してサンプルリポジトリの実装も行いました。
サンプルリポジトリはこちらです。興味のある方はぜひご覧ください。
9.社内レビューをする
執筆がひと段落した段階で社内のエンジニアメンバーにレビューをお願いしました。レビューをもらえたおかげで、より読みやすい本になったのではないかと思います。
10.審査に出す
レビューを終えたら、本を審査に出します。この審査を通ると販売ができるようになります。11/7の23時ごろに審査を出して、深夜2時くらいに承認をもらうことができました。
技術書典15のふりかえり
チームで技術書典で本を出展するにあたり、やっておいて良かったこと・やっておけば良かったことについて書きたいと思います。
やって良かったこと
▪️電子版のみで出展した
今回の技術書典はPharmaXにとって初めての参加でした。本の執筆だけでもかなり時間がかかる上、出展までの過程もよく分からず手間がかかることが想定されたので、紙の本での出展は次回以降の技術書典に持ち越しをするという意思決定を最初の段階でしました。
結果的に電子版だけでも準備が締め切りギリギリになってしまったので、紙の本は次回に持ち越して正解でした。次回は紙の本の出展もチャレンジしたいと思います。
▪️キックオフミーティングで執筆スケジュールを決めた
キックオフミーティングの段階で、本のコンセプトと目次を決めて、ざっくりとスケジュールまで引けたのは、本当にやっておいて良かったなと思いました。
というのも、ここが決まらないことには本の執筆作業に入れないからです。スケジュールがかなりギリギリでしたが、初日に重要なことを決め切ってしまうことによって、約1ヶ月を作業の時間に充てることができました。
▪️進捗確認のミーティングを週1で行った
このミーティングでは、執筆が遅れている章の担当の割り振りをやり直したり、残タスクの抜け漏れがないかの確認をしたりしました。
キックオフミーティング時に執筆スケジュールを引きましたが、最初の計画通りにはなかなかうまくいかないもので、軌道修正をする機会を定期的にちゃんと設けていたのは本当に正解でした。
やっておけば良かったこと
▪️スケジュールにもう少し余裕を持たせるべきだった
「技術書典当日に本を出展するには、本番3日前までに審査に出してください」というアナウンスが出ていたので、11/7の23:59までに本の審査に出す必要がありました。
しかし、今回は執筆がひと段落したのが11/6で、翌日にレビュー&修正をし、審査に出すという感じでかなりギリギリになってしまいました。
レビューをもらえる時間が1日しかないと、「誤字脱字があります」とか、「改行がないと読みにくいから改行しましょう」くらいのレビューを修正する時間しかありません。
理想は本番2週間前くらいには執筆が完了していて、レビュー&修正に1週間くらい使えるようなスケジュールかなと思います。
また本を出展する機会があれば、レビュー修正にもう少し時間を使えるようなスケジュール感で進められるようにしたいです。
▪️執筆環境の構築をもっと早く終わらせるべきだった
先述の通り、今回はRe:VIEWというツールを使って執筆しました。しかしこのRe:VIEWがなかなかの曲者で、慣れるとさくさく書けるのですが、慣れるまでに少し時間がかかります。
おまけに書いた本をPDFにして読んでみると、改行がうまくされていないなどの不具合がちょくちょく出てきて、それらの対応にも時間を要しました。
技術書典の執筆によく使われるツールではあるのですが、少しクセの強いツールなので、早めに執筆環境の構築を終わらせて、扱いに慣れておくことをおすすめします。
おわりに
今回は技術書典の執筆について書きました。
これから会社で出展したいと思っている方の参考になれば幸いです。
PharmaXでは、様々なバックグラウンドを持つエンジニアをお待ちしております。
もし興味をお持ちの場合は、私のXアカウント(@tomo_k09)までお気軽にメッセージをいただけますと幸いです。まずはカジュアルにお話しましょう!
PharmaXエンジニアチームのテックブログです。エンジニアメンバーが、PharmaXの事業を通じて得た技術的な知見や、チームマネジメントについての知見を共有します。 PharmaXエンジニアチームやメンバーの雰囲気が分かるような記事は、note(note.com/pharmax)もご覧ください。
Discussion