Home TEC-J 技術解説文書を、いかにわかりやすく書き、出版するか ~執筆道場WGの実践トレーニング法|TEC-J発 最新テクノロジー研究

技術解説文書を、いかにわかりやすく書き、出版するか ~執筆道場WGの実践トレーニング法|TEC-J発 最新テクノロジー研究

by kusui

TEC-Jのワーキング・グループの1つである「執筆道場WG」では、技術者が技術解説文書をいかに執筆し、出版するか、について実践的なトレーニングを行っている。技術を知らない人に技術をわかりやすく解説するには、いくつかのポイントがある。活動成果として、外部メディアへの寄稿や書籍出版も達成済みという。

 

◎著者

花井 志生

日本アイ・ビー・エム株式会社
クラウド・ビジネス・コンサルティング
第一クラウド・アドバイザリー
IBM認定上級ITスペシャリスト

・・・・・・・・

山﨑まゆみ

日本アイ・ビー・エム株式会社
クラウド・アプリケーション・サービスマルチクラウド・アプリケーション
シニアITスペシャリスト

・・・・・・・・

谷口 督

日本アイ・ビー・エム株式会社
クラウド・マイグレーション・サービス
パブリック・クラウド・サービス

・・・・・・・・

 

非専門家の視点の重要性

 筆者(花井)は、以前から縁があって技術文書の執筆を行ってきたが、「自分で書くだけでなく、ほかの社員にもそのスキルを広めるように」と言われたのをきっかけに、“執筆道場”を2011年に開始した。

 これは日本IBM社内の「ITLMC」(*1)と呼ばれる活動の1つで、特定のテーマに興味をもつメンバーが集まり、約半年間で成果をまとめて発表するという内容で、毎年1回開催されている。TEC-Jほどは内容の深さが求められず、また短期間に集中して活動するため「中だるみ」が起きにくい点が評価され、ボランタリ活動であるにもかかわらず、年々参加メンバーが増えている。

・・・・・・・・

(*1) IBM Technical Leadership Master Courseの略

・・・・・・・・

 執筆道場は2016年からTEC-Jのワーキング・グループ(以下、WG)としても活動を開始した。これは、上位組織であるIBM Academy(*2)が「外部発信」を方針として推奨するようになったことが1つの要因である。

・・・・・・・・

(*2)http://bit.ly/is14_tecj001

・・・・・・・・

 

 執筆道場WGは、何らかの有用な知見の獲得を目的としている他のWGとは活動内容が異なる。執筆道場WGでは、TEC-Jメンバーからの執筆の相談に応じ、出版にこぎ着けた場合は社内で宣伝活動を行う。

 TEC-Jメンバーにはその見返りとして、自著の著者紹介欄にTEC-JとIBM Academyのロゴを掲載して宣伝してもらうことにしている。

 2011年から5年間、この活動を通して実感したことは、非専門家の視点の重要性である。ITLMCの参加メンバーはさまざまな部署から集まるので、自分が執筆した内容の読み手は専門家ではない人が多い。そういう人たちによる「ここがわかりにくい」という率直な意見は貴重である。なぜなら、ふだん自分の周りにいる人々は、多かれ少なかれ自分と似た専門領域をもっていて、「わからない人の視点」が欠如していることが多いからだ。

 さて前置きはこのくらいにして、実際の活動内容について紹介していきたい。【以上、花井執筆】

 

執筆道場WGの活動内容

 ここからは執筆道場の活動内容を詳しく紹介する。

 執筆道場は、「ITに関わる技術解説文書を執筆して、書籍や雑誌として出版してみたい」という夢や目標に向かってチャレンジする活動だ。周りが専門家ばかりだと、ある技術について、知らない人に説明することが下手になってしまう。わかりやすく説明しなくても理解してもらえるので、わかりやすく説明する訓練が不足しがちである。この訓練を、夢や目標をもって主体的に行うことをサポートする活動である。また、出版へのハードルが高そうに思えて1人では足踏みしてしまうメンバーへ、経験者がアドバイスし、ハードルを越えるための後押しをする活動でもある。

 

◆ 対象とする技術解説文書の定義

 当活動で対象としている技術解説文書とは、次のような文書を指す。

 

・ 一般に知られていないトピックを知らない人に解説する文書

・ 技術的に難しい内容を平易に解説する文書

・ 解説対象とする分野は、ITに関することなら何でもOK(ITの基礎、プログラミング、インフラ構築、ネットワーク、アーキテクチャ解説など)

 

 以下の文書は対象としていない。

・ 技術論文(読み手もプロ)

・ 小説(解説文書ではない)

・ IT機器や家電などの製品レビュー(技術解説ではない)

 

◆ 参加メンバー

 活動には、事業部や部門、得意分野が異なるさまざまなメンバーが参加する。その年によってメンバー数は異なるが、経験上は10名前後が効率よく、効果的だ。参加メンバーおのおのが執筆訓練を行うので、リーダーやアドバイザーがメンバーを十分に支援できる人数であることが重要である。また、執筆した文書をメンバー相互にレビューするので、その分量がWGのキャパシティを超えない程度にとどめたい。

 

◆ 活動スケジュール

 年間スケジュールは、おおむね以下のとおりである。

 

・ リーダー(前年のリーダーが指名)が、3月にITLMC事務局へWG活動申請をする

・ 4月にITLMC事務局がWGメンバーを募集する

・ リーダーは活動計画を作成し、WGメンバーを集めてキックオフミーティングを開催する

・ 執筆活動を行う(メンバーの要望により個人執筆、グループ執筆を行う)

・ 計画に従って活動する(活動スケジュールの例は図表1参照。執筆スケジュールは個人執筆時の例)

・ 11月にITLMC成果発表を行う

・ 12月に活動実績を報告し、当年のWG活動を終了する

 

 

 なお、活動の性格上、執筆テーマや出版媒体によって完成時期が異なるため、実際にはITLMCの期間が終わっても執筆を継続し、さらには翌年の活動へ持ち越す場合も多い。ITLMCの終盤である11月には、ポスターセッションなどの発表の場があるので、活動としては区切りを設け、執筆成果物以外でも、出版に向けて調査した内容などの成果を発表できるように工夫している。

 

◆ 活動内容の詳細

 スケジュールで示した活動内容のうち、とくに執筆・出版活動の詳細を図表2に示す。構想策定から執筆まで、メンバー間で相互レビューを行いながら、技術解説文書を作成していく。通常は社内のSNSサービス(「IBM Connections」のフォーラム機能など)を用いて情報交換をするが、月に1回程度ミーティングを開催し、進行状況に合わせてメンバーが知っておくべきトピックを学習したり、メンバーの要望に沿ったトピックを話し合ったりする。ミーティングは電話やWeb会議も併用し、IBM箱崎事業所に来るのが困難なメンバーともコミュニケーションが図れるようにしている。

 

 

 

◆ 当活動のノウハウ

 当活動で蓄積したノウハウについて、5つのポイントを以下に紹介したい。

(1)構想策定シート

 構想策定シートは、執筆の前に検討・整理しておくべき項目をあらかじめ記したテンプレートである。出版社への原稿持ち込み時には、簡単な企画書として利用できる。初心者にとって、いきなり文書を書き始めるのは難しいものだ。構想策定シートを埋めていくことで、書きたいことが整理できる。また、文書を執筆しているうちに書くべきことを見失ってしまうのを予防できる。

(2)執筆テーマとして狙うべき領域

 BCG(Boston Consulting Group)マトリクスは、もともと市場の成長率、市場の占有率を2軸にして、自社製品の強み・弱みを客観的に分析するものだが、市場の成長率を「テーマの先進性」、市場の占有率を「読者の多さ」と見立てることで、執筆テーマのポートフォリオを分析できる(図表3)

 

(3)最新技術に関する執筆時の注意点

 プロダクトの進化スピードが速いため、バージョンの違いにより見栄えや動作が変わる場合がある。プログラムだと、最悪のケースでは作動しないこともあるので執筆中もバージョンアップに追従する必要がある。紙の書籍だと、執筆を始めてから読者の目に触れるまでに時間がかかり発行時には陳腐化しかねないし、改訂も容易ではないので、電子書籍やWeb記事のように、サッと公開・更新できる媒体を選ぶのがよいだろう。

(4)レビュワーの心構え

 WG内では、よくない点だけを指摘せずによい点をほめること、人格批判にならないように注意して、あくまでも内容に関してコメントすることをレビュワーの心構えとして取り決めた。

(5)電子書籍作成時の注意点

 文章や図表の執筆が完了したあとも、epubなどのフォーマットに変換したり、チェックする作業を見込んでおく必要がある。出版社に頼らず自前で出版するなら表紙も自分で用意する必要があるし、フォーマット変換したあとで複数のデバイス(たとえば、iPad、Kindle Paperwhite、PCなど)で表示を確認すべきだ。【以上、山﨑執筆】

 

 

執筆道場WGの活動成果

 

◆ 出版・公開実績

 ここからは活動実績について見ていきたい。この6年間、参加メンバーは毎年1件の技術解説文書を執筆してきた。そしてその出版を目指してきたが、媒体への掲載は各自の希望で決めているのでさまざまである。紙媒体の書籍や雑誌もあれば、電子書籍やWeb記事のような電子媒体もある。

 紙媒体では、2015年の活動のなかから「40歳から始める、オレとRubyプログラミング」の連載がUPS研究所の『月刊シェルスクリプトマガジン』で始まった(*3)。一般書籍としては2013年にアスキー・メディアワークスから『モダンC言語プログラミング』が出版されている(*4)

・・・・・・・・

(*3)http://bit.ly/is14_tecj003

(*4)http://bit.ly/is14_tecj004

・・・・・・・・

 一方、電子媒体では、2015年の活動から翔泳社のWebマガジン「CodeZine」上で「IoTをかじってみよう」の連載が始まり(*5)、2014年の活動からはAmazonのKindle出版で『食べる!SSL! ?HTTPS環境構築から始めるSSL入門』の出版があった(*6)。2016年の活動においても複数のメンバーが出版社と現在調整中で、2017年に出版される予定である。

・・・・・・・・

(*5)http://bit.ly/is14_tecj005

(*6)http://bit.ly/is14_tecj006

・・・・・・・・

 

参加メンバーの感想

 毎年末に、その年の参加メンバーから感想をもらっているので紹介しよう。

・ ようやく出版の夢が近づいてきました。

・ 技術書執筆という共通の目標に向かって、皆で励まし合いながらアイデアを出し合ったり、レビューし合えたのが楽しかったです。

・ 英語版も出せるくらいの本を目指して書き進めます!

・ 合同での執筆に参加したかった。

・ 書籍・記事の形に残すことの利点の1つは、確かな(レビューされた)情報を、必要とする人へ素早くシェアできることです。書くときは苦労しますが、あとで(自分を含めて)必ず誰かの役に立ちます!

・ もう少しがんばってみます。

・ 書くのを止めると書けなくなるので、書き続けます。

・ あらためて、執筆活動の重要性を感じました。

・ 今年は参加メンバーが少なかったなあ。

 メンバーは書籍の出版や雑誌・メディアへの寄稿という夢や希望をもって参加しているので、前向きなコメントが多い。書くこと、書き続けることの大切さを指摘するコメントも多数ある。

 また、「参加メンバーが少なかった」とのコメントもあるが、IT技術者の情報発信力が課題になるなかで、まさにその実践トレーニングを行っているWGなので、活動自体の紹介も発信していきたいと考えている。【以上、谷口執筆】

 

 

個人の発信が容易な
デジタル・ルネッサンス時代

 従来、音楽や文章といった芸術を「出版」するには多大なコストがかかっていた。物理的な媒体(本なら紙、音楽ならレコードやCD)に記録していたために、媒体への記録(印刷やレコーディング)と流通コストが販売価格の大部分を占めていた。

 一昔前、ネットワークの整備と速度向上により、芸術は物理媒体の呪縛からいよいよ解き放たれるかに見えたが、そうは問屋が卸さなかった。マネタイズの仕組みが整っていなかったのだ。多くのサイトが、寄付や広告掲載によってこの問題の解決を試みたが、うまくいかなかった。不正コピーを恐れるあまり、強烈なDRM(デジタル著作権管理)により利用者に不便を強要する動きもあった。

 そんな時代からどのくらい経過しただろうか。ようやく「芸術の配信」は著作者とファンとの間の着地点を見つけつつあるようだ。現在はいわば「デジタル・ルネッサンス」時代である。誰もが簡単に芸術を発信し、対価を得られる。もちろんそれで生計を立てられるような人は限られるが、以前と比べれば確実に裾野は広がったと言えるだろう。

 筆者(花井)は数年ほど前から文章だけでなく、音楽(ピアノ曲)の配信にも挑戦している(iTunesで「Shisei Hanai」で検索すると表示される)。プロでもない個人にこういうことができるようになったのは、まさに隔世の感がある。読者の皆さんも自分の趣味を、趣味だけにとどめずにデジタル・ルネッサンス時代に乗って発信してみてはいかがだろうか。【以上、花井執筆】

 

・・・・・・・・

◎著者プロフィール

花井 志生 氏

日本IBM入社時はC/C++を用いた組み込み機器(PoS)用のアプリケーション開発に携わる。10年ほどでサーバーサイドに移り、主にJavaを使用したWebアプリケーション開発に軸足を移す。2015年夏からクラウドを用いたソリューションのテクニカル・コンサル、PoCを生業としている。Java、Ruby、C言語関連の著書がある。

・・・・・・・・

山﨑 まゆみ 氏

文教・公共および金融業界のユーザーを担当し、オープン系サーバー構築・保守、Webアプリケーション開発、大規模システム更改やデータセンター移転などのプロジェクトを経験。現在は部門の運営や、クラウドを活用したサービスビジネスの推進活動を行っている。

・・・・・・・・

谷口 督 氏

「西暦2000年問題」対応の時期にIT業界に入り、それ以来UNIX系のインフラ構築に従事。最近はクラウドの案件に関わることが増えている。個人的には、IoTやディープラーニングのテクノロジーを活用した、世の中をよくするためのもの作りに関心がある。

・・・・・・・・

[IS magazine No.14(2017年4月)掲載]

 

related posts