ドキュメント作成の3原則

HireRoo社主催 Re:TechTalk #17 の資料です。
https://hireroo.connpass.com/event/373324/

Transcript

1. ドキュメント作成の3原則 2025年11月25日 HireRoo Re:TechTalk 仲田 尚央 @naoh_nak
2. 仲田 尚央 Nakata Naohiro @naoh_nak テクニカルライター、UXライター＠SmartHR テクニカルライティング研修 非常勤講師＠都立産業技術高専 ソフトウェアのUIテキストを書いたり、ドキュメントを書いたり、 それらをローカライズしたりするお仕事をしています。 2
3. 本セッションでは、書籍『エンジニアが 一生困らない ドキュメント作成の基本』 をベースに、エンジニアがドキュメント を書くために必要な基礎知識についてお 話しします。
4. ドキュメントとは 情報の保存、共有、伝達の手段として用いられる文書のこと • 報告書・レポート・論文 • マニュアル • PRD（要件仕様書） • 技術書・解説書 • 企画書 など 4
5. 逆に、ドキュメントでないもの 情報の保存、共有、伝達を目的としないもの • 小説 • 随筆 • 感想文 • 日記 5
6. ドキュメントと小説の違いを理解しよう 6
7. 小説とドキュメントの目次を比べてみよう 小説の目次（宮沢賢治『銀河鉄道の夜』より） • 一、午后の授業 • 二、活版所 • 三、家 • 四、ケンタウル祭の夜 • 五、天気輪の柱 • 六、銀河ステーション • 七、北十字とプリオシン海岸 • 八、鳥を捕とる人 • 九、ジョバンニの切符 7 ドキュメントの目次（富永敦子・綿井雅康『わかりやすく説明する技術』より） • 第1章 上司を満足させる報告テクニック ◦ 質問に対応する答えを一言で述べる ◦ 事実と意見を分けて説明する ◦ 報告書は総論、各論、結論の順に展開する ◦ 報告書の作成手順を考える ◦ あれもこれも盛り込まない • 第2章 相手を説得し行動させる提案テクニック ◦ 最初に話のテーマと提案内容を説明する ◦ 具体的な根拠を示して立証する ◦ 問題点と解決策を対応させる ◦ 予想される質問や反対意見に備える • 第3章 上司から部下への指示テクニック （後略）
8. 小説とドキュメントの目次を比べてみよう 小説の目次（宮沢賢治『銀河鉄道の夜』より） • 一、午后の授業 • 二、活版所 • 三、家 • 四、ケンタウル祭の夜 • 五、天気輪の柱 • 六、銀河ステーション • 七、北十字とプリオシン海岸 • 八、鳥を捕とる人 • 九、ジョバンニの切符 8 ドキュメントの目次（富永敦子・綿井雅康『わかりやすく説明する技術』より） • 第1章 上司を満足させる報告テクニック ◦ 質問に対応する答えを一言で述べる ◦ 事実と意見を分けて説明する ◦ 報告書は総論、各論、結論の順に展開する ◦ 報告書の作成手順を考える ◦ あれもこれも盛り込まない • 第2章 相手を説得し行動させる提案テクニック ◦ 最初に話のテーマと提案内容を説明する ◦ 具体的な根拠を示して立証する ◦ 問題点と解決策を対応させる ◦ 予想される質問や反対意見に備える • 第3章 上司から部下への指示テクニック （後略） どこに何が書かれて いるかが明確 見出しから答えが わかる
9. 小説とドキュメントの文章を比べてみよう 9 小説の文章（宮沢賢治『銀河鉄道の夜』より） 　「ではみなさんは、そういうふうに川だと云われたり、乳の流れたあとだと云われたりしていたこのぼんやりと白い ものがほんとうは何かご承知ですか。」先生は、黒板に吊した大きな黒い星座の図の、上から下へ白くけぶった銀河帯 のようなところを指しながら、みんなに問いをかけました。 　カムパネルラが手をあげました。それから四五人手をあげました。ジョバンニも手をあげようとして、急いでそのま まやめました。たしかにあれがみんな星だと、いつか雑誌で読んだのでしたが、このごろはジョバンニはまるで毎日教 室でもねむく、本を読むひまも読む本もないので、なんだかどんなこともよくわからないという気持ちがするのでし た。 　ところが先生は早くもそれを見附けたのでした。 　「ジョバンニさん。あなたはわかっているのでしょう。」 　ジョバンニは勢よく立ちあがりましたが、立って見るともうはっきりとそれを答えることができないのでした。ザネ リが前の席からふりかえって、ジョバンニを見てくすっとわらいました。ジョバンニはもうどぎまぎしてまっ赤になっ てしまいました。先生がまた云いました。 　「大きな望遠鏡で銀河をよっく調べると銀河は大体何でしょう。」 　やっぱり星だとジョバンニは思いましたがこんどもすぐに答えることができませんでした。
10. 小説とドキュメントの文章を比べてみよう 10 ドキュメントの文章（富永敦子・綿井雅康『わかりやすく説明する技術』より） ビジネスマンの仕事の一つに業務改善があります。 業務改善とは、日々の業務のなかで、問題点を見つけ出 し、その原因を分析し、解決策を考え実施し、解決することです。ただし、解決策を考えたからといって、すぐ に実施できるわけではありません。 解決策を実施するには、 上司の承認が必要です。上司に解決策を説明し、 承認されて初めて解決策を実施することができます。いくら優れた解決策でも、上司が理解できなければ、また 承認してくれなければ実施することはできません。 どうすれば、上司は解決策を理解し、承認してくれるのでしょうか? 解決策を連呼し力説するだけでは、上司は納得しませんし、もちろん承認も下りません。上司の承認を得るに は、解決策をわかりやすく説明すること、かつ説得力のある説明をすることです。
11. 小説とドキュメントの文章を比べてみよう 11 ドキュメントの文章（富永敦子・綿井雅康『わかりやすく説明する技術』より） ビジネスマンの仕事の一つに業務改善があります。 業務改善とは、日々の業務のなかで、問題点を見つけ出 し、その原因を分析し、解決策を考え実施し、解決することです。ただし、解決策を考えたからといって、すぐ に実施できるわけではありません。 解決策を実施するには、 上司の承認が必要です。上司に解決策を説明し、 承認されて初めて解決策を実施することができます。いくら優れた解決策でも、上司が理解できなければ、また 承認してくれなければ実施することはできません。 どうすれば、上司は解決策を理解し、承認してくれるのでしょうか? 解決策を連呼し力説するだけでは、上司は納得しませんし、もちろん承認も下りません。上司の承認を得るに は、解決策をわかりやすく説明すること、かつ説得力のある説明をすることです。 • 事実を中心に書かれている • 主張がズバリと書かれている • 事実から主張が導かれている
12. ドキュメントの特徴① ドキュメントには目的の達成が求められる マニュアル プロダクトの使い方 を伝える 12 プロダクトの使い方 を知る ◯◯機能の概要 を知りたい △△機能の操作 方法を知りたい エラーの解消 方法を知りたい
13. ドキュメントの特徴② ドキュメントには情報が効率良く伝わることが求められる 13 • 読み手の目的は「必要な情報を得ること」であり「ドキュメントを読むこと」ではない • 小説と異なり、ドキュメントを最初から最後まですべて読む人はいない • ドキュメントは、どこに何が書いてあるかが一目でわからなければならない
14. ドキュメントの特徴③ ドキュメントには情報が正しく伝わることが求められる 14
15. ドキュメントでありがちな課題 • 多くの情報を詰め込んでしまい、読みづらい、必要な情報が見つからな い、と言われる • ドキュメントに書いてあるのに、読み落とされる • 言いたいことが伝わらない、理解が得られない • 正しく手順を書いているのに問い合わせがくる
16. ドキュメントの3原則 • 目的（誰に何を伝えるか）を明確にする • 構造化して伝える • 重要なことから伝える
17. 目的（誰に何を伝えるか）を明確にする
18. 1：1のコミュニケーション Aさん Aさんは◯◯のことは 知っているはず。 〇〇を説明しよう。
19. 1：nのコミュニケーション Aさん Bさん Cさん ズレ ズレ ドキュメントは、複数の読み手を想定しなければならない
20. 1：nのコミュニケーション Aさん Bさん Cさん BさんとCさん向け の情報も加えなきゃ
21. 1：nのコミュニケーション Aさん Bさん Cさん 情報が多すぎて 読みづらい... 闇雲に読み手を増やすと、読まれないドキュメントへと陥っていく
22. ドキュメントの目的を絞り込む ドキュメントの目的（誰に、何を伝えるか）を絞り 込むことで： • ドキュメントの構成がシンプルになる • 読み手に合わせた構成を組めるようになる • 読み手に合わせた粒度で説明できるようになる Aさん Bさん Cさん
23. 誰に伝えるのか（読み手） 業務マニュアル プログラマー テストエンジニア デザイナー サポート テクニカルライター マネージャー 開発メンバー 新入メンバー 慣れたメンバー
24. 何を伝えるのか（テーマ） 業務マニュアル 使用するツール 関連部署・関係者 の役割 業務フロー ツールの 導入手順 トラブル シューティング
25. 絞り込みの切り口 • 読み手の知識レベル ◦ プロダクトに関する知識 ◦ 技術に関する知識 ◦ 業務に関する知識 • 読み手の目的 ◦ 〇〇機能の仕様を知りたい ◦ データの入出力の仕様を知りたい • 読み手の立場や役割 ◦ プログラマー ◦ テストエンジニア ◦ デザイナー 3つの切り口で読み手を絞り込む
26. プロジェクトの進捗報告書の読み手を絞り込む 切り口 絞り込みの例 読み手の知識レベル • 自部署向け • 他部署向け 読み手の目的 • 戦略の決定に役立つ情報を得たい • チームのパフォーマンスやプロジェクトの進捗を把握したい • 業務やプロジェクトに必要な詳細な情報を得たい 読み手の立場や役割 • 経営層 • マネージャー • 実務担当者 例：他部署のマネージャー向けに、チームのパフォーマンスやプロジェ クトの進捗を伝える
27. 誰に、何を伝えるのかを明示する タイトル 前提 リード文： 誰向けに、どんなことを伝えるのかを書く ドキュメントの前提となる情報を書く • 内容の理解に必要な前提知識 • あらかじめ読む必要があるドキュメント 見出し
28. 構造化して伝える
29. 大きく複雑な情報は伝わらない 大きな情報 人が一度に受け止められる情報の量には限りがある 29
30. 情報を分解し、整理して読み手に伝えなければならない わかりやすさのためには、大きく複雑な情報を分解し、整理して伝えていくことが大切 大きな情報 Aの話 Bの話 ・・・ 30
31. ドキュメントの階層構造 ドキュメントは階層構造を持つ • 1つのドキュメントで、1つのテーマ • 1つの見出しで、1つのサブテーマ • 1つのパラグラフで、1つの話題 テーマ サブテーマ 話題 話題 話題 話題 階層構造を取ることで、複雑な情報を整理して伝える こと ができる サブテーマ 31
32. テーマが分解され、ドキュメントに反映される テーマ サブテーマ 話題 話題 話題 話題 サブテーマ テーマ サブテーマ 話題 話題 話題 話題 話題 話題 サブテーマ サブテーマ 32
33. テーマが分解され、ドキュメントに反映される わかりやすく説明する技術 上司を満足させる報告テクニック 最初に話のテーマと提案内容を説明する ・・・ 具体的な根拠を示して立証する ・・・ 相手を説得し行動させる提案テクニック わかりやすく 説明する技術 上司を満足させる報 告テクニック 最初に話のテーマと提 案内容を説明する 相手を説得し行動さ せる提案テクニック 上司から部下への指 示テクニック スマートな商品説明テ クニック 手順や方法をわかり やすく説明するための テクニック 具体的な根拠を示して 立証する 問題点と解決策を対応 させる 予想される質問や反対 意見に備える 33 （富永敦子・綿井雅康『わかりやすく説明する技術』より）
34. テーマを構成する3つの要素 Why なぜ What 何を テーマ How どうやって なぜそれが必要なのか それは何なのか どうやってそれを実現するのか
35. マニュアルであれば • Why（目的）： ◦ 読み手にとってその機能がなぜ必要なのか • What（目標）： ◦ その機能はどういうものなのか ◦ その機能でできること • How（手段）： ◦ その機能をどうやって使うのか Why なぜ What 何を テーマ How どうやって 35
36. 企画書であれば • Why（目的）： ◦ なぜその企画が必要なのか • What（目標）： ◦ 何をするのか・何をしないのか • How（手段）： ◦ 目標をどうやって実現するのか Why なぜ What 何を テーマ How どうやって 36
37. 報告書であれば • Why（目的）： ◦ なぜその活動が必要だったのか • What（結果）： ◦ 何を得たのか ◦ 結果からどのような考察が得られたか • How（手段）： ◦ どうやって結果を得たのか Why なぜ What 何を テーマ How どうやって 37
38. 3つの要素を分解する（マニュアルの場合） 地域コミュニティーの形成 メッセージアプリの 使い方 Why（利用目的） How（アプリの使い方） イベントや活動の計画 趣味や興味の共有 What（どんなアプリか） チャット 公開チャット 会話 連絡帳 プロフィール 家族や友人との会話 ・・・ ・・・
39. 3つの要素を分解する（企画書の場合） 開発速度の低下 フレームワークを Reactに移行する Why（目的） How（手段） 学習コストの高さ 開発者の確保の困難さ What（目標） Reactへの移行する 移行による効果の検証 主なタスク スケジュール メンバー 必要なコスト リスクと対策 開発効率の向上 研修期間の短縮 レンダリング速度の向上
40. Whyが核 Why なぜ What 何を テーマ How どうやって なぜそれが必要なのか それは何なのか どうやってそれを実現するのか
41. Whyがわかれば、読み手がWhat・Howを判断できる Why なぜ What 何を How どうやって
42. このPRDの何が問題か 機能： ユーザーがプロフィールを編集できる 要件： • 名前・メールアドレス・アイコン画像を編集できる • 画像は10MB以下 • メールアドレスはユニークであること
43. このPRDの何が問題か 機能（What）： ユーザーがプロフィールを編集できる 要件（How）： • 名前・メールアドレス・アイコン画像を編集できる • 画像は10MB以下 • メールアドレスはユニークであること 目的（Why）： Why（機能の目的）が欠けている
44. 機能の目的（Why）を積極的に伝える 機能（What）： ユーザーがプロフィールを編集できる 要件（How）： • 名前・メールアドレス・アイコン画像を編集できる • 画像は10MB以下 • メールアドレスはユニークであること 目的（Why）： • プロフィールを充実させてもらいたい？ • 個人情報の正確性を保ちたい？ Whyに応じてWhat・Howが変わる
45. この手順の何が問題か 1. git cloneする 2. Node.js v18をインストールする 3. npm installを実行する 4. .env.exampleをコピーして.envを作る 5. npm run devを実行する 6. http://localhost:3000にアクセスする
46. この手順の何が問題か 1. git cloneする 2. Node.js v18をインストールする 3. npm installを実行する 4. .env.exampleをコピーして.envを作る 5. npm run devを実行する 6. http://localhost:3000にアクセスする Howしか書かれていない
47. この手順の何が問題か 1. git cloneする 2. Node.js v18をインストールする 3. npm installを実行する 4. .env.exampleをコピーして.envを作る 5. npm run devを実行する 6. http://localhost:3000にアクセスする Howしか書かれていない エラーが起きたときに、 読み手が原因を判断できない
48. 各操作の意味（Why）を積極的に伝える 1. git cloneし、リポジトリをローカル環境にクローンする 2. Node.js v18をインストールし、Nodeのバージョンを本番環境と合わせる 3. npm installを実行し、プロジェクトに必要なパッケージをインストールす る 4. .env.exampleをコピーして.envを作り、APIのURLや認証キーなどの環境変 数をローカル環境に保存する 5. npm run devを実行し、ローカル環境でWebサーバーを起動する 6. http://localhost:3000にアクセスし、Webサーバーで起動するアプリ ケーションを開く
49. 複雑な物事や概念の分解 複雑な物事や概念をわかりやすく伝えるには、さらに分解が必要になる 要素1 要素2 要素3 物事や概念
50. 複雑な物事や概念の分解 複雑な物事や概念をわかりやすく伝えるには、さらに分解が必要になる 条件分岐 繰り返し 関数 プログラミング たとえば 変数
51. 分解の2つのパターン テーマ サブテーマ 話題 話題 話題 話題 話題 話題 サブテーマ サブテーマ 概要 全体 具体 部分 具体例で分解 構成要素で分解
52. 全体から部分へと展開する ハードウェアであれば構成部品で、ソフトウェアであれば構成機能で分解される スマートフォン パネル タッチパネル 液晶パネル CPU メモリー ネットワークモジュール LANモジュール Bluetooth センサー 加速度センサー ジャイロセンサー 近接センサー ・・・
53. 概要から具体へと分解する スマートフォン Android スマートフォン Pixel Xperia Galaxy ・・・ iPhone iPhone Pro Max iPhone Pro iPhone Air ・・・
54. 順に説明を展開していく スマートフォン Android スマートフォン Pixel Xperia Galaxy ・・・ iPhone iPhone Pro Max iPhone Pro iPhone mini ・・・ 段階を追って知識を付け加え ていくことが、わかりやすさ に繋がる
55. 情報を適切に分解すると、読者が情報を探しやすくなる スマートフォン Android スマートフォン Pixel Xperia Galaxy ・・・ iPhone iPhone Pro Max iPhone Pro iPhone mini ・・・ 段階を追って知識を付け加え ていくことが、わかりやすさ に繋がる 前知識がない人は、最初 から読み、興味を持った 項目へと進む さわりだけを知りたい人 は、概要だけを読む 特定の知識が欲しい人 は、その項だけを読む どこに何が書いてあるかがわかるよう、適切なタイトルと見出しを付ける
56. メッセージアプリのマニュアルであれば メッセージアプリ の使い方 家族や友人と話す 共通の趣味や関心を持 つ人と話す チャットする 通話する ビデオ通話する コミュニティー に参加する コミュニティー を作る 概要 具体 具体例で分解 利用目的の具体例で分解
57. メッセージアプリのマニュアルであれば メッセージアプリ の使い方 会話 連絡帳 プロフィール チャット 通話 ビデオ通話 公開チャット 非公開チャット 全体 部分 構成要素で分解 機能の構成要素で分解
58. 情報を適切に分解する NG：きれいに分解できる OK：読者の目的に合わせる
59. マニュアルであれば メッセージアプリ の使い方 家族や友人と話す 共通の趣味や関心を持 つ人と話す チャットする 通話する ビデオ通話する コミュニティー に参加する コミュニティー を作る 子供の学校の親同士で 話す場をつくりたい 自分の目的をどうすれば達成できるのか知りたいのであれば 利用目的の具体例で分解
60. マニュアルであれば メッセージアプリ の使い方 会話 連絡帳 プロフィール チャット 通話 ビデオ通話 公開チャット 非公開チャット 機能の用途や使い方を知りたいのであれば 公開チャットの管理者が できることを知りたい 機能の構成要素で分解
61. 仕様書であれば あなたなら情報をどう分解しますか？ プロダクトの外部仕様 機能要件 非機能要件 ？ ？ ？ セキュリティ パフォーマンス 動作環境
62. 答え 読み手の目的が機能の仕様を知ることであれば、機能の構成要素で分解する プロダクトの全体像 機能要件 非機能要件 機能1 機能2 機能3 画面 帳票 エラー ログ セキュリティ パフォーマンス 動作環境 全体から部分へと説明を展開することで、開発者はプロダクトの全体像を把握しながら各機能を開発できる
63. 重要なことから伝える
64. ドキュメントは一部しか読まれないことを前提に書く • 読み手の目的は「必要な情報を得ること」であり「ドキュメントを読むこと」ではない • 小説と異なり、ドキュメントを最初から最後まですべて読む人はいない 64
65. 重要なことを先に伝えていく努力が必要 • 読み手の目的は「必要な情報を得ること」であり「ドキュメントを読むこと」ではない • 小説と異なり、ドキュメントを最初から最後まですべて読む人はいない 65 重要なことを先に言う
66. 重要なこと（要点）を先に伝えるには • タイトル・見出しで要点を伝える • リード文で要点を伝える • パラグラフの冒頭で要点を伝える 見出し タイトル リード文 リード文 パラグラフ 冒頭文 パラグラフ 冒頭文
67. タイトルで要点を伝える タイトルでドキュメント全体の要点を伝える 例：「人は話し方が9割」、「イシューからはじめよ」 67 タイトル＝要点 サブテーマ 話題 話題 話題 話題 サブテーマ
68. 見出しで要点を伝える 68 タイトル 見出し＝サブテーマ 話題 話題 話題 話題 見出し＝サブテーマ 見出しで、その見出しの中の要点を伝える 『わかりやすく説明する技術』（富永敦子・綿井雅康）から抜粋： • 第1章 上司を満足させる報告テクニック ◦ 質問に対応する答えを一言で述べる ◦ 事実と意見を分けて説明する ◦ 報告書は総論、各論、結論の順に展開する ◦ 報告書の作成手順を考える ◦ あれもこれも盛り込まない • 第2章 相手を説得し行動させる提案テクニック ◦ 最初に話のテーマと提案内容を説明する ◦ 具体的な根拠を示して立証する ◦ 問題点と解決策を対応させる ◦ 予想される質問や反対意見に備える
69. リード文で要点を伝える 69 スマートフォンとは何か 　スマートフォンは、携帯電話とコンピューターの機能を併せ持つ携帯機器です。一般的には、タッチス クリーンディスプレイを備え、通話、インターネット、写真や動画の撮影、音楽や動画の再生、各種セン サーによる周辺情報の取得などの機能を提供します。また、アプリケーション（アプリ）をインストール して機能を追加することもできます。 　スマートフォンは、インターネットへの接続が可能で、モバイルデータネットワークやWi-Fiを使用し て情報のやり取りができます。日常生活の中で場所を問わず情報にアクセスすることを可能にし、ウェブ ブラウジング、メディアの視聴、ソーシャルメディアの利用、オンラインショッピング、ビジネス活動な ど、さまざまな目的に使用されています。 　スマートフォンは、写真や動画の撮影機器としても広く使用されています。撮った写真を、スマート フォンを使ってその場で加工したり、友人に共有したり、ソーシャルメディアに投稿したりすることも、 撮影の楽しみ方の一つになっています。 　さらに、スマートフォンは、組み込まれたセンサーにより、日常生活を支援するさまざまな機能を提供 します。GPS、加速度計、ジャイロスコープ、電子コンパス、近接センサー、光センサーといった各種セ ンサーから得られる周辺情報は、地図やナビゲーションのほか、運動量のトラッキング、事故検出などと いった機能を実現します。 リード文で要点を伝える
70. パラグラフごとの冒頭で要点を伝える 70 スマートフォンとは何か 　スマートフォンは、携帯電話とコンピューターの機能を併せ持つ携帯機器です。一般的には、タッチス クリーンディスプレイを備え、通話、インターネット、写真や動画の撮影、音楽や動画の再生、各種セン サーによる周辺情報の取得などの機能を提供します。また、アプリケーション（アプリ）をインストール して機能を追加することもできます。 　スマートフォンは、インターネットへの接続が可能で、モバイルデータネットワークやWi-Fiを使用し て情報のやり取りができます。日常生活の中で場所を問わず情報にアクセスすることを可能にし、ウェブ ブラウジング、メディアの視聴、ソーシャルメディアの利用、オンラインショッピング、ビジネス活動な ど、さまざまな目的に使用されています。 　スマートフォンは、写真や動画の撮影機器としても広く使用されています。撮った写真を、スマート フォンを使ってその場で加工したり、友人に共有したり、ソーシャルメディアに投稿したりすることも、 撮影の楽しみ方の一つになっています。 　さらに、スマートフォンは、組み込まれたセンサーにより、日常生活を支援するさまざまな機能を提供 します。GPS、加速度計、ジャイロスコープ、電子コンパス、近接センサー、光センサーといった各種セ ンサーから得られる周辺情報は、地図やナビゲーションのほか、運動量のトラッキング、事故検出などと いった機能を実現します。 インター ネット機能 撮影機能 センシング 機能 話題
71. パラグラフの展開のパターン 要点 （言いたいこと） 理由を挙げる 説明を述べる 具体例を挙げる 別の言葉で言い換える 詳細を述べる パラグラフの文章には主に3つのパターンがある パターンを意識すると、要点を先に伝えられるだけでなく、 文章を考えやすくなる
72. 言いたいことの理由で展開する 業務でスマートフォンを活用することは生産性の向上につながります。スマートフォン を使うことで、移動中や外出先での空き時間を利用して業務を進めることが可能になり ます。たとえば、出勤時の電車の中でメールを読んでおけば、忙しい朝の時間を節約で き、またちょっとした返信もその場で済ませることができます。外出先で報告書を作成 して提出すれば、報告書を作成しにわざわざオフィスに戻ることも不要になります。 要点（言いたいこと）に対して、「なぜなら...」、「そうすれば...」、「そうし ないと...」と展開していく 言いたいこと その理由
73. 言いたいことの説明で展開する スマートフォンは、携帯電話とパソコンの機能を併せ持つ携帯機器です。通話したり、 メッセージを送ったりといった電話としての機能だけでなく、インターネットで情報を 得たり、音楽や動画 を楽しんだり、撮った写真や動画を加工してインターネットで共有 したりと、まるで小さなパソコンとも言えるさまざまな機能を持ちます。さらに、パソ コンと同じように、「アプリ」と呼ばれるアプリケーションソフトウェアを入れて機能 を追加することもできます。 要点（言いたいこと）に対して、「つまり...」、「要するに...」、「言い換える と...」と展開していく 言いたいこと その詳細の説明
74. 言いたいことの具体例で展開する スマートフォンは写真や動画の撮影機器としても広く使用されています。多くのスマー トフォンは高性能なカメラを備えていて、日常生活や旅行先などで手軽に美しい写真や 動画を撮影できます。そして、撮った写真をスマートフォンを使ってその場で加工した り、友人に共有したり、ソーシャルメディアに投稿したりすることも、撮影の楽しみ方 の一つになっています。 要点（言いたいこと）に対して、「たとえば...」、「具体的には...」と展開して いく 言いたいこと その具体例
75. 「要点を先に」を意識する 読者の目に入りやすい箇所で、積極的に 要点を伝えていこう • タイトル・見出し • リード文 • パラグラフの冒頭 見出し タイトル リード文 リード文 パラグラフ 冒頭文 パラグラフ 冒頭文
76. まとめ • 目的（誰に何を伝えるか）を明確にする ◦ 読み手の知識レベル・読み手の目的・読み手の立場や役割の3つを切り口に「誰に 何を伝えるか」を絞り込む • 構造化して伝える ◦ ドキュメントのテーマを分解して整理し、ドキュメントの構成に落とし込む ◦ テーマはWhy（なぜ）・What（何を）・How（どうやって）の3つに分解できる ◦ Whyが核 → Whyを積極的に読み手に伝えていく • 重要なこと（要点）から伝える ◦ 読者の目に入りやすい箇所（タイトル・見出し・リード文・パラグラフの冒頭） で要点を積極的に伝えていく
77. テクニカルライティングに興味を持たれた方は、 ぜひご参加ください 12月6日 14時〜16時 ＠Zoomウェビナー 宣伝 https://www.teaj.or.jp/seminar/#seminar_15
78. セッションの録画はこちら https://app.hireroo.io/c/content-archives/re-tech-talk-17 ※ HireRooアカウントが必要です