読者です 読者をやめる 読者になる 読者になる

オルトプラスエンジニアの日常をお伝えします!

ブロックチェーン記事の執筆について

みなさんこんにちは。オルトプラスラボの竹田(id:mitsutaka-takeda)です。

今回、技術評論社が出版しているSoftware Designにブロックチェーンの記事を書く機会を頂いたので、その時の経験を書こうと思います。

ブロックチェーンってなに?

ぜひ、Software Design 2017年5月号をご購入して、「いまから学ぶブロックチェーンのしくみ」をご覧ください。まだブロックチェーンに触れたことがない方向けの内容になっております。ブロックチェーンに関する重要なコンセプト、技術的な概要、応用面が書かれた記事です。

http://gihyo.jp/magazine/SD/archive/2017/201705

執筆の流れ

執筆が決まったのは2月頭ぐらいでした。そして2月末には目次を提示して3月の中頃に原稿の提出。その後2週間ほどかけて原稿の訂正を行いました。

今回の記事では、弊社嶋田(id:cimadai)と2人での共同執筆でした。章ごとに分担を決め、各自担当の章を書き、お互いにレビューを行うという形で作業を進めていきました。

執筆作業について

今回の記事では、1ページ1000文字で10ページ、約1万文字を目安に執筆を行いました。私は雑誌記事への投稿は初めてで、執筆がどのくらいの大変さになるか想像できませんでした。共同執筆者の嶋田は過去に技術書を執筆した経験があり、彼から「大変だよ」と聞いていたので、書き始める前はかなり不安でした。実際は、1度書き始めると逆に文量が想定より多すぎて最終的には削ることになりました。2人で10000文字という少なめのボリュームのおかげかもしれません。

執筆を行う上で気を付けたことは、なるべく読者に前提知識を要求しないことです。普段の開発チームでのコミュニケーションでは、同じ知識を共有しているものとして専門用語でも何気なく使ってしまいます。導入向けの記事では、何気ない専門用語でも(全体から見れば重要ではない用語であっても)、理解の妨げになる可能性があります。専門用語を多用しない、または、使用する専門用語は初出時に適切な説明を付けるようにしました。難しかったのは何を専門知識や用語とするかです。1度知ってしまうと何が難しくて理解しづらかったのか忘れてしまい、自分たちだけでレビューしてもなかなか理解しづらいことに気づけません。今回はブロックチェーンに関しては聞いたことがあるが中身は知らないエンジニアの方にレビューをお願いしました。

共同執筆について。技術書執筆の経験者がおり、執筆作業の流れについて知っていたため、スムーズに作業を進めることが出来ました。原稿の共有、バージョン管理はgitです。構成や書くことに詰まった時、相談できる相手がいるのは心強かったです。

最後に

今回は2か月ほどで10ページという余裕のある(?)スケジュールでしたが、連載を持たれてるエンジニアの方は、どのように連載をこなしているのか頭が下がる思いです。

共同執筆は執筆の敷居を下げてくれる大きな要因でした。書く機会はあるけど1人ではなかなか始めることができないという方は共同執筆できそうな人を探してみるのはいかがでしょうか。

Software Designの記事を通じて、ブロックチェーンについてより多くのエンジニアに興味を持ってもらえることを願っています。