技術書
コミュニケーション

4人のエンジニアで技術書を共同執筆した話

コミュニケーション Advent Calendar 2017の21日目担当の @henteko です。

このエントリでは今年の年末にある冬コミ(C93)にて頒布予定の技術書を4人のエンジニア1で共同執筆した際のことを書いています。

4人のエンジニアで共同で技術書を書くには色々とコミュニケーションを取る必要がありますし、プロジェクト管理をする必要があります。
その際の進め方などを紹介したいと思います。

使用したツールなど

今回使用したツールは以下のものです。

  • Slack
  • GitHub
  • Re:VIEW

Slackで一般的なコミュニケーションを取りながら、GitHubで原稿を管理し、Re:VIEWでPDFを生成するという今技術系同人誌を作る上では一般的な構成だと思います。

大まかなスケジュールの決定

まずは冬コミに向けて大まかなスケジュールを設定しました。
冬コミの当落が出る前にスケジュールを決めて、余裕の入稿をしようと計画を立てました。
ざっくりこのような感じです。

  • 11/4: C93当落発表
  • 11/15: 原稿締め切り
  • 11/29: 印刷所入稿
  • 12/29: C93当日

このスケジュールをGitHubで作成したレポジトリのREADMEに書いてみんなに共有をしました。
かなり前からこのスケジュールを共有しておいたおかげ + みんなの頑張りで、少しの遅延はありましたが大体スケジュール通りに順調だったと思います。

プルリクによるレビュー

原稿のレビューにはGitHubのプルリクエストを使いました。
今回の技術書では1人1部づつ担当し、計4部構成の技術書を作ることにしていました。
ですので各担当箇所の差分をプルリクとして作り、そこに他の人がコメントを書いたりしながらレビューをしました。

スクリーンショット 2017-12-20 0.47.08.png

全員仕事やプライベートでGitHubを使っているので操作も慣れておりストレスなく作業が出来たと思います。

また、原稿を進めていく上である程度まとまってきたら、Re:VIEWでPDFにしそれをGitHubのリリースに添付して共有していました。

スクリーンショット 2017-12-20 1.15.20.png

これを行なっていた理由として、本としての完成形が全員イメージしやすいようにするためです。
今回参加した4人のエンジニアのうち2人は同人誌初執筆でした。
その為完成形がイメージしにくいだろうと考え早めにPDFを作成して共有するようにしました。

現実世界でのレビュー会

第1回目の締め切り(11/15)が過ぎたあと、出来上がった原稿をRe:VIEWでPDFに変換し印刷したものを持ち寄って現実世界で対面でのレビュー会を4人で行いました。
このレビュー会では全員が自分以外の原稿3人分を読んで、気になったところを直接紙に赤ペンを入れていきました。

このレビュー会で大体の原稿の修正点が洗い出され、各人が修正をして原稿が完成しました。

ちなみにこの会ではお菓子や紅茶、ケーキなどの持ち込みがなされて完全に女子会の様相を呈していました。楽しかったです。

原稿の最終調整

ここからは最終調整です。
原稿は粗方出来ましたが、それをRe:VIEWを使ってPDFにして印刷所に入稿できる形にまとめないといけません。
具体的に最低限やらなければならないことが以下のことです。

  • ページ数を4の倍数に調整する
  • 本文中の画像などの大きさを調整する

特にページ数を4の倍数に調整するのは、1番最後の工程になってしまいます。
ここでスケジュールを余裕を持って組んでいて本当によかったと思いました。
何事もバッファを読む必要がありますね。

この最終調整は基本的に自分が担当しました。
各人の原稿を微修正してプルリクを作成し、担当箇所の人に確認をもらって進めていきました。

原稿の完成

最終調整が全て終わったら原稿の完成です。
最終的に全部の原稿が終わったのは12/3でした。
事前のスケジュールよりも遅れてしまいましたが、許容範囲内でしたのでよかったです。

表紙の作成

本は原稿を書いておしまいではありません。
本の顔である表紙を作成しないといけません。

今回は自分が全て担当しAdobe Photoshop CCを使って以下の表紙を作成しました。

作成中も頻繁に他の3人のメンバーにデザインを確認してもらいながら進めていきました。
デザインの確認などではSlackを使って意見を聞いていました。

技術書の完成!

表紙が完成したら技術書の完成です!
印刷所に規定のフォーマットで入稿しました。

かなりスケジュールに余裕を持って入稿できた為、冬コミまでまだ1週間以上時間がありますが既に本が印刷所から届きました。

今回4人でそれぞれ30ページを超える分量を書いた為、ページ数が132ページになりました。かなり分厚いです。全然薄い本じゃありません。

4人で一緒に作り上げた技術書なので思い出深いものができたと思います。

さいごに

4人のエンジニアで技術書を共同執筆した話を書きました。
技術書を書くのは大変ですがとても楽しいです。
みなさんも味噌煮研究所で一緒に技術書を書いてみませんか?

冬コミ1日目に行く予定の人は是非「東キ24a 味噌煮研究所」をよろしくお願いします!!!!