書く前に立ち止まって考えよう！「伝える情報を整理する」ということ

by Naohiro Nakata

Slide 1

Slide 1 text

書く前に立ち止まって考えよう！「伝える情報を整理する」ということ 1 DevRel Meetup in Tokyo #76

Slide 2

Slide 2 text

2 仲田尚央 Nakata Naohiro @naoh_nak 開発本部テクニカルコミュニケーションチームテクニカルライター/ローカライズ職能マネージャーお仕事の内容：  サイボウズ製品のUIテキストを書く  製品のマニュアルやヘルプを書く  それらを他の言語に展開する（ローカライズ）

Slide 3

Slide 3 text

3 和氣一成開発本部テクニカルコミュニケーションチームお仕事の内容：  製品のマニュアルやヘルプを書く Issei Wake 経歴  サイボウズに2018年新卒入社  製品サポートセンター → 今年2月に異動（駆け出しライターです。お手柔らかにお願いします）

Slide 4

Slide 4 text

これからお話すること 4 前半：テクニカルライティングってなに？ 後半：書き始める前に、情報をきちんと分解して整理しよう

Slide 5

Slide 5 text

前半：テクニカルライティングってなに？ 5

Slide 6

Slide 6 text

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

Slide 7

Slide 7 text

テクニカルライティングの適用対象  いわゆる「実用文」が求められるドキュメントが主な対象  議事録  報告書  技術書・解説書  仕様書  マニュアル・FAQ などなど 7

Slide 8

Slide 8 text

ドキュメントは多くの人に読まれます 8 業務マニュアル

Slide 9

Slide 9 text

書き手の工夫で、多くの人の時間を節約できます 9 業務マニュアル

Slide 10

Slide 10 text

書き方の方法論を学ぶことで、書き手の時間も節約できます 10 業務マニュアル

Slide 11

Slide 11 text

ドキュメントの前提1 - 求める情報が人によって違う 11 業務マニュアル作業Aの手順を知りたい。入社したばかりで何もわからん。今度担当することになった業務Bについて、一通り全部学びたい。インストールが必要なツールを知りたい。・・・

Slide 12

Slide 12 text

ドキュメントの前提2 - 情報の探し方も違う 12 業務マニュアル作業Aの手順を知りたい。入社したばかりで何もわからん。今度担当することになった業務Bについて、一通り全部知っておきたい。インストールが必要なツールを知りたい。・・・知りたいことが明確知りたいことが曖昧網羅的に知りたい

Slide 13

Slide 13 text

ドキュメントの前提3 – 情報が一意に伝わる 13 ✕ ✕ ✕

Slide 14

Slide 14 text

ドキュメントの前提4 – 一部しか読まれない 14

Slide 15

Slide 15 text

テクニカルライティングの要素 15 Effectiveness 必要な情報を正しく得られる Satisfaction 不快さがなく、肯定的に受け止められる Efficiency 効率よく理解できるユーザビリティーの定義（ISO 9241-11）から

Slide 16

Slide 16 text

それぞれの要素に対して取る手段 16 Effectiveness 必要な情報を正しく得られる Satisfaction 不快さがなく、肯定的に受け止められる Efficiency 効率よく理解できる • 曖昧さを排除し、明確に書く • できるだけ具体的に書く • 誤解なく読める文章で書く • 情報を適切に整理、構造化する • どこに何が書いてあるかをわかりやすくする • 簡潔で読みやすい文章で書く • 必要な情報だけを書く • 肯定的な表現で書く • ですます調で書く（過剰な敬語にはしない）

Slide 17

Slide 17 text

テクニカルライティングの進め方 1. 伝える情報を整理する 2. アウトラインを作る 3. わかりやすく、簡潔な文章で書く 17

Slide 18

Slide 18 text

テクニカルライティングの進め方 1. 伝える情報を整理する 2. アウトラインを作る 3. わかりやすく、簡潔な文章で書く 18 このセッションのテーマ

Slide 19

Slide 19 text

後半：伝える情報を整理する 19

Slide 20

Slide 20 text

整理の鉄則 20 概要から具体へまたは全体から部分へ

Slide 21

Slide 21 text

21 伝えるテーマテーマ1 テーマ1-1 テーマ1-1-1 テーマ1-1-2 テーマ1-2 テーマ2 テーマ2-1 テーマ2-2 概要全体具体部分具体例で分解構成要素で分解

Slide 22

Slide 22 text

書籍や文書の場合 22 伝えるテーマテーマ1 テーマ1-1 テーマ1-1-1 テーマ1-1-2 テーマ1-2 テーマ2 テーマ2-1 テーマ2-2 章節項

Slide 23

Slide 23 text

Webの場合 23 伝えるテーマテーマ1 テーマ1-1 テーマ1-1-1 テーマ1-1-2 テーマ1-2 テーマ2 テーマ2-1 テーマ2-2 カテゴリーページ見出し

Slide 24

Slide 24 text

全体から部分へと分解する（構成要素で分解） 24 kintone アプリレコードフィールドコメントビュー（一覧）アクセス権・・・スペース公開スペース非公開スペースゲストスペースピープルメッセージ

Slide 25

Slide 25 text

概要から具体へと分解する（具体例で分解） 25 スマートフォン Android Pixel Xperia Galaxy ・・・ iOS iPhone Pro Max iPhone Pro iPhone mini ・・・

Slide 26

Slide 26 text

順に説明を展開していく 26 スマートフォン Android Pixel Xperia Galaxy ・・・ iOS iPhone Pro Max iPhone Pro iPhone mini ・・・段階を追って知識を付け加えていくことが、わかりやすさに繋がる

Slide 27

Slide 27 text

情報を適切に分解すると、読者が情報を探しやすくなる 27 スマートフォン Android Pixel Xperia Galaxy ・・・ iOS iPhone Pro Max iPhone Pro iPhone mini ・・・前知識がない人は、最初から読み、興味を持った項目へと進む特定の知識が欲しい人は、その項だけを読むさわりだけを知りたい人は、概要だけを読むどこに何が書いてあるかがわかるよう、適切なタイトルと見出しを付けよう

Slide 28

Slide 28 text

分解には複数のやり方がある 28 スマートフォンコミュニケーション・・・・・・ニュース・・・・・・買い物ナビゲーム・・・

Slide 29

Slide 29 text

情報の適切な分解って？ 29 NG：きれいに分解できる OK：読者の目的に合わせる

Slide 30

Slide 30 text

30 スマートフォンを買う Android Pixel Xperia Galaxy ・・・ iOS iPhone Pro Max iPhone Pro iPhone mini ・・・初めてのスマートフォンどれを選べばいいの？種類が多すぎて… スマートフォンをOSや機種の具体例で分解読者

Slide 31

Slide 31 text

スマートフォンを使いこなすコミュニケーション・・・・・・ニュース・・・・・・買い物ナビゲーム・・・ 31 スマートフォン買ったよ！使いこなしたいスマートフォンを用途の具体例で分解読者

Slide 32

Slide 32 text

スマートフォンスマートフォンを買う Android iOS スマートフォンを使いこなすコミュニケーションニュース買い物ナビゲーム 32 分解方法は、サブテーマごとに異なってもいいただし、同階層での混在はダメ OSや機種の具体例で分解用途の具体例で分解

Slide 33

Slide 33 text

スマートフォンスマートフォンを買う Android iOS スマートフォンを使いこなすコミュニケーションニュース買い物ナビゲームスマートフォンをメンテナンスするデバイスストレージバッテリー 33 • 時系列で • 重要なことから • 情報のニーズが大きいものからテーマを並べる

Slide 34

Slide 34 text

読者の目的を考える情報をどう分解するかを考える情報をどう並べるかを考える 34

Slide 35

Slide 35 text

まとめ  書き始める前に、情報をきちんと分解して整理しよう  分解には、2つの方法があります  具体例で分解する  構成要素で分解する  どの方法での分解が適切かは、読者の目的で決まります  分解してできた要素に沿って、徐々に知識を付け加えていくことが、わかりやすさに繋がります 35