エンジニアが一生困らないドキュメント作成の基本

Slide 1

Slide 1 text

ドキュメント作成の基本エンジニアが一生困らない 2024年11月7日 Forkwell Library 仲田尚央 @naoh_nak ハッシュタグ：#Forkwell_Library

Slide 2

Slide 2 text

仲田尚央 Nakata Naohiro @naoh_nak ● 本業：テクニカルライター、UXライター＠SmartHR ● サイドワーク：非常勤講師＠都立産業技術高専書籍執筆ソフトウェアのUIテキストを書いたり、ドキュメントを書いたりするお仕事をしています。

Slide 3

Slide 3 text

本セッションでは、書籍の内容をもとに、エンジニアがドキュメントを書くために必要な基礎スキルをお話します。

Slide 4

Slide 4 text

本書の内容 ● ドキュメントの読み方を理解する ● 読み手とテーマを選定する ● テーマを分解する ● ドキュメントの骨組みを組む ● 文章を書く ● わかりやすい文を書く ● ChatGPTで効率良く書く ● ドキュメントの構成例本セッションのスコープドキュメントを書くための基礎スキルとは、テーマをもとにドキュメントの適切な構成を組み、文章に落とし込む技術です。

Slide 5

Slide 5 text

皆さんは、なぜドキュメントを読み、ドキュメントを書くのでしょうか？

Slide 6

Slide 6 text

「ドキュメント読むの大好き！一日中読んでいたい！」「書くのも大好き！ドキュメント書いてお金になる仕事ないかなぁ」こういう人がいたら、#Forkwell_Libraryに書き込んでください

Slide 7

Slide 7 text

「ドキュメント読むの大好き！一日中読んでいたい！」「書くのも大好き！ドキュメント書いてお金になる仕事ないかなぁ」こんな人は、エンジニアにはほとんどいない（いたら是非テクニカルライターになりましょう！）

Slide 8

Slide 8 text

ドキュメントは目的があって読み書きする情報を伝える書き手読み手

Slide 9

Slide 9 text

ドキュメントは目的があって読み書きする必要な情報を得る書き手読み手

Slide 10

Slide 10 text

ドキュメントの種類と目的目的ドキュメントの例概念や手順を説明する要件定義書・バックログ・仕様書・マニュアル・作業手順書知見や活動を報告する報告書・論文・技術ブロク相手に行動を促す企画書・提案書

Slide 11

Slide 11 text

目的を効率良く達成する本書は、 ● 書き手にとっての目的 ● 読み手にとっての目的の両方を効率良く達成するドキュメントの書き方を説明しています。

Slide 12

Slide 12 text

書くことへの苦手意識 ● ドキュメントに書くべきことは何となく頭にあるけれど、文章が思い浮かばない ● 何からどうやって書けばいいのかわからず時間が掛かってしまう ● とりあえず書きはしたものの、話の流れがうまく整わない

Slide 13

Slide 13 text

なぜそうなってしまうのか

Slide 14

Slide 14 text

なぜそうなってしまうのかいきなり文章を書き始めていませんか？

Slide 15

Slide 15 text

プログラミングと同じく設計が大切プログラムを書く要件定義設計実装読み手とテーマの選定構成の設計執筆ドキュメントを書く適切な設計が効率につながる ● 読み手が効率良く情報を得られる ● 書き手が効率良く書ける

Slide 16

Slide 16 text

ドキュメントの目標

Slide 17

Slide 17 text

ドキュメントの特徴① ドキュメントには目的の達成が求められるマニュアルプロダクトの使い方を伝える

Slide 18

Slide 18 text

ドキュメントの特徴② ドキュメントには情報が正しく伝わることが求められる

Slide 19

Slide 19 text

ドキュメントの特徴③ ドキュメントには情報が効率良く伝わることが求められる ● 読み手の目的は「必要な情報を得ること」であり「ドキュメントを読むこと」ではない ● ドキュメントは、どこに何が書いてあるかが一目でわからなければならない

Slide 20

Slide 20 text

ドキュメントの目標目的に応じた情報を効率良く、正しく伝える

Slide 21

Slide 21 text

実用性（ユーザビリティー）の高いドキュメントを目指す Eﬀectiveness 必要な情報を正しく得られる Eﬃciency 効率良く情報を得られる Satisfaction 不快さがなく、肯定的に受け止められるユーザビリティーの定義（ISO 9241-11）から

Slide 22

Slide 22 text

ユーザビリティーが高いドキュメントを書くための要素情報の整理情報を分解し、整理して伝える構成 ● わかりやすく ● 誤解がなく ● 肯定的に受け止められる文を書く文見出しや文章を適切に構成し、どこに何が書かれているかをわかりやすくする

Slide 23

Slide 23 text

目標と手段情報の整理情報を分解し、整理して伝える構成 ● わかりやすく ● 誤解がなく ● 肯定的に受け止められる文を書く文見出しや文章を適切に構成し、どこに何が書かれているかをわかりやすくする Eﬀectiveness 必要な情報を正しく得られる Eﬃciency 効率良く情報を得られる Satisfaction 不快さがなく、肯定的に受け止められる目標手段ユーザビリティーの高いドキュメント

Slide 24

Slide 24 text

Slide 25

Slide 25 text

伝える情報を整理する

Slide 26

Slide 26 text

大きく複雑な情報は伝わらない大きな情報人が一度に受け止められる情報の量には限りがある

Slide 27

Slide 27 text

情報を分解し、整理して伝えるわかりやすさのためには、大きく複雑な情報を分解し、整理して伝えていくことが大切大きな情報 Aの話 Bの話・・・

Slide 28

Slide 28 text

ドキュメントの階層構造ドキュメントは階層構造を持つ ● 1つのドキュメントで、1つのテーマ ● 1つの見出しで、1つのサブテーマ ● 1つのパラグラフで、1つの話題テーマサブテーマ話題話題話題話題階層構造を取ることで、複雑な情報を分解して伝えることができるサブテーマ

Slide 29

Slide 29 text

情報を分解、整理し、ドキュメントの構成に反映するテーマサブテーマ話題話題話題話題サブテーマテーマサブテーマ話題話題話題話題話題話題サブテーマサブテーマ

Slide 30

Slide 30 text

テーマを構成する3つの要素 Why なぜ What 何をテーマ How どうやってなぜそれが必要なのかそれは何なのかどうやってそれを実現するのか

Slide 31

Slide 31 text

マニュアルであれば ● Why（目的）： ○ 読み手にとってその機能がなぜ必要なのか ● What（目標）： ○ その機能はどういうものなのか ○ その機能でできること ● How（手段）： ○ その機能をどうやって使うのか Why なぜ What 何をテーマ How どうやって

Slide 32

Slide 32 text

企画書であれば ● Why（目的）： ○ なぜその企画が必要なのか（目的） ● What（目標）： ○ 何をするのか・何をしないのか（目標） ● How（手段）： ○ 目標をどうやって実現するのか（手段） Why なぜ What 何をテーマ How どうやって

Slide 33

Slide 33 text

報告書であれば ● Why（目的）： ○ なぜその活動が必要だったのか ● What（結果）： ○ 活動の結果はどうだったか ○ 結果からどのような考察が得られたか ● How（手段）： ○ どうやって結果を得たのか Why なぜ What 何をテーマ How どうやって

Slide 34

Slide 34 text

● Why（目的）： ○ ドキュメントの目的 ● What（目標）： ○ ドキュメントとは何か ○ ドキュメントの目標 ● How（手段）： ○ ドキュメントの書き方 Why なぜ What 何をテーマ How どうやって本セッションであれば

Slide 35

Slide 35 text

3つの要素を分解する（マニュアルの場合）地域コミュニティーの形成メッセージアプリの公開チャット機能 Why（目的） How（機能の使い方）イベントや活動の計画趣味や興味の共有 What（どんな機能か）チャットルームを作成する機能管理者がルームを削除する機能管理者が参加者を管理する機能管理者がメッセージを削除する機能ニックネームとアイコンを設定する機能チャットルームを作成する機能管理者がルームを削除する機能管理者が参加者を管理する機能管理者がメッセージを削除する機能ニックネームとアイコンを設定する機能チャットルームに参加する機能チャットルームに参加する機能

Slide 36

Slide 36 text

3つの要素を分解する（企画書の場合）開発速度の低下フレームワークを Reactに移行する Why（目的） How（手段）学習コストの高さ開発者の確保の困難さ What（目標） Reactへの移行する移行による効果の検証主なタスクスケジュールメンバー必要なコストリスクと対策開発効率の向上研修期間の短縮レンダリング速度の向上

Slide 37

Slide 37 text

複雑な物事や概念の分解複雑な物事や概念をわかりやすく伝えるには、さらに分解が必要になる要素1 要素2 要素3 物事や概念

Slide 38

Slide 38 text

複雑な物事や概念の分解複雑な物事や概念をわかりやすく伝えるには、さらに分解が必要になる情報の整理構成文ドキュメントの書き方たとえば

Slide 39

Slide 39 text

分解の2つのパターンテーマサブテーマ話題話題話題話題話題話題サブテーマサブテーマ概要全体具体部分具体例で分解構成要素で分解

Slide 40

Slide 40 text

全体から部分へと展開するハードウェアであれば構成部品で、ソフトウェアであれば構成機能で分解されるスマートフォンパネルタッチパネル液晶パネル CPU メモリーネットワークモジュール LANモジュール Bluetooth センサー加速度センサージャイロセンサー近接センサー・・・

Slide 41

Slide 41 text

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

Slide 42

Slide 42 text

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

Slide 43

Slide 43 text

メッセージアプリのマニュアルであればメッセージアプリの使い方家族や友人と話す共通の趣味や関心を持つ人と話すチャットする通話するビデオ通話するコミュニティーに参加するコミュニティーを作る概要具体具体例で分解利用目的の具体例で分解

Slide 44

Slide 44 text

メッセージアプリのマニュアルであればメッセージアプリの使い方会話連絡帳プロフィールチャット通話ビデオ通話公開チャット非公開チャット全体部分構成要素で分解機能の構成要素で分解

Slide 45

Slide 45 text

情報を適切に分解する NG：きれいに分解できる OK：読者の目的に合わせる

Slide 46

Slide 46 text

マニュアルであればメッセージアプリの使い方家族や友人と話す共通の趣味や関心を持つ人と話すチャットする通話するビデオ通話するコミュニティーに参加するコミュニティーを作る子供の学校の親同士で話す場をつくりたい自分の目的をどうすれば達成できるのか知りたいのであれば利用目的の具体例で分解

Slide 47

Slide 47 text

マニュアルであればメッセージアプリの使い方会話連絡帳プロフィールチャット通話ビデオ通話公開チャット非公開チャット機能の用途や使い方を知りたいのであれば公開チャットの管理者ができることを知りたい機能の構成要素で分解

Slide 48

Slide 48 text

仕様書であればあなたなら情報をどう分解しますか？プロダクトの外部仕様機能要件非機能要件？？？セキュリティパフォーマンス動作環境

Slide 49

Slide 49 text

答え読み手の目的が機能の仕様を知ることであれば、機能の構成要素で分解するプロダクトの外部仕様機能要件非機能要件機能1 機能2 機能3 画面帳票エラーログセキュリティパフォーマンス動作環境全体から部分へと説明を展開することで、開発者はプロダクトの全体像を把握しながら各機能を開発できる

Slide 50

Slide 50 text

効率良く情報を得られるようにするための見出しの構成（アウトライン）

Slide 51

Slide 51 text

効率良く情報を得られるようにする全部読む ● 欲しい情報のありかに当たりを付けながら読む ● 要点を先に掴みながら読む読み手が効率良く情報を得るためには、見出しの構成（アウトライン）が大事 ● どこに何が書かれているかをわかりやすくする ● 要点を先に伝える

Slide 52

Slide 52 text

構成を読み手に伝える「アウトライン」 ● アウトラインとは、物事のあらまし・大筋・概略 ● ドキュメントにおけるアウトラインとは、章・節・項などの見出しを階層的に設定、表示したもの例：レポートのアウトライン ● 概要 ● 調査の背景 ● 調査の内容 ○ データの収集 ○ データの分析 ● 調査の結果と考察 ● 結論

Slide 53

Slide 53 text

アウトラインの役割（書き手にとって） ① 論理を組み立てる例：レポートのアウトライン ● 概要 ● 調査の背景 ● 調査の内容 ○ データの収集 ○ データの分析 ● 調査の結果と考察 ● 結論 Why How What ● Why（目的）： ○ なぜその調査が必要だったのか ● What（結果）： ○ 調査の結果はどうだったか ○ 結果からどのような考察が得られたか ● How（手段）： ○ どうやって結果を得たのか

Slide 54

Slide 54 text

アウトラインの役割（書き手にとって） ② どこに何を書くかを決めるメッセージアプリの公開チャット機能の使い方書くべきことがボンヤリしている書くべきことがハッキリしている機能の概要見出し管理者ができること見出し機能の利用目的見出し操作手順見出し

Slide 55

Slide 55 text

アウトラインの役割（読み手にとって） ① 必要な情報を探す手掛かりどこに何の情報があるかわかりやすい機能の概要管理者ができること機能の利用目的操作手順どこに何の情報があるかわかりづらい

Slide 56

Slide 56 text

アウトラインの役割（読み手にとって） ② 要点を掴む手掛かり見出しから本文の要点を掴める本文を読むまで要点がわからない注意削除したデータは復旧できません

Slide 57

Slide 57 text

分解した情報をアウトラインに仕立てるステップ 1. 要素を並べ替えるテーマを分解してでき要素を、読み手に伝える順番を考えて並べ替える 2. 見出しを付ける要素を選ぶ並べ替えた要素の中から、見出しを付けるものを選ぶ 3. 見出しを決める本文に何が書かれているか、または本文で何が言いたいかを具体的に示す見出しを付ける 4. 見出しだけを流して読んでみる最後に見出しだけを流して読んでみて、どこに何が書かれているかや、ドキュメントで言いたいことをザックリ掴めることを確認する

Slide 58

Slide 58 text

マニュアルのアウトラインを作ろう地域コミュニティーの形成メッセージアプリの公開チャット機能なぜ（目的）どうやって（機能の使い方）イベントや活動の計画趣味や興味の共有何を（どんな機能か）チャットルームを作成する機能管理者がルームを削除する機能管理者が参加者を管理する機能管理者がメッセージを削除する機能ニックネームとアイコンを設定する機能チャットルームを作成する機能管理者がルームを削除する機能管理者が参加者を管理する機能管理者がメッセージを削除する機能ニックネームとアイコンを設定する機能チャットルームに参加する機能チャットルームに参加する機能

Slide 59

Slide 59 text

Step1 要素を並べ替える地域コミュニティーの形成メッセージアプリの公開チャット機能なぜ（目的）どうやって（機能の使い方）イベントや活動の計画趣味や興味の共有何を（どんな機能か）チャットルームを作成する機能管理者がルームを削除する機能管理者が参加者を管理する機能管理者がメッセージを削除する機能ニックネームとアイコンを設定する機能チャットルームを作成する機能管理者がルームを削除する機能管理者が参加者を管理する機能管理者がメッセージを削除する機能ニックネームとアイコンを設定する機能チャットルームに参加する機能チャットルームに参加する機能次のいずれかで並べ替える ● 既知から未知へ ● 時系列で ● 重要なものから ● ニーズが大きいものから

Slide 60

Slide 60 text

Step1 要素を並べ替えるメッセージアプリの公開チャット機能どうやって（機能の使い方）何を（どんな機能か）チャットルームを作成する機能管理者がルームを削除する機能管理者が参加者を管理する機能管理者がメッセージを削除する機能ニックネームとアイコンを設定する機能チャットルームを作成する機能管理者がルームを削除する機能管理者が参加者を管理する機能管理者がメッセージを削除する機能ニックネームとアイコンを設定する機能チャットルームに参加する機能チャットルームに参加する機能地域コミュニティーの形成なぜ（目的）イベントや活動の計画趣味や興味の共有既知から未知へと並べ替える

Slide 61

Slide 61 text

Step1 要素を並べ替えるメッセージアプリの公開チャット機能どうやって（機能の使い方）何を（どんな機能か）チャットルームに参加する機能ニックネームとアイコンを設定する機能チャットルームを作成する機能管理者が参加者を管理する機能管理者がルームを削除する機能チャットルームに参加する機能ニックネームとアイコンを設定する機能チャットルームを作成する機能管理者が参加者を管理する機能管理者がルームを削除する機能管理者がメッセージを削除する機能管理者がメッセージを削除する機能地域コミュニティーの形成なぜ（目的）イベントや活動の計画趣味や興味の共有時系列で並べ替える時系列で並べ替える

Slide 62

Slide 62 text

Step1 要素を並べ替えるメッセージアプリの公開チャット機能どうやって（機能の使い方）何を（どんな機能か）チャットルームに参加する機能ニックネームとアイコンを設定する機能チャットルームを作成する機能管理者が参加者を管理する機能管理者がルームを削除する機能チャットルームに参加する機能ニックネームとアイコンを設定する機能チャットルームを作成する機能管理者が参加者を管理する機能管理者がルームを削除する機能管理者がメッセージを削除する機能管理者がメッセージを削除する機能趣味や興味の共有なぜ（目的）地域コミュニティーの形成イベントや活動の計画ニーズの大きそうなものから並べ替える

Slide 63

Slide 63 text

Slide 64

Slide 64 text

Step2 見出しを付ける要素を選ぶメッセージアプリの公開チャット機能どうやって（機能の使い方）何を（どんな機能か）チャットルームに参加する機能ニックネームとアイコンを設定する機能チャットルームを作成する機能管理者が参加者を管理する機能管理者がルームを削除する機能チャットルームに参加する機能ニックネームとアイコンを設定する機能チャットルームを作成する機能管理者が参加者を管理する機能管理者がルームを削除する機能管理者がメッセージを削除する機能管理者がメッセージを削除する機能趣味や興味の共有なぜ（目的）地域コミュニティーの形成イベントや活動の計画内容が少なそうなので 1つの見出しでくくる重要な要素なのでそれぞれに見出しを付ける公開チャット機能のマニュアルのアウトライン ● 何を（どんな機能か） ● 管理者ができること ● なぜ（機能の利用目的） ○ 趣味や興味の共有 ○ 地域コミュニティーの形成 ○ イベントや活動の計画 ● どうやって（機能の使い方） ○ チャットルームに参加する機能 ○ ニックネームとアイコンを設定する機能 ○ チャットルームを作成する機能 ○ 管理者が参加者を管理する機能 ○ 管理者がメッセージを削除する機能 ○ 管理者がルームを削除する機能

Slide 65

Slide 65 text

Step3 見出しを決める公開チャット機能のマニュアルのアウトライン ● 何を（どんな機能か） ● 管理者ができること ● なぜ（機能の利用目的） ○ 趣味や興味の共有 ○ 地域コミュニティーの形成 ○ イベントや活動の計画 ● どうやって（機能の使い方） ○ チャットルームに参加する機能 ○ ニックネームとアイコンを設定する機能 ○ チャットルームを作成する機能 ○ 管理者が参加者を管理する機能 ○ 管理者がメッセージを削除する機能 ○ 管理者がルームを削除する機能公開チャット機能のマニュアルのアウトライン ● 匿名で誰でも楽しめるチャットルーム ● 管理者ができること ● 公開チャットはこんなときに使える ○ 共通の趣味や興味を持つ人たちと話す ○ 地域のコミュニティーで情報交換する ○ イベントや活動を計画する ● 公開チャットの使い方 ○ チャットルームに参加する ○ ニックネームとアイコンを設定する ○ チャットルームを作成する ○ 【管理者のみ】参加者を管理する ○ 【管理者のみ】メッセージを削除する ○ 【管理者のみ】チャットルームを削除する次のいずれかを示した見出しにする ● 本文に何が書かれているか ● 本文で何を言いたいか

Slide 66

Slide 66 text

Step4 見出しだけを流して読んでみる公開チャット機能のマニュアルのアウトライン ● 匿名で誰でも楽しめるチャットルーム ● 管理者ができること ● 公開チャットはこんなときに使える ○ 共通の趣味や興味を持つ人たちと話す ○ 地域のコミュニティーで情報交換する ○ イベントや活動を計画する ● 公開チャットの使い方 ○ チャットルームに参加する ○ ニックネームとアイコンを設定する ○ チャットルームを作成する ○ 【管理者のみ】参加者を管理する ○ 【管理者のみ】メッセージを削除する ○ 【管理者のみ】チャットルームを削除する見出しだけを流して読んでみて、話のあらましや流れを掴めるかどうかを確認する話のあらましを掴むための情報は見出しに表れていなければならない

Slide 67

Slide 67 text

効率良く情報を得られるようにするための文章の構成

Slide 68

Slide 68 text

文章の組み立て ● 1つの見出しの中でも、読み手に伝える情報はいくつもある ● 話題がバラバラに行ったり来たりしていては、読み手の納得を得られないタイトル見出し話題話題話題話題見出し

Slide 69

Slide 69 text

1つの話題をまとめるパラグラフ ● 1つの話題をまとめるのがパラグラフ ● 話題とは、1つの言いたいこととその理由や説明の組み合わせ ● 一つ一つの言いたいことに対して納得を得ながら、読み手の理解を導いていく言いたいことその理由や説明 1つの話題＝パラグラフ

Slide 70

Slide 70 text

各パラグラフで言いたいことが見出しに結び付く言いたいことその理由や説明言いたいことその理由や説明パラグラフ言いたいことその理由や説明見出しの中全体で言いたいこと 1つの見出しパラグラフパラグラフ『エンジニアが一生後悔しないドキュメントの基本』から引用

Slide 71

Slide 71 text

話題のまとまりを意識すると書きやすくなる ● 書くべきことが小さい単位で決まる 1つの「言いたいこと」をスバリを書けば良い ● 話の流れを作りやすくなる 1つの見出しの中で言いたいことに結び付くよう各パラグラフの「言いたいこと」を書けば良い ● 文章を展開しやすくなる「言いたいこと」と「その理由や説明」に分けて書くことで、パラグラフの文章を展開しやすくなる

Slide 72

Slide 72 text

パラグラフを展開する3つのパターン言いたいこと理由を挙げる説明を述べる具体例を挙げる別の言葉で言い換える詳細を述べるパラグラフの文章には主に3つのパターンがあるこれらのパターンから選ぶと、文章を考えやすくなる

Slide 73

Slide 73 text

言いたいことの理由を述べる業務でスマートフォンを活用することは生産性の向上につながります。スマートフォンを使うことで、移動中や外出先での空き時間を利用して業務を進めることが可能になります。たとえば、出勤時の電車の中でメールを読んでおけば、忙しい朝の時間を節約でき、またちょっとした返信もその場で済ませることができます。外出先で報告書を作成して提出すれば、報告書を作成しにわざわざオフィスに戻ることも不要になります。読み手の「なぜ？」に対して、「なぜなら...」、「そうずれば...」、「そうしないと...」と答えていく言いたいことその理由

Slide 74

Slide 74 text

言いたいことの説明を述べるスマートフォンは、携帯電話とパソコンの機能を併せ持つ携帯機器です。通話したり、メッセージを送ったりといった電話としての機能だけでなく、インターネットで情報を得たり、音楽や動画を楽しんだり、撮った写真や動画を加工してインターネットで共有したりと、まるで小さなパソコンとも言えるさまざまな機能を持ちます。さらに、パソコンと同じように、「アプリ」と呼ばれるアプリケーションソフトウェアを入れて機能を追加することもできます。読み手の「どういうこと？」に対して、「つまり...」、「要するに...」、「言い換えると...」と答えていく言いたいことその詳細の説明

Slide 75

Slide 75 text

言いたいことの理由を述べるスマートフォンは写真や動画の撮影機器としても広く使用されています。多くのスマートフォンは高性能なカメラを備えていて、日常生活や旅行先などで手軽に美しい写真や動画を撮影できます。そして、撮った写真をスマートフォンを使ってその場で加工したり、友人に共有したり、ソーシャルメディアに投稿したりすることも、撮影の楽しみ方の一つになっています。読み手の「そうなの？」に対して、「たとえば...」、「具体的には...」と答えていく言いたいことその具体例

Slide 76

Slide 76 text

パラグラフを展開する公開チャット機能のマニュアルのアウトライン ● 匿名で誰でも楽しめるチャットルーム ● 管理者ができること ● 公開チャットはこんなときに使える ○ 共通の趣味や興味を持つ人たちと話す ○ 地域のコミュニティーで情報交換する ○ イベントや活動を計画する ● 公開チャットの使い方 ○ チャットルームに参加する ○ ニックネームとアイコンを設定する ○ チャットルームを作成する ○ 【管理者のみ】参加者を管理する ○ 【管理者のみ】メッセージを削除する ○ 【管理者のみ】チャットルームを削除するこの見出しの中を書いてみよう

Slide 77

Slide 77 text

1. 各パラグラフで言いたいことを書くいきなり文章を書こうとすると難しい。まずは各パラグラフで言いたいことだけを 1文で書く 2. 話の流れを確認するそれぞれの「言いたいこと」が話の筋としてつながっていることを確認する 3. 言いたいことの理由や説明を書き足す各パラグラフで「言いたいこと」への理解を支える「理由や説明」を書き足していく文章を効率良く書くステップ

Slide 78

Slide 78 text

Step1 各パラグラフで言いたいことを書く見出し：匿名で誰でも楽しめるチャットルーム公開チャットは、匿名で誰でも楽しめるチャットルームです。匿名で誰でも楽しめるチャットルームチャットルームに参加する機能ニックネームとアイコンを設定する機能チャットルームを作成する機能まずは見出しの中で言いたいことをズバリと言う

Slide 79

Slide 79 text

Step1 各パラグラフで言いたいことを書く匿名で誰でも楽しめるチャットルームチャットルームに参加する機能ニックネームとアイコンを設定する機能チャットルームを作成する機能見出し：匿名で誰でも楽しめるチャットルーム公開チャットは、匿名で誰でも楽しめるチャットルームです。公開チャットのチャットルームには自由に参加できます。プライバシーも保ちながら匿名で気軽にチャットルームに参加できることも、公開チャットの特長です。さらに、自分でチャットルームを作成することもできます。続いて、テーマを分解した話題に沿って各パラグラフで言いたいことを書いていく

Slide 80

Slide 80 text

Step2 話の流れを確認する見出し：匿名で誰でも楽しめるチャットルーム公開チャットは、匿名で誰でも楽しめるチャットルームです。公開チャットのチャットルームには自由に参加できます。プライバシーも保ちながら匿名で気軽にチャットルームに参加できることも、公開チャットの特長です。さらに、自分でチャットルームを作成することもできます。各パラグラフで言いたいことが見出しに結び付いていることを確認する

Slide 81

Slide 81 text

Step3 言いたいことの理由や説明を書き足す見出し：匿名で誰でも楽しめるチャットルーム公開チャットは、匿名で誰でも楽しめるチャットルームです。趣味や興味などをテーマにしたさまざまなチャットルームがあり、匿名で自由に参加できます。また、自分でテーマを決めてチャットルームを作ることもできます。 1つめのパラグラフでは全体像（後続するパラグラフの3つの話題）をそれぞれ述べる匿名で誰でも楽しめるチャットルーム自由にルームに参加できる匿名でルームに参加できる自由にルームを作成できる説明を述べる 1つめのパラグラフの文章

Slide 82

Slide 82 text

Step3 言いたいことの理由や説明を書き足す公開チャットのチャットルームには自由に参加できます。カテゴリーから選んだり、キーワードかで検索したりして、自分の興味に合ったチャットルームを見つけられます。また、参加者からの招待を受けて特定のチャットルームに参加することもできます。どのように自由に参加できるのかを具体例を挙げて説明する 2つめのパラグラフの文章チャットルームに自由に参加できるカテゴリーから参加する検索して参加する招待を受けて参加する具体例を挙げる

Slide 83

Slide 83 text

Step3 言いたいことの理由や説明を書き足すプライバシーを保ちながら匿名で気軽にチャットルームに参加できることも、公開チャットの特長です。公開チャットに参加するときには、プロフィールの名前とは異なるニックネームやアイコンを設定できます。ほかの参加者に本名やプロフィールが公開されることはありません。なぜプライバシーを保てるのかを理由を挙げて説明する 3つめのパラグラフの文章プライバシーを保ちながら参加できるニックネームとアイコンを設定できる本名やプロフィールは非公開理由を挙げる

Slide 84

Slide 84 text

Step3 言いたいことの理由や説明を書き足すさらに、自分でチャットルームを作成することもできます。ルームの名前、説明、カバー画像などを設定し、ルームのテーマや雰囲気に合わせて見た目をカスタマイズできます。また、参加ルールやガイドラインを設けることも可能です。これらの設定は、あとからいつでも変更できます。どのようにチャットルームを作成できるのかの詳細を説明する 4つめのパラグラフの文章自分でチャットルームを作成できるルームに設定できること設定はあとから変更できること説明を述べる

Slide 85

Slide 85 text

文章が完成匿名で誰でも楽しめるチャットルーム公開チャットは、匿名で誰でも楽しめるチャットルームです。趣味や興味などをテーマにしたさまざまなチャットルームがあり、匿名で自由に参加できます。また、自分でテーマを決めてチャットルームを作ることもできます。公開チャットのチャットルームには自由に参加できます。カテゴリーから選んだり、キーワードかで検索したりして、自分の興味に合ったチャットルームを見つけられます。また、参加者からの招待を受けて特定のチャットルームに参加することもできます。プライバシーを保ちながら匿名で気軽にチャットルームに参加できることも、公開チャットの特長です。公開チャットに参加するときには、プロフィールの名前とは異なるニックネームやアイコンを設定できます。ほかの参加者に本名やプロフィールが公開されることはありません。さらに、自分でチャットルームを作成することもできます。ルームの名前、説明、カバー画像などを設定し、ルームのテーマや雰囲気に合わせて見た目をカスタマイズできます。また、参加ルールやガイドラインを設けることも可能です。これらの設定は、あとからいつでも変更できます。

Slide 86

Slide 86 text

まとめ ● わかりやすいドキュメントを効率良く書くために、ドキュメントの設計が大切 ● そのために、ドキュメントのテーマを分解して整理し、ドキュメントの構成に落とし込む ● テーマはWhy（なぜ）・What（何を）・How（どうやって）の3つに分解できる ● 見出しは「本文に何が書かれているか」・「本文で何を言いたいか」を具体的に伝えるものにする ● テーマを分解した要素に沿って文章を組み立てることで、話しの筋が通り、論理立った文章になる本セッションや書籍の感想を是非SNSでシェアいただけると嬉しいです！