『いちばんやさしいGit&GitHubの教本』執筆開始から終了までのできごと

共著で出させていただいたいちばんやさしいGit&GitHubの教本 人気講師が教えるバージョン管理&共有入門 (「いちばんやさしい教本」シリーズ)について、「執筆作業」って実際のところどんな感じなの?といった内容を、実体験とともに記録します。

昨年の終わりに書いた、執筆を進めるための自己管理に関するエントリもありまーす。
ihcomega.hatenadiary.com
本については、多分もう1エントリくらい書きます。内容にフォーカスしたやつ。

📕執筆のきっかけ

jjug.doorkeeper.jp

もう3年前になりますが、共著者のしょぼちむさん(@syobochim)とJJUGナイトセミナーでGitの入門セッションをやったことがあります。これを知った編集担当のリブロワークス大津さんより、JJUG宛に執筆のご依頼をいただいたのがスタートでした。2018年の1月終わり頃です。

声をかけてくださった大津さん、きっかけをくださったJJUGにはとても感謝しています。

📕協力者探し

実際の作業を開始する前に、共著者、そしてレビュアーという2大協力者を見つける必要がありました。

とてもありがたいことに、相談したらすぐにOKをくれたしょぼちむさんが共著者となり、レビュアーは昔からとってもお世話になっているうらがみさん(@backpaper0)といろふさん(@irof)が引き受けてくださることになりました。

f:id:ihcomega:20190107001733p:plain:w550
共著者探しのようす

📕構成の検討

3月の終わり頃、まずは章立てを考えるべく、しょぼちむさんと案を持ち寄り相談会をしました。ちなみに、対面で打ち合わせしたのはこれ含め2回のみ(いずれも執筆開始前)で、それ以降はすべてオンラインでのコミュニケーションでした。

あまり意見が割れることもなく、書く内容についてはスムーズに合意がとれた印象です。悩んだのは、概念の説明を先にするか、いきなり手を動かすハンズオンから始めるかといったことくらいでしょうか。なお結局、

  1. 理解しないままとりあえず触ってみる
  2. 何が起きているかよく分からないが一応バージョン管理らしいことはできる
  3. 雰囲気で使い続ける
  4. 意図しない挙動に出くわしたときに一気に詰む

という自らの経験に基づき、読者には同じ経験をしてほしくない思いから前者を取りました。

f:id:ihcomega:20190107004031p:plain:w300
いちばんはじめの構成案

📕執筆開始

さて、構成案を提出し、5月頃から試しに第1章「Gitとは何か」を書き始めました。試しと言ったのは、

  • 執筆用ツール(後述)の使い方を確認する
  • 文体や内容などの方向性を確認する

といった意味合いの作業だったためです。

しかし…書き始めが5月とは…。打ち合わせが3月、しかも意見が割れずスムーズに進んだと書いておきながら1ヶ月空白期間があることが驚きですよね。そう、我々なかなか進めなかったのです。(これは私個人の話ですが、)「何から始めたらいいんだ」「やらなきゃいけないけど不安だけを募らせ進捗はない」といった状態が続いてしまったように思います。

そんなとき、うらがみさんが状況の確認やリマインドもしてくださったのに助けられました。申し訳なさと感謝でいっぱいです。はじめに紹介したエントリ(FOLIOで学んだマネジメントやリーン開発の知識を本の執筆に活かす - よこなのへたのよこずき)のような工夫も、この時期の遅れがきっかけだったりもします。ぴ、PDCA…。

✏執筆用ツール

「いちばんやさしい教本」シリーズの執筆には、強力なツールが用意されています。先程もご紹介した編集担当の大津さんが作ったatomプラグインで、これがあれば書きながら完成イメージを確認することができます。

見たほうが早いので見せます!

f:id:ihcomega:20190107005836p:plain
「いちやさシリーズ」の執筆を支えるatomプラグイン

すごいですよね。左側が原稿です。マークダウンをベースに、独自の記法も用いて書けば、右側のようなプレビューをリアルタイムに確認しながら執筆作業ができるのです。

  • ほぼマークダウンなので楽に書けるしバージョン管理もしやすい
  • 章の分量を適切に調節しやすい
  • レイアウトに関する編集担当の方とのコミュニケーションがスムーズにできる
  • 完成イメージが見えるためモチベーションがアップする

などメリットがたくさんで、とてもありがたいツールでした(以下、リンクです)。

atom.io

atom.io

📕執筆作業の本格化

試しに書いた第1章がapproveされ、構成案に従ってひたすら書くフェーズに入りました。もちろん、構成案は何度も見直しながら、10月頃まで作業が続きます。

f:id:ihcomega:20190108215020p:plain
出版までの作業一覧

編集担当の方と原稿をやりとりした回数を図示してみました。DTP (参考: DTP - Wikipedia) をはじめ専門用語もありますが、要は編集担当の方と著者とで交互に内容を見直し、修正とレビューを繰り返す作業をしていたということです。

✏レビュー

f:id:ihcomega:20190107012415p:plain:w300
自分が出したPRは57件、コメントもたくさん

レビュアーのうらがみさん・いろふさんには感謝してもしきれません。特に、

  • 技術的な正しさや分かりやすさ: 入門書ということもあり、両者のバランスが非常に重要だった
  • 現場で使える情報: 様々な使い方ができるGitの、何を伝えれば現場で役立つ知識となるか考え続ける必要があった

を追求する上で、お2人のアドバイスは不可欠でした。様子を少しお見せします。

正確性のチェックや・・・

f:id:ihcomega:20190107013853p:plain:w400

分かりやすさに関するアドバイスや・・・

f:id:ihcomega:20190107014040p:plain:w400

使い方議論や・・・

f:id:ihcomega:20190107014107p:plain:w400

f:id:ihcomega:20190107014118p:plain:w400

そして嬉しいコメントも!

f:id:ihcomega:20190107014138p:plain:w400

マージまで見届けてくださって、こういうリアクションつけてくださってたのも全部励みになっていました。

f:id:ihcomega:20190107014215p:plain:w400

このレビューの内容こそ、GitHub入門者に見てほしい学び多きものですね。お2人とも、本当にありがとうございました!

f:id:ihcomega:20190108222752j:plain:w300
ささやかなお礼として、お2人には本書に登場していただいた

スクリーンショットの工夫

入門書ということもあり、スクリーンショットはそりゃもう大量に撮りました。そんな中、しょぼちむさんとそれぞれ別のマシンで作業していたため、環境の差異をなるべく小さくする必要がありました。撮る範囲やフォントサイズなどをはじめ、しょぼちむさんにヒアリングして気合で揃えた部分もあるし、ちょっぴり工夫したところもあるのでそれを書いておきます。何かというと、ターミナルのプロンプトの表示をしょぼちむさんマシンに合わせる方法です。

f:id:ihcomega:20190108231421p:plain
しょぼちむさんと統一されたプロンプト

こんな感じです。当たり前のことながらPC名が異なったので、PS1を編集することで実現しました。このおかげで、 ichiyasa という本に登場するユーザーを作る必要もなく、ほんのちょっとだけ楽できた気がします。

export PS1="\[\033]0;$TITLEPREFIX:${PWD//[^[:ascii:]]/?}\007\]\n\[\033[32m\]ichiyasa@DESKTOP-LHHCMC7 \[\033[35m\]$MSYSTEM \[\033[33m\]\w\[\033[36m\] \`__git_ps1\`\[\033[0m\]\n$"

📕編集チェック

初稿が書き上がったら、大津さんによる編集作業が始まります。構成や表現の改善、分量の調整などをとても丁寧に行っていただき、また、未経験者がつまずきそうなポイントの補足依頼や質問も投げかけていただきました。初心者向けで書いたつもりでも、親切さが足りない部分が多々あるなぁと痛感する日々でした。特に、「なぜそうするのか」「どうしてこうなるのか」といったwhyに関する質問はとても勉強になったポイントです。

f:id:ihcomega:20190108221825p:plain
リモートリポジトリの情報はなぜ2行表示される?

例えばこのようなご質問。 git remote -v って同じような結果が2行表示されるんですよね。でも、私の目にはこれまで1行にしか見えていなかったと言っていいほどで、それがなぜなのかとか、各行の意味の違いとか、今回の執筆で初めて意識しました。大津さんからはこうしたコメントをたくさんいただき、知らなかったことの学習もできました。

何度も何度もレビューを繰り返しよい内容にしてくださったこと、心より感謝しております。

📕刊行

11月後半にすべての工程が終了しました。 進捗の遅れがあったり、すごい量の修正に圧倒されたり、いろいろなことを乗り越えてなんとか出版することができました。月並みですが、物理本を初めて受け取ったときはとても嬉しかったですね。我が子…。

同僚や友人に献本もして、フィードバックを貰えているのがとてもありがたいです。ブログを書いてくださるみなさまも、本当にありがとうございます。

📕写真撮影

最後に、脱力しそうな話題を。表紙のイラストについても少し書いておきます。

いちばんやさしいGit&GitHubの教本 人気講師が教えるバージョン管理&共有入門 (「いちばんやさしい教本」シリーズ)

「いちやさ教本」シリーズは、イラストレーターさんによるとってもリアルな似顔絵がいたる所に載ります。元となる写真はプロのカメラマンによるもので、インプレスさんのスタジオで撮影しました。表紙用と中身用4種類と、結構な時間をかけて撮っていただき、これも貴重な経験でした。他の著者の方はガッツポーズやイイネポーズくらいにとどめている励ましポーズが、自分の場合 :ok_woman: 風になっているのがイチオシ(?)です。オリジナリティを出していいとカメラマンの方がおっしゃっていたので、勝手にやりました。

f:id:ihcomega:20190108222857j:plain:w200
:ok_yokona:

ちなみに、自分は無言での撮影だったにもかかわらず、しょぼちむさんは写真撮影のときカメラマンの方に「Gitがんばろう!」「よくできました!」とか言わされていてとても謎でした(面白かった)。

まわりの方にただただ感謝

そんなこんなで出版にこぎつけることができたのも、出版後に嬉しい反応をいただけているのも、多くの方の協力あってのことです。みなさまにはただひたすらに感謝が尽きません!!
ありがとうございました😊そして引き続き『いちばんやさしいGit&GitHubの教本』をよろしくおねがいします😊