Shoeisha Technology Media

CodeZine(コードジン)

特集ページ一覧

「読者はだれ?」~ソフトウェア開発者に贈るテクニカルライティングの極意

テクニカルライティング作法・外伝 第1回

  • LINEで送る
  • このエントリーをはてなブックマークに追加
2019/01/18 11:00

 テクニカルライティングに役立つ(かもしれない)話をあれこれと書く連載、始まります。第1話は、読者を想定することについて。

目次

はじめに

 科学技術に関わる人に必須のスキルとして「テクニカルライティング」は注目を集めてきました。本屋を見渡せば、古くは1981年の「理科系の作文技術」(中公新書)から、最近では昨年の秋に出版された「技術者のためのテクニカルライティング入門講座」(翔泳社)まで、たくさんの書籍が出ています。テクニカルライティングを教える講座やセミナーがあちこちで開催されていますし、テクニカルライティング試験なんてものまであります。

 私(筆者)はテクニカルライティングを飯のタネにしています。優れたテクニカルライターだというつもりはないですけれど、多くの読者のみなさんよりは長く生きている分だけ、みなさんの役に立つ話を提供できそうです。でも私は、上にあげた本のような確立した知識体系を持っているわけではありません。体系的な内容はそういった書籍やセミナーなどにお任せして、この連載ではテクニカルライティングに関するあれやこれやの小ネタを紹介していきます。そこでタイトルも「外伝」としました(本伝はありませんけど)。

 今回は、最初なので「テクニカルライティングって何」という前振りをしてから、テクニカルライティングで一番大切なことについて話します。

その1、テクニカルライティングとは何か。その2、読者を想定するということ。
第1話のお題

対象読者

  • テクニカルな文章を書いている人/書かなきゃいけない人
  • その中でも、とくにソフトウェア開発に関わっている人

 テクニカルライティングの領域は広いですけど、この連載ではソフトウェア開発に関連した文書を主に想定しています。

テクニカルライティングって?

 昔、私の知っている範囲でいえば昭和の終わり頃、テクニカルライターが書くものといえば機械の取り扱い説明書や整備マニュアルを指していました。今では、科学技術に関係する文章を書くこと全てがテクニカルライティングなんじゃないかと思えるくらい、広い意味に使われているようです。例えば、次にあげるものはテクニカルライティングの対象でしょう。

  • マニュアル:ハードウェアやソフトウェアの取り扱い説明書、オンラインヘルプ
  • 記事:論文、技術系の書籍、雑誌やWebマガジン、ブログ、同人誌
  • 設計書:新製品の開発企画書、要件定義書、外部設計書、内部設計書
  • 報告書:障害調査報告書、作業報告書、バグレポート
  • プレゼンテーション:講演の原稿、スライド資料

 参考までに、よく引用されているテクニカルライティングの定義を載せておきます。

"Basic Technical Writing" (Herman M. Weisman, 1962) p.1
Technical writing is a specialized field of communication whose purpose is to convey technical and scientific information and ideas accurately and efficiently.
(テクニカルライティングとは、技術的・科学的な情報やアイデアを正確かつ効率的に伝えることを目的とした、コミュニケーションの専門分野です。)

なぜ今、テクニカルライティング?

 このところテクニカルライティングが注目されていると、私は感じています。いろいろな理由があるのでしょう。ソフトウェア業界の場合は、長期的には「仕事の拡散」、短期的には「同人誌ブーム」が大きいんじゃないかと思います。

テクニカルライティングという仕事の拡散

 昔のソフトウェアには分厚いマニュアルが付きものでした。例えば、「1994年に発売された『エクセル5.0』の場合、総ページ数792ページ、厚さ4センチを超す立派なマニュアルが同梱され、これとは別に『VBA』のマニュアルまで付属していた」(日経 xTECH、2007/8/27)といった具合です。そのようなマニュアルは、開発チームとは別に専任のテクニカルライターが作っていたものです。

 今どきのソフトウェアは、マニュアルの付いている方が珍しくなりました。分厚いマニュアルに載っていた情報は、オンラインマニュアルやアプリのヘルプに移動したのです。オンラインマニュアルやヘルプの製作は、開発チーム内でやることが多いでしょう。ヘルプの文章にいたっては、プログラマー任せというところもあるんじゃないでしょうか。

 昔は専任テクニカルライターだけの仕事だったものが、ソフトウェア開発者全体に拡散してきたのです。テクニカルライティングに関わる人が増えてくれば、当然ながら注目もされるようになりますね。

ブログや同人誌ブーム

 ソフトウェア開発者に限らず技術者というものは、自分が得たスキルを見せびらかしたい習性があるようなんですね。ソースコードのカッコイイ書き方を発見したら、チームメイトが理解できなくて困ろうとも、ガンガンそれでコーディングしてしまいたい生き物なんです(チームに合わせてそれをこらえるには理性を総動員しなくちゃいけません)。

 インターネットが普及してブログが簡単に作れるようになると、そういう習性の開発者はブログを書くようになりました。それならチームメイトに迷惑は掛かりませんし、より多くの人に知ってもらえます。さらに高じて、同人誌を作る人も現れました(私も寄稿したことがあります)。

 ソフトウェア開発の同人誌(技術系同人誌)は、長らくコミック同人イベントの片隅などで頒布されてきました。それに加えて、技術系同人誌に特化したイベント「技術書典」が2016年から開催されるようになってからは、技術系同人誌により注目が集まるようになりました。

【News Up 文系も知りたい「技術書典」 】「技術書典」この4文字を見て「なにかの辞典?」などと思ったあなたは、永遠の文系。心を熱くするのが、日本のITエンジニアたちです。技術者たちの「コミケ」とも言われ、最近、注目のイベントの魅力に迫りました。
「技術書典5」(2018/10/8)の様子を報じるNHKニュースのツィート
技術書典6を4月14日(日)に池袋サンシャインシティにて開催いたします。サークル申込は本日より1月31日までです!                          #技術書典 では出展者のうち4割以上が初参加のサークルさんです。我々は新刊が大好きなので初参加のサークルさんも大好きです                          沢山の申込お待ちしてます!
「技術書典6」(2019/4/14予定)の開催を知らせる技術書典公式アカウントのツィート

 技術系同人誌やブログは、まさにテクニカルライティングです。よい記事を書くにはテクニカルライティングを学ばなきゃ、となりますね。


関連リンク

  • LINEで送る
  • このエントリーをはてなブックマークに追加

著者プロフィール

  • biac(ばいあっく)

    HONDA R&Dで自動車の設計をやっていた機械屋さんが、技術の進化スピードに魅かれてプログラマーに。以来20年ほど、より良いコードをどうやったら作れるか、模索の人生。わんくま同盟の勉強会(名古屋)で、よく喋ってたりする。 Microsoft MVP (Windows Development)...

バックナンバー

連載:テクニカルライティング作法・外伝
All contents copyright © 2005-2019 Shoeisha Co., Ltd. All rights reserved. ver.1.5