録画:https://www.youtube.com/watch?v=49CzhFGqvD8 概要: 何かの技術、商品、サービスや機能など、モノや概念を人に説明しなければならない場面は多くあります。 伝えなくてはならないことはいっぱいあるけれど、何からどんな順番で伝えたらいいのかわからず、時間だけが過ぎて焦ってしまう、そんな経験はありませんか? テクニカルライターが情報をどう整理して構造化しているかをお伝えします。
テクニカルライティングに学ぶモノや概念をわかりやすく伝えるテクニック仲田 尚央 2021.6 @LINE Technical Writing Meetup1
View Slide
はじめまして「なかた」です2
3仲田 尚央Nakata Naohiro@naoh_nakSEを経て、2009年頃からサイボウズでテクニカルライターお仕事の内容:⚫ サイボウズ製品のUIテキストを書く⚫ マニュアルやヘルプを書く⚫ それらを他の言語に展開する
サイボウズ:グループウェアの開発・販売、 チームワーク研修など4中小企業グループウェア 業務アプリ作成プラットフォーム大企業向けグループウェア メール共有システム70,000社以上 20,000社以上5,000社以上 10,000社以上
サイボウズのライティングチーム5開発本部Garoon kintone Office ・・・Writer Writer Writer WriterTechnical communication Team(テクニカルコミュニケーションチーム)製品ごとの開発チームに属し、UIテキスト、マニュアル/ヘルプ、リリースノートなどのライティングと翻訳を担うメンバー募集中!
テクニカルライティング ≠技術的な情報を伝えるための文章技術6
テクニカルライティング =モノやコト(概念)を伝えるための説明技術7
ある日、あなたはお爺さんに聞かれました8前から気になってたんじゃが...LINEってなんじゃ?
9複雑なモノや概念を、どう整理して説明するか技術製品サービス機能業務今日のおはなし
説明の鉄則10概要から具体へまたは全体から部分へいきなり「具体」や「部分」から入っている説明を見かけるので、この鉄則を意識しよう
まず、概要/全体を端的に言う11LINEってなんじゃ?LINEはね!スマートフォンのアプリなんだ。LINEを使うと、友人と、電話したりメッセージをやりとりしたりできる。ほかにも、ニュースを見たり、お店で料金を支払ったりといった毎日の生活に欠かせないことができる。これらのことが、スマートフォンだけでできるようになるんだ。
相手に合わせて説明の粒度を変える12スマートフォンが何なのかわからんのじゃがLINEはね!スマートフォンのアプリなんだ。スマートフォンというのは、パソコンのような携帯電話だよ。電話できるだけじゃなく、パソコンのように、機能を追加できるんだ。LINEは、スマートフォンに追加できる機能の1つなんだ。相手にとって難しい用語には説明を加える
モノや概念を分解する2つの方法13具体例で分解するまたは構成要素で分解する
具体例で分解するLINE人と話す知り合いと話す二人で話すグループで話す知らない人と話す友人の近況を知るニュースを見る料金を支払う14
15LINEはね!スマートフォンのアプリなんだ。LINEを使うと、友人と、電話したりメッセージをやりとりしたりできる。ほかにも、ニュースを見たり、お店で料金を支払ったりといった毎日の生活に欠かせないことができる。これらのことが、スマートフォンだけでできるようになるんだ。友人とのメッセージや電話は、LINEを使うと、インターネット環境さえあれば無料でできるんだ。それだけでなく、ビデオでお互いの顔を映して会話することもできる。あと、3人以上で一緒に話すこともできるんだ。そのほか、共通する趣味や興味を持つ人で集まって、匿名でメッセージをやりとりすることもできるんだ。サークルのようなものだね。分解してできた要素を順に説明していく
相手の既知の概念に紐付ける16電話かそれならわかるぞ電話との差分を説明する⚫ お互いの顔をビデオで映しながら話せる⚫ 3人以上で一緒に話せる新しい概念を説明するときは、相手の既知の概念との差分を言うとわかりやすい
構成要素で分解するLINEトークトークメッセージ通話グループトークオープンチャットタイムラインニュースウォレット17※ソフトウェアを分解する場合、構成要素(機能)と具体例(利用例)が対になることが多い
18LINEはね!スマートフォンのアプリなんだ。LINEを使うと、友人と、電話したりメッセージをやりとりしたりできる。ほかにも、ニュースを見たり、お店で料金を支払ったりといった毎日の生活に欠かせないことができる。これらのことが、スマートフォンだけでできるようになるんだ。「トーク」という機能では、友人とメッセージのやりとりや電話ができる。インターネット環境さえあれば無料でできるよ。「グループトーク」は、 3人以上で一緒に話すときに使う機能だよ。そして、 「オープンチャット」という機能では、共通する趣味や興味を持つ人で集まって、匿名で話すことができるんだ。実際にモノを触りながら読むマニュアルでは、構成要素(機能)と具体例(用途)を組み合わせて説明していくのも良い
モノ を説明するお題:「ショートケーキ」19
ショートケーキを分解する20ショートケーキイチゴホイップクリームスポンジ
21ショートケーキは、イチゴとホイップクリームと、スポンジを組み合わせたケーキだよ?
要素同士の関係を示す22イチゴ ホイップクリームスポンジ ホイップクリーム甘さを引き立てる鮮やかな赤を引き立てる土台つなぎ
ショートケーキを説明するショートケーキは、イチゴとホイップクリームをふんだんに使った、シンプルなのに華やかなケーキだ。イチゴ好きにも、クリーム好きにもたまらない。23まず全体を言う魅力も沿えると、なお良い
ショートケーキを説明するショートケーキは、イチゴとホイップクリームをふんだんに使った、シンプルなのに華やかなケーキだ。イチゴ好きにも、クリーム好きにもたまらない。刻んだイチゴを混ぜたホイップクリームをつなぎにして、柔らかなスポンジを何層か重ねる。さらに、その周りをホイップクリームで包み込み、イチゴを載せて飾り付ける。24ショートケーキの構成要素へと進む
ショートケーキを説明するショートケーキは、イチゴとホイップクリームをふんだんに使った、シンプルなのに華やかなケーキだ。イチゴ好きにも、クリーム好きにもたまらない。刻んだイチゴを混ぜたホイップクリームをつなぎにして、柔らかなスポンジを何層か重ねる。さらに、その周りをホイップクリームで包み込み、イチゴを載せて飾り付ける。イチゴとホイップクリームは、お互いを引き立て合う存在だ。真っ白なホイップクリームは、イチゴの赤色をより鮮やかに映えさせる。そして甘酸っぱいイチゴは、ホイップクリームの甘さをより強く感じさせてくれる。その絶妙な組み合わせは、目にも舌にも素晴らしい。25要素同士の関係を語る
技術 を説明するお題:「ヘルプの作り方」26
良いヘルプの要素を分解する⚫ まず、良いヘルプの要素を具体化する⚫ 要素ごとに、どうすれば満たせるかを考察していく27良いヘルプ役に立つターゲットユーザーの設定情報の収集方法探しやすい情報の分類タイトルや見出しの付け方検索最適化わかりやすい用語の統一読みやすい文章の書き方図解正しい ・・・
説明の構成に反映する28誰に何を伝えるかを整理するヘルプの作り方良いヘルプ役に立つターゲットユーザーの設定情報の収集方法探しやすい情報の分類タイトルや見出しの付け方検索最適化わかりやすい用語の統一読みやすい文章の書き方図解正しい ・・・ユーザーの使い方を意識して構成を設計するユーザーの動線からナビゲーションを設計するスタイルガイドと用語集を準備する記事を書く - 文章と図解のテクニック・・・
概念 を説明するお題:「鬼滅の刃の魅力」29
鬼滅の刃の魅力を分解する30鬼滅の刃の魅力絵大正ロマン着物建築物剣技ストーリー友情と家族愛怒り受け継がれる意思先の読めなさキャラクター
鬼滅の刃の魅力を説明する31『鬼滅の刃』は、大正時代の日本を舞台に描かれた漫画だ。主人公は、鬼と化した妹を人間に戻す方法を探して、鬼と戦う。絵、ストーリー、キャラクター、この漫画はそのすべてが素晴らしい。鬼滅の刃の魅力絵大正ロマン着物建築物剣技ストーリー友情と家族愛怒り受け継がれる意思先の読めなさキャラクターまず概要を言う
鬼滅の刃の魅力を説明する32『鬼滅の刃』は、大正時代の日本を舞台に描かれた漫画だ。主人公は、鬼と化した妹を人間に戻す方法を探して、鬼と戦う。絵、ストーリー、キャラクター、この漫画はそのすべてが素晴らしい。大正ロマン好きは、絵を見るだけで楽しめる漫画だろう。時代を彷彿とさせる建築物や、色鮮やかな着物が描かれる。大正とは外れるが、流麗な剣技も見て楽しい。漫画版も良いが、カラー映像のアニメ版ではその魅力をよりいっそう満喫できてオススメだ。鬼滅の刃の魅力絵大正ロマン着物建築物剣技ストーリー友情と家族愛怒り受け継がれる意思先の読めなさキャラクター部分の説明へと進む
鬼滅の刃の魅力を説明する33『鬼滅の刃』は、大正時代の日本を舞台に描かれた漫画だ。主人公は、鬼と化した妹を人間に戻す方法を探して、鬼と戦う。絵、ストーリー、キャラクター、この漫画はそのすべてが素晴らしい。大正ロマン好きは、絵を見るだけで楽しめる漫画だろう。時代を彷彿とさせる建築物や、色鮮やかな着物が描かれる。大正とは外れるが、流麗な剣技も見て楽しい。漫画版も良いが、カラー映像のアニメ版ではその魅力をよりいっそう満喫できてオススメだ。「感情」が強い物語だ。友情、家族愛、非道への怒り、残酷な死と受け継がれる意志。死を覚悟するような戦いの場面で、それらの感情が走馬灯のようによぎり、それは人間に強い力を与える。強靱で冷酷な鬼と対比的だ。感情が人を強くするのだ。・・・鬼滅の刃の魅力絵大正ロマン着物建築物剣技ストーリー友情と家族愛怒り受け継がれる意思先の読めなさキャラクター要素を順に書いていく
テーマからずらさない34絵の魅力を説明するストーリーの魅力を説明するキャラクターの魅力を説明する『鬼滅の刃』の魅力を説明する・・・煉獄さんの魅力を延々と語り始めたりしない特定の要素について長々と説明し始めると、文章にまとまりがなくなる。テーマがブレないように、説明の配分に注意する。
まとめ⚫ 説明の鉄則は、「概要から具体へ」「全体から部分へ」⚫ モノや概念を説明するときは、まずそれを分解してみよう⚫ 分解には2つの方法がある:⚫ 具体例で分解する⚫ 構成要素で分解する⚫ 最初に概要/全体を言う次に、分解してできた要素を、順に説明していく⚫ 要素同士の関係を示すと、より理解が深まる⚫ 全体のテーマを意識して、説明の配分に注意しよう35
36ありがとうございました!仲田 尚央@naoh_nak