虎の穴開発室ブログ

虎の穴ラボ株式会社所属のエンジニアが書く技術ブログです

MENU

顧客や非エンジニアに向けてわかりやすい文章を書くときに気をつけていることをまとめてみた

qiita.com

※ 本投稿は予約投稿です。

こんばんは。開発ディレクターをしているいわみーです。 この記事は虎の穴ラボ Advent Calendar 2020 - Qiitaの13日目の記事になります。 昨日の記事は、Y.F.さんの「Rust+GraphQLでN+1対策する」です。

さて、私は直接開発ができる(プログラムができる)タイプの開発ディレクターではないので周りが技術ブログだらけの中、ブログを書くと言ってもネタに困りました。 人に披露できるような大層な知識もないのですが、せっかくの機会なので私がディレクターとしての作業時間で一番比重が高い、「文章を書く」ということにスポットを当ててお話できればと思います。

■ はじめに

開発ディレクターをしていると、問い合わせ文章やヘルプ監修の監修をすることもあるのですが、この仕事をしていると本当に感じるのが日本語の難しさです。

当たり前ですが、インターネットは今や小学生の子供から高齢者まで誰もが使うもので、受けている教育も、勿論ITリテラシーも(サイトによってある程度ターゲットは絞られるとはいえ)全く違ってきます。

そんな中で私に課せられた使命は、少しでも分かりやすい表現をする、ということです。

今回はエンドユーザー向けのヘルプに絞って話をしていますが、例えば社内でITに造詣が深くない営業担当や、経営層宛に作るプロダクトの説明資料などでも多分同じ手が使えますので、対外的な資料作りに困っているエンジニアの皆さんの少しでも役に立てれば……と思います。

■ 資料は自分の母親に向けて書くつもりで書け

私がこういった文章を書く時に、いつも頭に浮かべているフレーズがあります。 それは、「お前それサバンナでも同じ事言えんの?」ならぬ「お前それ母親の前でも同じ説明できんの?」です。

これは、私が新卒で入った会社で上司から言われた、「要件定義書は自分の母親に見せてもわかるように書け」という言葉が元になっています。

私の母親は「ガラケー」のことを「ガラクタケータイ」だと思っていた程度にはその手の話に疎い人間でした。私が母親に、「いい加減ガラケーじゃなくてスマホに買い替えたら?」と言ったときに「私のケータイがガラクタだって言うの!?」とキレられて親子喧嘩になったのは、今でも友人と飲み会する時の鉄板ネタです。

そんな私の母親にでも伝わるような文章を書けば、どのような方にでも伝わりやすい文章を意識できると思います。 「相手のことを想像して文章を書け」というのはなかなか難しいですが、このように自分の身近な方宛に書くことを想定すれば、書きやすい人は多いのではないでしょうか。

皆さんは「母親」の部分を是非身近なITの話に疎い方に置き換えて考えてみてください。

余談ですがマーケティング的に言うと、こういった架空のターゲット像(この場合読者像)を設定することを、「ペルソナ設定」と言って、これは新しくサービスを作る際にはとても役に立つ手法なので、気になる方は是非調べてみてください。

参考: web-d.navigater.info

以下はそういった文章を書くために、私が気をつけているポイントです。

■ 横文字言葉はいつでも意味が説明できるようにしておく

当たり前ですが、開発の世界には横文字が溢れています。 エンジニアが当たり前に使っているようで、非エンジニアにはなかなか概念が理解できないワードも多いですね。 例を上げれば、データベース、API、HTML、フロントエンド、バックエンド、サーバーサイド、などなど。

例えばデータベースであれば情報を保存しておく帳簿のようなもの、とかそういう説明ですね。 私が重宝しているのは、『「分かりそう」で「分からない」でも「分かった」気になれるIT用語辞典』(https://wa3.i-3-i.info/)さんです。

非エンジニアに説明するにはちょっと難しい部分もありますが、このサイトの内容をもう少し噛み砕いて説明することが多いですね。

■ 極力「図」を使用する

「文章を書くこと」をテーマに置いておきながら、ちゃぶ台返ししますがそもそも人は文章なんて読まない、と思ったほうがいいです。

これはなにもヘルプに限ったことではなく、例えばTwitter広告を出す際には画像がないツイートより画像があるツイートの方が圧倒的に効果が高いです。(一番高いのは動画なのですが、ヘルプ用に動画を作る、とか言い出すと作業量が大変なことになるので今回はノータッチとします。)

例えば、広告ではこそないですがこういったわかりやすいイメージ写真付きの投稿は比較的エンゲージメント率(画像やリンクなどのクリック数、ユーザーが該当の投稿に反応した割合)が良いですね。

「画面右上にあるログインボタンを押した後、新規登録を押してください」と書くよりも、スクリーンショットを一枚貼ったほうが圧倒的にわかりやすいです。

なお、 多くのサイトではスマホの方がユーザー数が多いので、スマホでの閲覧を想定したスクリーンショットが望ましいです。

■ 重要な局面では比喩表現は使わない

ヘルプの文章で比喩表現を使う機会はないと思いますが、ライトユーザー向けの説明文や、社内説明資料には使いがちなので注意が必要です。

経験上、特に誤解の元になるのが、「【◯◯(サイト名)】の様なシステム」という表現ですね。

この表現、エンジニアとそれ以外が聞いた時で認識が合うパターンに遭遇することは極めて稀です。 大体の非エンジニアはUI/UX部分を想像し、エンジニアは中で使われている技術のことを想像した結果、いざ物ができたときに「ぜんぜん違うじゃん!」となりがちです。

なので、極力比喩はやめて分かる範囲で具体的に書くようにするのが望ましいと思います。

以上です。 明日は、Y.Nさんの「Docker + GradleでKotlin WEBアプリの開発環境+本番環境の構築をやってみよう」だそうです。明日はちゃんとした技術ブログになりますので、お楽しみに。

それにしても、この仕事をしていると常々日本語は難しいな、と感じます。まさしく日々精進ですね。 それではっ。