タケハタのブログ

プログラマの生き方、働き方、技術について雑多に書いていくブログです。

Software Designでの短期連載執筆で学んだこと

開始時にも記事を書きましたが、

blog.takehata-engineer.com

Software Design 2019年2月号〜4月号で書かせていただいていた短期連載、「サーバサイド開発の品質を向上させるJava→Kotlin移行のススメ」が終了しました!
最終回の号の販売期間も終わったので、この中で得られた学びを簡単に振り返ってみようと思います。

連載の中で学んだこと

読みたくなる文章の書き方

原稿を書いて校正していただいている中で、「こう書いた方が読みたくなる」という書き方を色々と教えていただきました。

見出しの文言を具体的に書く

例えばKotlinのNull安全についての項目を書くとしてます。
そこで普通に書くと

## Null安全
KotlinにはNull安全という機能があって・・・

みたいに書きたくなってしまうんですが、

## Null安全でNullPointerExceptionの発生を軽減できる
KotlinにはNull安全という機能があって・・・

と見出しでNull安全のメリットまで具体的に書くことで、その内容を「お、読んでみよう」となるということです。
これはブログの書き方のコツなんかでもよく紹介されているテクニックですが、いざ自分で書いているとできていないことも未だに多いので、改めて意識するようになりました。

手順や事象だけでなくメリットや注意点も書く

第2回の記事を書いている時のことなのですが、SpringをKotlinで使ってJavaと同じように実装できることを紹介していたこともあり、「Kotlinでも同じようにできます」といった書き方になっている部分が多くありました。
しかし、この連載のタイトルには「Java→Kotlin移行のススメ」と入っているため、「移行しよう」と思える書き方をしないといけません。

「同じようにできる」だけでは「JavaではなくKotlinを使おう」考える強い動機にはならないため、もっとこれをやる上でのメリットや注意点を書くとなりました。
なので「○○できます」だけでなく、「○○できて、△△というメリットがあります」や「××には気を付けてください」といったメリットや注意点などのポイントを書くことが大事だと学びました。

紙媒体の記事を書くことの難しさ

今まで会社、個人でブログは色々書いてきましたが、紙媒体の雑誌の記事となると、また別の難しさがありました。

ページ数の制限がある

一番はなんといってもページ数。
雑誌内でこの記事に割り当てられているページ数は決まっているため、文量がオーバーしたら減らさないといけないですし、中途半端な量になると最後のページに隙間ができてしまったりするため、決まったページ数ぴったりに収まるように調整が必要になります。

さらにソースコードの差し込みも様々な形で入れられるので、実際にデザインに当て込んでもらわないと自分でも最終的なボリューム感が分からないのも難しいところでした。
それゆえ配置で調整してもらえて思ったより収まったこともありましたが笑

基本僕は多めに書いてしまっていたので、やり取りを繰り返しながら、「この項目はいらないかな」とか「この一文はなくても伝わるか」みたいな部分を削っていっていきました。

もしこういう流れでやるのであれば、「絶対削る箇所」「足りなかったら削る箇所」とか優先度を付けていくつか洗い出しておくのが良いのかなと思いました。
(削ることで他の分の修正が必要になる場合は難しいですが)

リリース後に修正することができない緊張感

ブログの記事を書く時などもちゃんとチェックはしますが、少しくらいの誤字であれば後からオンラインアップデートで修正できるという逃げ道があります。
しかし、紙媒体の雑誌は発売されたら最後、もし間違っていたら直すことはできず、正誤表などを別途出してもらう必要があります。

もちろん今までWeb媒体で書く時もチェックに手を抜いたことはありませんが、この「直すことができない」ことはかなりプレッシャーでした。
誤字脱字を直すのは前提として、「この言い方微妙かも・・・」とか「これ本当に意味合ってるんだっけ?」みたいに気になる箇所もいっぱい出てきて、全部整備するのはなかなか大変でしたね。

Kotlinをより深く知り、改めて良さを知れた

今までKotlinのことはブログ記事や登壇で何度も発表してきましたが、今回短期連載という形で3回に渡って書くに当たって基本的な部分から順番に書いてみたことで、改めて良さを知ることができました。

あと前述のように「これ本当に意味合ってるんだっけ?」という部分を細かいところまで確認するので、より深く知ることもできました。
今までエンジニアをやってきて、一つのプログラミング言語についてこんなにしっかりと調べたのは初めてです笑

アウトプットをすることでより知識が定着するというのはよく言われることですが、有名雑誌への寄稿という普通よりプレッシャーのかかる形でやったことで、より大きな効果が得られたのだと思います。

短期連載を終えての感想

ここまで書いてきたことがほぼ全てですが、総じて学びの多い、楽しい短期連載でした!
ここ最近はアウトプットを意識して色々やってきましたが、その中でも特に印象深い活動の一つになったと思います。

また、誌面の最後に載っている読者の方からの感想や、Twitterで興味を持ってくださっている方の投稿を見て、何度も嬉しくなりました。
これをきっかけにTwitterで質問してきてくださる方もいて、本当に書いて良かったです。

今後もまた機会があれば、こういった執筆活動をしてみたいと思っています。