Slide 1

Slide 1 text

テクニカルライティングに学ぶ モノや概念をわかりやすく伝えるテクニック 仲田 尚央 2021.6 @LINE Technical Writing Meetup 1

Slide 2

Slide 2 text

はじめまして 「なかた」です 2

Slide 3

Slide 3 text

3 仲田 尚央 Nakata Naohiro @naoh_nak SEを経て、2009年頃からサイボウズでテクニカルライター お仕事の内容: ⚫ サイボウズ製品のUIテキストを書く ⚫ マニュアルやヘルプを書く ⚫ それらを他の言語に展開する

Slide 4

Slide 4 text

サイボウズ:グループウェアの開発・販売、 チームワーク研修など 4 中小企業グループウェア 業務アプリ作成プラットフォーム 大企業向けグループウェア メール共有システム 70,000社以上 20,000社以上 5,000社以上 10,000社以上

Slide 5

Slide 5 text

サイボウズのライティングチーム 5 開発本部 Garoon kintone Office ・・・ Writer Writer Writer Writer Technical communication Team (テクニカルコミュニケーションチーム) 製品ごとの開発チームに属し、UIテキスト、マニュアル/ヘルプ、リリースノートなどのライティングと翻訳を担う メンバー募集中!

Slide 6

Slide 6 text

テクニカルライティング ≠ 技術的な情報を伝えるための文章技術 6

Slide 7

Slide 7 text

テクニカルライティング = モノやコト(概念)を伝えるための説明技術 7

Slide 8

Slide 8 text

ある日、あなたはお爺さんに聞かれました 8 前から気になってたんじゃが... LINEってなんじゃ?

Slide 9

Slide 9 text

9 複雑なモノや概念を、どう整理して説明するか 技術 製品 サービス 機能 業務 今日のおはなし

Slide 10

Slide 10 text

説明の鉄則 10 概要から具体へ または 全体から部分へ いきなり「具体」や「部分」から入っている説明を見かけるので、この鉄則を意識しよう

Slide 11

Slide 11 text

まず、概要/全体を端的に言う 11 LINEってなんじゃ? LINEはね! スマートフォンのアプリなんだ。LINEを使 うと、友人と、電話したりメッセージをやり とりしたりできる。 ほかにも、ニュースを見たり、お店で料金 を支払ったりといった毎日の生活に欠かせ ないことができる。これらのことが、スマー トフォンだけでできるようになるんだ。

Slide 12

Slide 12 text

相手に合わせて説明の粒度を変える 12 スマートフォンが何なのか わからんのじゃが LINEはね! スマートフォンのアプリなんだ。 スマートフォンというのは、パソコンのよう な携帯電話だよ。電話できるだけじゃなく、 パソコンのように、機能を追加できるんだ。 LINEは、スマートフォンに追加できる機 能の1つなんだ。 相手にとって難しい用語には説明を加える

Slide 13

Slide 13 text

モノや概念を分解する2つの方法 13 具体例で分解する または 構成要素で分解する

Slide 14

Slide 14 text

具体例で分解する LINE 人と話す 知り合いと話す 二人で話す グループで話す 知らない人と話す 友人の近況を知る ニュースを見る 料金を支払う 14

Slide 15

Slide 15 text

15 LINEはね! スマートフォンのアプリなんだ。LINEを使うと、友人と、電話したりメッ セージをやりとりしたりできる。 ほかにも、ニュースを見たり、お店で料金を支払ったりといった毎日の 生活に欠かせないことができる。これらのことが、スマートフォンだけで できるようになるんだ。 友人とのメッセージや電話は、LINEを使うと、インターネット環境 さえあれば無料でできるんだ。それだけでなく、ビデオでお互いの顔 を映して会話することもできる。あと、3人以上で一緒に話すことも できるんだ。 そのほか、共通する趣味や興味を持つ人で集まって、匿名でメッ セージをやりとりすることもできるんだ。サークルのようなものだね。 分解してできた要素を順に説明していく

Slide 16

Slide 16 text

相手の既知の概念に紐付ける 16 電話か それならわかるぞ 電話との差分を説明する ⚫ お互いの顔をビデオで映しながら話せる ⚫ 3人以上で一緒に話せる 新しい概念を説明するときは、相手の既知の概念との差分を言うとわかりやすい

Slide 17

Slide 17 text

構成要素で分解する LINE トーク トーク メッセージ 通話 グループトーク オープンチャット タイムライン ニュース ウォレット 17 ※ソフトウェアを分解する場合、構成要素(機能)と具体例(利用例)が対になることが多い

Slide 18

Slide 18 text

18 LINEはね! スマートフォンのアプリなんだ。LINEを使うと、友人と、電話したりメッ セージをやりとりしたりできる。 ほかにも、ニュースを見たり、お店で料金を支払ったりといった毎日の 生活に欠かせないことができる。これらのことが、スマートフォンだけでで きるようになるんだ。 「トーク」という機能では、友人とメッセージのやりとりや電話ができ る。インターネット環境さえあれば無料でできるよ。 「グループトーク」は、 3人以上で一緒に話すときに使う機能だよ。 そして、 「オープンチャット」という機能では、共通する趣味や興味を 持つ人で集まって、匿名で話すことができるんだ。 実際にモノを触りながら読むマニュアルでは、構成要素(機能)と 具体例(用途)を組み合わせて説明していくのも良い

Slide 19

Slide 19 text

モノ を説明する お題:「ショートケーキ」 19

Slide 20

Slide 20 text

ショートケーキを分解する 20 ショートケーキ イチゴ ホイップクリーム スポンジ

Slide 21

Slide 21 text

21 ショートケーキは、イチゴとホイップ クリームと、スポンジを組み合わせ たケーキだよ ?

Slide 22

Slide 22 text

要素同士の関係を示す 22 イチゴ ホイップクリーム スポンジ ホイップクリーム 甘さを引き立てる 鮮やかな赤を引き立てる 土台 つなぎ

Slide 23

Slide 23 text

ショートケーキを説明する ショートケーキは、イチゴとホイップクリームをふんだんに使った、シンプルなのに華やかな ケーキだ。イチゴ好きにも、クリーム好きにもたまらない。 23 まず全体を言う 魅力も沿えると、なお良い

Slide 24

Slide 24 text

ショートケーキを説明する ショートケーキは、イチゴとホイップクリームをふんだんに使った、シンプルなのに華やかな ケーキだ。イチゴ好きにも、クリーム好きにもたまらない。 刻んだイチゴを混ぜたホイップクリームをつなぎにして、柔らかなスポンジを何層か重ねる。 さらに、その周りをホイップクリームで包み込み、イチゴを載せて飾り付ける。 24 ショートケーキの 構成要素へと進む

Slide 25

Slide 25 text

ショートケーキを説明する ショートケーキは、イチゴとホイップクリームをふんだんに使った、シンプルなのに華やかな ケーキだ。イチゴ好きにも、クリーム好きにもたまらない。 刻んだイチゴを混ぜたホイップクリームをつなぎにして、柔らかなスポンジを何層か重ねる。 さらに、その周りをホイップクリームで包み込み、イチゴを載せて飾り付ける。 イチゴとホイップクリームは、お互いを引き立て合う存在だ。真っ白なホイップクリームは、イ チゴの赤色をより鮮やかに映えさせる。そして甘酸っぱいイチゴは、ホイップクリームの甘さ をより強く感じさせてくれる。その絶妙な組み合わせは、目にも舌にも素晴らしい。 25 要素同士の 関係を語る

Slide 26

Slide 26 text

技術 を説明する お題:「ヘルプの作り方」 26

Slide 27

Slide 27 text

良いヘルプの要素を分解する ⚫ まず、良いヘルプの要素を具体化する ⚫ 要素ごとに、どうすれば満たせるかを考察し ていく 27 良いヘルプ 役に立つ ターゲットユーザーの設定 情報の収集方法 探しやすい 情報の分類 タイトルや見出しの付け方 検索最適化 わかりやすい 用語の統一 読みやすい文章の書き方 図解 正しい ・・・

Slide 28

Slide 28 text

説明の構成に反映する 28 誰に何を伝えるかを整理する ヘルプの作り方 良いヘルプ 役に立つ ターゲットユーザーの設定 情報の収集方法 探しやすい 情報の分類 タイトルや見出しの付け方 検索最適化 わかりやすい 用語の統一 読みやすい文章の書き方 図解 正しい ・・・ ユーザーの使い方を意識して構成を設計する ユーザーの動線からナビゲーションを設計する スタイルガイドと用語集を準備する 記事を書く - 文章と図解のテクニック ・・・

Slide 29

Slide 29 text

概念 を説明する お題:「鬼滅の刃の魅力」 29

Slide 30

Slide 30 text

鬼滅の刃の魅力を分解する 30 鬼滅の刃の魅力 絵 大正ロマン 着物 建築物 剣技 ストーリー 友情と家族愛 怒り 受け継がれる意思 先の読めなさ キャラクター

Slide 31

Slide 31 text

鬼滅の刃の魅力を説明する 31 『鬼滅の刃』は、大正時代の日本を舞台に描かれた漫画 だ。主人公は、鬼と化した妹を人間に戻す方法を探して、 鬼と戦う。 絵、ストーリー、キャラクター、この漫画はそのすべてが素晴 らしい。 鬼滅の刃の魅力 絵 大正ロマン 着物 建築物 剣技 ストーリー 友情と家族愛 怒り 受け継がれる意思 先の読めなさ キャラクター まず概要を言う

Slide 32

Slide 32 text

鬼滅の刃の魅力を説明する 32 『鬼滅の刃』は、大正時代の日本を舞台に描かれた漫画 だ。主人公は、鬼と化した妹を人間に戻す方法を探して、 鬼と戦う。 絵、ストーリー、キャラクター、この漫画はそのすべてが素晴 らしい。 大正ロマン好きは、絵を見るだけで楽しめる漫画だろう。 時代を彷彿とさせる建築物や、色鮮やかな着物が描かれ る。大正とは外れるが、流麗な剣技も見て楽しい。漫画 版も良いが、カラー映像のアニメ版ではその魅力をよりいっ そう満喫できてオススメだ。 鬼滅の刃の魅力 絵 大正ロマン 着物 建築物 剣技 ストーリー 友情と家族愛 怒り 受け継がれる意思 先の読めなさ キャラクター 部分の説明へと進む

Slide 33

Slide 33 text

鬼滅の刃の魅力を説明する 33 『鬼滅の刃』は、大正時代の日本を舞台に描かれた漫画 だ。主人公は、鬼と化した妹を人間に戻す方法を探して、 鬼と戦う。 絵、ストーリー、キャラクター、この漫画はそのすべてが素晴 らしい。 大正ロマン好きは、絵を見るだけで楽しめる漫画だろう。 時代を彷彿とさせる建築物や、色鮮やかな着物が描かれ る。大正とは外れるが、流麗な剣技も見て楽しい。漫画 版も良いが、カラー映像のアニメ版ではその魅力をよりいっ そう満喫できてオススメだ。 「感情」が強い物語だ。友情、家族愛、非道への怒り、残 酷な死と受け継がれる意志。死を覚悟するような戦いの 場面で、それらの感情が走馬灯のようによぎり、それは人 間に強い力を与える。強靱で冷酷な鬼と対比的だ。感情 が人を強くするのだ。・・・ 鬼滅の刃の魅力 絵 大正ロマン 着物 建築物 剣技 ストーリー 友情と家族愛 怒り 受け継がれる意思 先の読めなさ キャラクター 要素を順に書いていく

Slide 34

Slide 34 text

テーマからずらさない 34 絵の魅力を説明する ストーリーの魅力を説明する キャラクターの魅力を説明する 『鬼滅の刃』の魅力を説明する ・・・ 煉獄さんの魅力を延々と 語り始めたりしない 特定の要素について長々と説明し始めると、文章にまとまりがなくなる。 テーマがブレないように、説明の配分に注意する。

Slide 35

Slide 35 text

まとめ ⚫ 説明の鉄則は、「概要から具体へ」「全体から部分へ」 ⚫ モノや概念を説明するときは、まずそれを分解してみよう ⚫ 分解には2つの方法がある: ⚫ 具体例で分解する ⚫ 構成要素で分解する ⚫ 最初に概要/全体を言う 次に、分解してできた要素を、順に説明していく ⚫ 要素同士の関係を示すと、より理解が深まる ⚫ 全体のテーマを意識して、説明の配分に注意しよう 35

Slide 36

Slide 36 text

36 ありがとうございました! 仲田 尚央 @naoh_nak