テクニカルライティングとは何か、なぜ必要かを例をもとに整理します

私はテクニカルライターとして開発者向けのドキュメントを書く仕事をしています。自分の仕事について説明することがあるのですが、頭の中を整理するために「テクニカルライティングとは何か?」についてまとめてみます。

この記事ではテクニカルライティングとは何か、必要性などについて、例を用いながら整理します。この記事を読むことで、テクニカルライティングについて学ぶ準備ができればと思います。

著者
Hiroki Zenigami

テクニカルライター。開発者向けのドキュメントを書いています。元エンジニア。共著で「現場で使えるRuby on Rails 5」を書きました。趣味はスプラトゥーンです。

目次

テクニカルライティングとは何か

取扱説明書の例 取扱説明書のイメージ

テクニカルライティングとは、私は「ある製品について、利用者にわかりやすく伝えること」だと考えています。ここでいう製品とは電子レンジのような家電製品や、開発者向けのドキュメントなどがあります。

三菱電機『生産性が向上する「テクニカルライティング」とは』では、テクニカルライティングについて次のように説明しています。

テクニカルライティングは、技術的な内容を目的や読み手に合わせて分かりやすく伝える手法です。

例えば家電製品について、文章やイラストなどを用いて利用者にわかりやすく伝えることがテクニカルライティングだといえます。

広義の意味では、全般的な文章作成術、例えば論文や提案書を書く手法をテクニカルライティングという場合もあります。ただ、この記事では前述した意味で用います。

テクニカルライティングの例

テクニカルライティングの例としては、例えば家電製品の取扱説明書やプログラミング言語・フレームワークなどのドキュメント、技術者が書く技術ブログなどがあります。

ここでひとつ、電子レンジを例にあげてみます。

前章でテクニカルライティングについて「ある製品について、利用者にわかりやすく伝えること」だと述べました。製品について書く上で、この定義にいたるまでには次の三段階があると考えています。

段階概要
1ある製品について書く食品に含まれる水分子を2.4GHzのマイクロ波で振動させることで加熱します
2ある製品について伝える食品に電波を当てることで加熱を行います
3ある製品について利用者にわかりやすく伝えるスタートボタンを押すと食べものが温まります

段階1の例はTDK Techno Magazine『電子レンジの仕組みとは?加熱の原理や基本構造を解説』より引用しました。この三つの中で、電子レンジの取扱説明書という前提では、私たち多くの利用者が知りたいことは段階3の例だと思います。

このように、単なる事実ではなく「利用者にとってわかりやすいことばで必要なことを伝える」のがテクニカルライティングだといえます。

なぜテクニカルライティングが必要か

テクニカルライティングとは「ある製品について利用者にわかりやすく伝えること」だと述べました。また、電子レンジの取扱説明書を例に紹介しました。

では、もしテクニカルライティングを行わなければ、電子レンジの取扱説明書はどうなってしまうのでしょうか。

テクニカルライティングをしない場合

電子レンジの例 電子レンジのイメージ

電子レンジの例でいうと、取扱説明書がわかりづらかったら、利用者はあれこれ試しながら電子レンジを使うかもしれません。もしかしたら危険な使い方をする可能性だってあります。

そもそも使い方がわからないと買ってくれない、ということも想定できます。このように、取扱説明書ひとつで製品の使われ方や売上が大きく変わってしまう可能性があります。

開発者が取扱説明書を書く場合

では、取扱説明書は書きさえすればいいのでしょうか。もちろんそんなことはありません。

例えば、電子レンジの開発者が取扱説明書を書くとします。開発者は開発のプロではありますが、文章のプロではありません。一文が長かったり、利用者がわからない用語を使ったりするかもしれません。

事実は書いているけどわかりづらい、というような取扱説明書ができあがることになりそうです。

テクニカルライターの役割

開発のプロがいるように、文章のプロもいます。これがテクニカルライターです。表にまとめると、開発者・テクニカルライターの役割はそれぞれ次のようになります。

職種役割
開発者利用者が使いやすい製品を開発する
テクニカルライター製品について利用者にわかりやすく伝える

テクニカルライターは、開発者などとコミュニケーションを取りながら、利用者にとってわかりやすく伝わる文章を書いていきます。より利用者に満足してもらえ、結果として製品としての価値がさらに高まります。

近年ウェブサービス関連の企業がテクニカルライターの採用を進めていますが、背景にはこういった理由があると思っています。

テクニカルライターに必要なスキル

前章で述べたように、テクニカルライターは文章を書くことだけが仕事ではありません。文章はもちろん、製品に対する技術的な理解、開発者など関係者とのコミュニケーションも重要なスキルになってきます。

つまり、テクニカルライターには次の三つのスキルが必要になってきます。

  1. 文章力
  2. 技術力
  3. コミュニケーション力

取扱説明書やドキュメントなどの文章を書くことが決まってから、文章が世の中に公開されるまで、そのすべてに携わるのがテクニカルライターの仕事だといえます。もちろんこれは組織によって異なると思いますが、大きな違いはないと考えています。

製品を理解し、利用者を理解し、利用者にとってわかりやすい形で製品について伝えます。中には「そもそも紙でいいのか」という「伝える媒体」に対する検討も行うこともあるかもしれません。

テクニカルライティングは上記三つのスキルを最大限活用した総合格闘技のようなものだといえそうです。

おわりに

テクニカルライティングとは「ある製品について、利用者にわかりやすく伝えること」だと述べました。また、テクニカルライティングの例として電子レンジの取扱説明書を紹介しました。

テクニカルライティングは文章を書く以外にも技術、コミュニケーションといったスキルが重要になってきます。以上がテクニカルライティングの概要になります。

最後に紹介になりますが、テクニカルライティングのスキルを身につける方法としては技術ブログを書くことをおすすめしています。このブログで技術ブログ入門というコンテンツも公開していますので、あわせてご覧ください。

著者
Hiroki Zenigami

テクニカルライター。開発者向けのドキュメントを書いています。元エンジニア。共著で「現場で使えるRuby on Rails 5」を書きました。趣味はスプラトゥーンです。

関連記事関連書籍
applis
アプリケーション開発について学ぶブログ
お問い合わせ
ご意見・ご質問やお仕事のご依頼などは下記よりお願いいたします
お問い合わせ
© 2020-2022 applis