テクニカルライティング_Udemy_受講生用

新人エンジニアのための テクニカルライティング 報告・連絡・相談・日報を、5秒で伝わる文章にする 受講生用｜全8STEP・約108分 うさうさ研修工房

学習ロードマップ：少しずつ坂をのぼる 1 なぜ書き方で伝わり方が 変わる？ 2 基本の型：PREPと3原則 3 事実と意見を分ける・数字 で書く 4 文書の型と構造：報告・連 絡 5 仮説入り相談とサポート依 頼 6 進捗報告と日報 7 山場：場面判断と書き直し 演習 8 仕上げ：セルフチェックと次 の一歩 うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

STEP1｜なぜ書き方で伝わり方が変わる？ STEP 学ぶこと 1 • 伝わらない原因は、内容より「順番」と「書き方」にある • よくある4つの原因を知る • Before→Afterで、差を体感する 難易度 1 / 9 やってみよう 動画の目安：約8分 最近書いた報告を1つ選び、4つの原因に当てはまるか確認する できたかな？ 伝わらない4つの原因を説明できる うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

伝わらない4つの理由 1 結論が最後に来ている 上司が途中で読むのをやめると、要点が伝わらない 3 してほしいことが書かれていない 承認なのか、確認だけなのかが分からない 2 事実と推測が混ざっている 確認できることと、思っていることの区別がつかない 4 曖昧な言葉が入っている 「すぐ」「かなり」「だいたい」は、数字の代わりにならない 内容が足りないのではなく、「順番」と「書き方」の問題です うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

Before → After：同じ内容でも、伝わり方が違う Bad（冗長・分かりにくい） Good（論理的・端的） 昨日テストを行ったところ、ちょっとエラーが多く出てしま い、原因を調べてみたら以前の変更が影響しているようで した。工数は少しかかりますが、しっかり直したほうがいい と思うので修正の許可をいただけますでしょうか。 【件名：◯◯テスト不具合に伴う修正作業の承認依頼】 昨日のテストにてエラーが15件発生いたしました。原因は 前回仕様変更による処理干渉です。 根本修正のため2人日の追加工数を頂戴したく存じます。 本日17時までのご承認をお願いいたします。 Goodで増えた4つ 件数（15件） 原因（仕様変更の干渉） うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用） 依頼（2人日の承認） 期限（本日17時）

STEP2｜基本の型：PREPと3原則 STEP 学ぶこと 2 • PREP法：結論→理由→事実・具体例→まとめ・依頼 • 3原則：結論ファースト／数字で書く／5秒で全体像 • 冒頭3行で、結論と依頼が分かるようにする 難易度 2〜3 / 9 やってみよう 動画の目安：約10分 最近の報告をPREPの順に並べ替える できたかな？ 冒頭3行で、結論と依頼を書ける うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

PREP法：結論から書く4ステップ 順番 内容 書き出しの例 P：Point 結論 「〇〇の承認をお願いします」 R：Reason 理由 「理由は2点あります」 E：Example 事実・具体例 「具体的には、〇月〇日のテストで〜」 P：Point まとめ・依頼 「本日17時までにご判断をお願いします」 最初の1〜2行で、結論と依頼が分かるように書く。途中で読むのをやめられても、要点が伝わります。 うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

テクニカルライティングの3原則 1 結論ファースト 結論・判断・次のアクションを、最初 の1〜2行に書く 2 数字で書く（主観を排除） 「すぐに」ではなく「15分以内」。具体 的な数字と事実で示す 3 5秒で全体像（スキャナビ リティ） 見出し・箇条書き・太字で、パッと見 て分かるようにする ※ ISO 20607・ISO 82079-1は、取扱説明書など利用者向け情報の作り方の規格です。「正確・明確・簡潔・論理的」という考え方を、報告に応用し ています。報告書そのものを規定する規格ではありません。 うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

STEP3｜事実と意見を分ける・数字で書く STEP 学ぶこと 3 • 事実は確認できるもの、意見は推測と提案 • 「すぐ」「かなり」「だいたい」は数字に置き換える • 【事実】【意見】のラベルで見分けやすくする 難易度 4 / 9 やってみよう 動画の目安：約12分 ワークブックの曖昧な文5つを、数字入りに書き換える できたかな？ 事実と意見を分けて書け、曖昧語を数字にできる うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

事実（Fact）と意見（Opinion）を分ける 事実（Fact） 意見（Opinion） 確認できるもの：日時・数値・ログ 例：ログに接続エラーが15件発生している 原因の推測や提案 例：メモリ不足が原因と思われる ❌ 「設定ミスだと思います」 ⭕ 「【事実】接続エラーが15件発生。【意見】設定の記述ミスの可能性が高いと考えています」 うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

曖昧な言葉を、数字に置き換える 曖昧（避ける） 明確（推奨） すぐに対応します 本日17:00までに対応します かなり遅い 処理時間が従来の2.5倍（15秒）です だいたい完了 テストケース10件中8件完了（進捗率80%） 特になし 予定どおり進行しており、阻害要因はありません ごくまれに発生する 1,000回に1回の頻度で発生する（発生率0.1%） うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

STEP4｜文書の型と構造：報告・連絡 STEP 学ぶこと 4 • 報告と連絡の型（結論→事実→予定／内容→影響→依頼） • 見出し記号と階層は、最大3〜4階層まで • 順序があれば数字リスト、なければ記号 難易度 5 / 9 やってみよう 動画の目安：約15分 実際の案件を1つ選び、型に沿って報告か連絡を書く できたかな？ 5秒で全体像が分かる文書を、型から書ける うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

報告と連絡の型 報告（結果・状況を伝える） 【報告】〇〇について ■ 結論 最も伝えたい結果・ステータス ■ 事実 いつ／どこで／何が起きたか・数値 ■ 今後の予定 次に何をするか タグ【 】で種類を示し、■ で区切る。依頼の有無は必ず書く。 うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用） 連絡（情報を共有する） 【共有/連絡】〇〇 ■ 内容 伝えたい情報（短く） ■ 影響・注意点 相手に関係する変更点 ■ 対応お願い（ある場合のみ） 返信不要なら「確認のみで返信不要です」

見出し・階層・番号の使い方 階層 表記 使う目的 例 第1階層 ■ 大見出し ■ 1. 概要 第2階層 ◆ 中見出し ◆ 1.1 発生要因 第3階層 (1) 小見出し (1) パラメータ設定ミス 第4階層 ・ 箇条書き ・設定値が規定の2倍 順序がある → 数字リスト 順序がない → 記号「・」 手順・実行順・優先順位。手順は動詞で終える。 並列の情報。語尾（体言止め・動詞止め）を揃える。 うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

なぜ効く？ 認知科学の根拠（資料の見せ方にも使える） 1 作業記憶は約4個（Cowan, 2001） → 1画面・1スライドの要点は3〜4個に絞る 3 近いもの・囲んだものはグループに見える（ゲシュタ ルト心理学） → 関連情報は近づけて、枠で囲む 関連：認知負荷理論（Sweller, 1988）。出典はスライド最後の参考文献を参照。 うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用） 2 色・大きさの違いは瞬時に処理（Treisman & Gelade, 1980） → 強調色は1色だけにする 4 視線はF型・Z型に動く（Nielsen, 2006） → 結論は左上に置く

STEP5｜仮説入り相談とサポート依頼 STEP 学ぶこと 5 • 相談は「課題→仮説→依頼」の3ステップ • 確信度に合わせて、言い方を変える • サポート依頼は、試したことをセットで書く 難易度 6 / 9 やってみよう 動画の目安：約15分 最近困ったことを、仮説入りの相談に書き直す できたかな？ 丸投げせず、仮説と依頼を添えて相談できる うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

仮説入りの相談：3ステップ 1 課題 2 Fact 何が起きているか 事実・数値・エラー 仮説 Opinion 原因は何で、どう対応すべきと考える か（理由つき） 3 依頼 Action どうしてほしいか いつまでに判断してほしいか 口頭の例 「〇〇さん、3分ほどご相談いいですか？決済APIのレスポンス遅延について判断をいただきたいです。処理に2.8秒かかっていて、ログを見 る限りDBのインデックス不足が原因だと考えています。インデックス追加（工数0.5日）で進めたいのですが、本日着手してよろしいでしょう か？」 うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

確信度に合わせた言い方 自信の度合い ❌ 頼りない言い方 ⭕ ロジカルでマイルドな言い方 高（ほぼ確定） 「たぶん〇〇だと思います」 「〜のデータから見て、〇〇が要因である可能性が高いと考えています」 中（五分五分） 「よく分からないですが〇〇かも」 「仮説段階ではありますが、〇〇が影響していると推測しています」 低（自信なし） 「どうすればいいですか？」 「いくつか調べた結果、〇〇か〇〇が原因だと見立てていますが、ご意 見伺えますか？」 サポート依頼では、「どこまで自分でやったか（試したこと）」を必ずセットで書く うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

STEP6｜進捗報告と日報 STEP 学ぶこと 6 • 信号機（順調・やや遅れ・ブロック）で状況を見せる • 順調な日の型Aと、遅れ・トラブルの型B • 時間帯別に、報告する内容を変える 難易度 7 / 9 やってみよう 動画の目安：約15分 昨日の日報を、型AかBで書き直す できたかな？ 件名と1行目だけで、状況が伝わる日報を書ける うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

日報：型Aと型B 順調（確認のみでOK） やや遅れ・相談あり（要確認） 型A：順調な日（約3分） 件名：【日報】10/21 氏名（順調） ■ 本日の成果（Fact） ・〇〇機能の実装：100%完了（15/15件） ■ 明日の予定（Plan） ・結合テスト（15:00完了予定） ■ 所感（Opinion） ・予定どおり進行中 うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用） ブロック・障害（要緊急対応） 型B：遅れ・トラブル（約5分） 件名：【日報・判断依頼】10/21 氏名（やや遅れ） ■ 上司へのお願い（1行目） ・明日の朝会でA案かB案かを1分ご判断いただきたい ■ 本日の状況（Fact） ■ 対策案（Opinion） ・A案（推奨）／B案（暫定）

時間帯別：何を報告する？ 時間帯 メインテーマ 最優先で伝えること NGな行動 朝 予定・予告 今日何をするか／何時に相談するか 突然、長時間の相談を持ち込む 午前 中間進捗 予定どおりか、ズレが出ているか 遅れているのに黙って昼休みに入る 午後 ブロック解消 自力で解決できない壁／判断依頼 1時間以上、一人で悩み続ける 夜 成果・明日 今日やったこと（数字）／明日の朝イチ 感想ばかりで、実績が書いていない うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

STEP7｜★ 山場：場面判断と書き直し演習 STEP 学ぶこと 7 • 口頭か文章かを、場面で選ぶ • JiraとチャットのURLを、迷わせずに添える • 場面に合わせて、型を選んで書く 難易度 9 / 9 やってみよう 動画の目安：約25分 ★ 山場 3つの場面で媒体と型を選び、悪い例を書き直す できたかな？ ★1 媒体の選択を理由つきで説明できた ★2 悪い例を、結論・数字・期限入りで書き直 せた うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

口頭か文章か：場面で選ぶ 場面 口頭（会話・Web会議） 文章（チャット・Jira） 報告 緊急の障害（第一報） 日々の進捗、数値やエビデンスを残す時 相談 選択肢が未定／複雑な事情 A案・B案が揃い、選ぶだけの時 サポート 画面共有のほうが早い時 ログやエラーなど、正確なテキストが必要な時 連絡 念押ししたい時 日程・仕様・手順など、後で見返す情報 口頭で決めたら、チャットに1行：「先ほど口頭で合意いただいた通り、A案で進めます」 うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

JiraとチャットのURLの添え方 1 2 URLだけを投げない 「何のURLか」と「どうしてほしいか」を 添える 決定事項をJiraにも書き戻 す チャットで合意した内容を、チケットのコ メントにも残す 例 【レビュー依頼】〇〇機能の修正が完了しました ■ 関連URL ・Jiraチケット：（URL） ・Pull Request：（URL） ・STG検証環境：（URL） 本日18:00頃までにご確認いただけると助かります うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用） 3 関連URLを箇条書きにする Jira・PR・ログ・デザインをまとめて貼る

★ 書き直し演習：悪い例を直そう 悪い例（チャット） 模範例（書いてから見よう） Docker環境構築でちょっとエラーが出て、いろいろ試したんで すがダメでした。手伝ってほしいです。 【サポート依頼】Docker環境構築のエラーについて ■ お願いしたいこと 画面共有で15分ほど、ログを一緒に見ていただけないでしょう か。 ■ 状況（事実） ・docker-compose up 時に、DB接続エラー（Connection refused）が発生 ■ 試したこと ・.env のポート確認：異常なし ・コンテナの再生成：改善せず ■ 期限 本日中でご都合のよい時間を教えてください。 直すときの4つの視点 1. 結論と依頼を冒頭に 2. 事実（エラー内容）と、試したこと 3. 数字（所要時間・回数） 4. 期限 うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

STEP8｜仕上げ：セルフチェックと次の一歩 STEP 学ぶこと 8 • 提出前の10秒セルフチェック • 今日の型を、自分のテンプレとして保存する • 職場に独自のルールがあれば、そちらを優先する 難易度 3 / 9 やってみよう 動画の目安：約8分 明日出す報告を1つ、型に沿って書く できたかな？ 5項目の修了チェックで振り返れる うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

提出前のセルフチェック（10秒） 冒頭3行で、結論と依頼が分かるか 期限と担当が書かれているか 「すぐ」「かなり」「だいたい」が残っていないか 事実と意見が分かれているか 1文が長すぎないか（目安：40〜60文字） URLには、「何のURLか」のラベルを付けたか ※ 40〜60文字は、読みやすさのための実務上の目安です。職場に独自のルールがある場合は、そちらを優先してください。 うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

修了チェックリスト（5項目） 冒頭3行で、結論と依頼を書ける 事実と意見を分けて書ける 曖昧な言葉を、数字に置き換えられる 仮説を添えて、相談できる 場面に合わせて口頭か文章を選び、期限と依頼を明記できる 次の一歩：明日出す報告を1つ、今日の型で書いてみましょう。 うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）

参考文献・出典 区分 出典 規格 ISO 20607（機械類の安全性－取扱説明書の作成原則）／ISO/IEC 82079-1（使用者向け情報の作成） 認知負荷 Sweller, J. (1988). Cognitive load during problem solving. Cognitive Science, 12(2) 作業記憶 Cowan, N. (2001). The magical number 4 in short-term memory. Behavioral and Brain Sciences, 24(1) 視覚的注意 Treisman, A. & Gelade, G. (1980). A feature-integration theory of attention. Cognitive Psychology, 12(1) 視線の動き Nielsen, J. (2006). F-Shaped Pattern For Reading Web Content. Nielsen Norman Group データ可視化 Tufte, E. (1983). The Visual Display of Quantitative Information 報告・相談・日報の型は、実務で使いやすいよう整理したテンプレートです。 うさうさ研修工房 | 新人エンジニアのためのテクニカルライティング（受講生用）