てくなべ (tekunabe)

ansible / network / automation / StackStorm

Software Design 2018年12月号の Ansible 特集に寄稿しました(ウラ話など)

gihyo.jp

はじめに

Software Design 2018年12月号の Ansible 特集の中の「第3章:Ansibleでネットワーク作業も自動化」という章を寄稿させていただきました。個人的には貴重な経験だったので、経緯や気づきなどを書きたいと思います。

f:id:akira6592:20181116160011j:plain:w300


きっかけは継続したアウトプットから

もともとは、技術評論社さんとレッドハットさんの間で、企画がうまれました。

そこから、Ansible ユーザー会というコミュティで開催しているイベントへの参加や登壇、Ansible 関連のブログ投稿などをしていた私に「ネットワークの章を書いてみないか」とお声がけいただきました。

紙の媒体へのアウトプットは自信が無かったのですが、せっかくありがたく頂いた機会だったので、やってみようと思いました。


過去資料をベースにネタ検討

Ansible とネットワーク組み合わせの資料はいくつか作ってので、それらを参考にして内容を構成しようと考えました。

ベースとなるネタはあったとしても、どのような読者を想定するか、何ページ設けられるかなどの要素を考ええると、アウトラインを決めるまで検討することは少なくなかったです。

結果としては、シンプルな内容するため以下の内容に絞りました。

  • 概要
  • 情報取得サンプル(show コマンドの結果出力)
  • 設定変更サンプル(SNMPコミュニティ名の設定)

Playbook で指定するコマンドは、あえてすべてべた書きにしました。 テンプレートや変数を利用してもよかったのですが、なるべく簡単にしようと思って避けました。

自分の中で、記事の設計のようなものができるのは時間がかかってしまいましたが、そこからは意外と順調でした。(ただし、書きすぎ。後述)


文章の書き方に四苦八苦、ツールの力もお借りして

そもそも、文章を書くのが得意ではなく、このブログも文章を書く練習を兼ねて書いています。 そのため、正しい日本語書くための資料をいくつか読みました。とくに以下の点に気を付けました。

  • 文章は短く
    • 長くしない。適度に区切って、必要に応じて接続詞を挟む。
  • 主語と述語は合わせる
    • 主語と述語がねじれてしまわないようにする。
  • 「~することができる」は「~できる」にする
    • 不思議なクセでよく書いてしまうが、多くの場合は短くできる
  • 印刷してチェックする
    • ディスプレイでいくらチェックしても気づけないミスに気付ける

初期段階の原稿は、Visual Studio Codeテキスト校正くん という拡張を利用してチェックしながら書きました。自分の悪いクセを指摘してくれる先生のような存在で、非常に助かりました。

また、スライド資料であれば箇条書きと口頭で説明できる内容でも、いざ文章にしようとすると、文章の組み立て方に迷って苦戦しました。


後輩にレビューを依頼

原稿がある程度できたところで、後輩のネットワークエンジニアにレビューをお願いしました。分かりにくかった箇所などを指摘してもらい、修正しました。迷いながら書いた箇所が思いっきりバレました。


ブログとも専門書籍とも違う

やはり、ブログを書くのと違って、気軽に修正できないという点で、気を使う場面が多くありました。 原稿のボリュームのコントロールも難しかったです。当初、張り切って書いたら長すぎてしまいました。。どこをどう削るかは悩みました。紙媒体固有の難しさを感じました。

また、雑誌の中のひとつの特集ですから Ansible 専門書と違って、読者は Ansible 目的で読んでいるとは限りません。その中でちょっとでも興味を持ってもらうためには、淡々と紹介するのではなく、見出し、とくに導入部分に気を遣いました。


おわりに

中島さん(@irix_jp)、齊藤さん(@saito_hideki)というスーパーなエンジニアのみなさんと一緒に特集を作り上げることができて、とてもうれしかったです。

また、技術評論社Software Designご担当のみなさんにもお世話になりました。 gihyo.jp

編集さんもデザイナーさんもみなさんプロフェッショナルですね!

特集全体としては、入門、ネットワーク、GUIツールのAWX、CIの組み立て方などをカバーしてます。Ansible を始めたり、もっと知るきっかけになったら、とてもうれしいです。

今回は機会をいただきありがとうございました!




おまけ:リンク集

記事中に登場するリンクを以下に掲載します。