エンジニアのためのドキュメント力基礎講座〜構造化思考から始めよう〜（2025/02/15jbug広島#15発表資料）

https://jbug.connpass.com/event/342193/
「jbug広島#15 「ド。」～文書の運用について～」にて発表した資料です。

Transcript

1. エンジニアのための ドキュメント力養成講座 ～構造化思考から始めよう～ 2025年2月 ver1.4 ＡＲアドバンストテクノロジ株式会社 中野ヤスオ（@yasuoyasuo） jbug広島#15 「ド。」～文書の運用について～
2. ただいま！JBUG広島 JBUGマンとAgileマンで迎えたオープニングの様子 https://backlog.com/ja/blog/2101-jbug-hiroshima-online/
3. 今日のきっかけ 3 お声がけ ありがとうございます！
4. 自己紹介 4 中野ヤスオ（50） @yasuoyasuo ＡＲアドバンストテクノロジ株式会社（ARI） 取締役 専務執行役員 BacklogWorld芸人（2020～） ➢ 略歴 1999 ITエンジニア＆コンサルタント（10年） 2009 Webサービス企画＆開発管理（2年） 2011 マネジメントコーチとして独立（1.5年） 2012 現職へジョイン ➢ 趣味 食べ歩き、筋トレ、LEGO ➢ 最近はまっていること 昭和平成の名作巡り（北の国から、白い巨塔 等）
5. エンジニアとして必要な ドキュメンテーション力とは？ 今日のテーマ 5 元々若手向けの研修メニューであるため 経験ある皆さまにはやや釈迦に説法感がある旨 ご了承ください
6. そもそもエンジニアにとってドキュメント力って必要？ 6 →これからますます重要になると思う
7. プロジェクト工数の7割はドキュメント作成 7 引用： » 2019年度調査『ソフトウェアメトリックス調査2020 システム開発・保守調査』の報告資料 JUAS 一般社団法人 日本情報システムユーザー協会 https://juas.or.jp/news/topics/2823/ 実はシステム開発で プログラミングなど実装は 約 3割しかない
8. ドキュメント作成力は資産価値が高い 画像引用： https://www.missiondrivenbrand.jp/entry/thinking__Structured 8
9. 先日のデブサミでのセッションでも 9 引用：https://speakerdeck.com/kotomin_m/developerssummit2025
10. アジャイル時代は ドキュメントは書かなくて良い ドキュメントの必要性重要性は色褪せない 合意形成や情報共有のために ドキュメントは一定数必要 10
11. 今後AI駆動が広がれば更に重要に 11 設計 実装 テスト リリース AI Suite 選択・設計 品質・効果 レビュー 効果測定 方法の設計 非機能 テスト 効果検証 ドメイン知識 ペインポイント の理解 ビジネス効果の 設計 ユーザー体験の 設計 非機能の明確化 効果の明確化 要求分析 要件定義 AI駆動開発ツール(Cursol, WindSurf, GitHub Copilot Workspace, Devin etc) ライフサイクルの継続的な アップデート 人の領域 AIの領域 参考：https://www.creationline.com/tech-blog/chatgpt-ai/ai/71718
12. 今日のアジェンダ • ドキュメント作成に求められるスキル • 構造化思考とは？ • 構造化思考の説明と演習 • 構造化思考を効率的に進めるために • 構造化思考を踏まえたアプローチ • その他のスキル • 最後に 12
13. ドキュメント作成に求められるスキル 13
14. システム開発系ドキュメントの特徴 • 自分以外の誰かが読み、更新されることが前提とされる ➢ レビュワー ➢ 後工程の担当者 ➢ 保守担当者 ➢ AI（←2021年からの変更点） • 抜け漏れや、読み手によって解釈が異なることは許されない ➢ 検討すべきことの抜け漏れは手戻り（工数増）につながる ➢ 解釈が異なる記述をしてしまった場合も同様 • 納期があり生産性が求められる ➢ 書き手が納得いくまで時間をかけて良いわけではない ➢ 事前に作成工数の見積りが求められる 14
15. システム開発系ドキュメントに求められること • 当たり前品質をクリアしていること ➢ 誤字脱字、最低限の体裁、表記の統一 ➢ 書くべき項目がすべて書かれている ➢ 内容が正確 • 読み手（特にAI！）にわかりやすいこと ➢ 全体構成、見出しの粒度、順序が適切 ➢ 各文章がわかりやすい ➢ 体裁が適切に「デザイン」されていること（タイトル、表紙、インデント、ページ番号など） • 生産性や作業管理性が高いこと ➢ 標準化され一定のルールがある方が書きやすく、レビューもしやすい ➢ 作成にかかるタスクが分解できている（見積りの精度が上がる） ➢ 完了までの段取りが出来ている（アウトライン化） 15
16. そもそもシステム開発とは どういった行為なのか？ まずその本質を理解することから はじめたい 効果的なドキュメンテーション力を得るために 16
17. シ ス テ ム 開 発 の 時 間 軸 システム開発の大きな流れ 要件 人間の 世界 システムの 世界 設計 実装（ソフトウェア/基盤） 要求 要望 仕様 要件 1.要望要求から要件に選別する 2.要件に対する仕様を記述する 3.仕様を満たすように設計する 4.設計通りに実装する 5.仕様＆要件の実現を確認する 17
18. シ ス テ ム 開 発 の 時 間 軸 要件は仕様化されなければ実現できない 要件 人間の 世界 システムの 世界 氏名を表示できたらいいな その他多くの要望 各ページに氏名を表示できること 各ページのヘッダ部分に 「◦◦[半角スペース]••」と表示する。 ◦◦は姓、••は名を表す。 ユーザー内 整理 QCD制約踏まえた 要求精査 各ページに氏名を表示したい 網羅的かつ 誤解を与えない 言語化 仕様の網羅的かつ誤解なき言語化が システム開発の最初の勘所 設計 実装（コード） 要求 要望 仕様 要件 • あったらいいなだよね？目的は？本当に必要？ • 個人の意見？みんなの意見？ • 要求の優先順位は？ • 予算や納期踏まえて今回どれやる？ • ページのどこ？ • どんな風に表示するの？ 参考： https://qiita.com/digdagdag/items/2808205d89344ab8a3a1 イメージ 18
19. システム開発ドキュメントの勘所 網羅的かつ 誤解なき言語化 19
20. 効果的なドキュメント作成に必要なスキル知識 構造化思考力 作文/表現技術 記述対象に 関する知識 特にここが ポイント！ 20
21. ユーザー向けドキュメントについてはどうか？ 21 エンジニアのためのドキュメントライティング / Docs for Developers and Paragraph Writing https://speakerdeck.com/nttcom/docs-for-developers-and-paragraph-writing
22. ドキュメントジャーニーは読み手理解から 22 エンジニアのためのドキュメントライティング / Docs for Developers and Paragraph Writing https://speakerdeck.com/nttcom/docs-for-developers-and-paragraph-writing
23. 読み手理解と計画立てから始めることを推奨 23 構造化思考が肝になる
24. 今回は構造化思考に 絞ってお話します 24
25. 構造化思考とは？ 25
26. 構造化思考とは？ 全体を分解したり 個別を集約することで 情報を整理する考え方 注：私の定義 26
27. 構造化思考 ２つのアプローチ １．全体を分解する ２．個別を集約する 大きなテーマを分解して整理する 思考の補助線を引き情報を整理する 画像引用： https://www.missiondrivenbrand.jp/entry/thinking__Structured どっちも大切 27
28. 構造化されている例 資料間の関係 ➢ 画面一覧と画面設計書 ➢ 機能一覧と各機能設計書 ➢ システム構成一覧と構成別パ ラメータシート ➢ 移行全体スケジュールと各移行 作業詳細手順書 ➢ 共通仕様書と各個別仕様書 各資料内の目次構成 例：要件定義書 1. システム導入の目的と目標 2. システムの概要／システムの構想 3. システム導入後の業務フロー 4. 機能要求 5. 入力要求と出力要求 6. 品質・性能要求 7. セキュリティ要求 重複を避ける 漏れ重複ない章立て （一般例） 28
29. 構造化することのメリット（１） 画像引用： https://www.missiondrivenbrand.jp/entry/thinking__Structured ドキュメントを作る上で最も避けるべき「漏れとダブリ」をなくせる 29
30. 構造化することのメリット（２） 枠組みが共有できると 読み手に伝わりやすい なぜか？ 画像引用： https://www.missiondrivenbrand.jp/entry/thinking__Structured 30
31. 情報＝枠組み＋内容 情報を伝えるときは、枠組みと内容を分けて考えると効果的。 枠組みが共有できると内容だけに集中できる。 枠組み 内容 情報 前提事項 仕様 進め方 イメージ 画像引用：https://www.itmedia.co.jp/bizid/articles/1009/21/news058.html 31
32. 構造化のポイント 分かる＝分ける 32
33. 構造化の上手下手はどこで決まるか？ 1. 漏れダブリをなくす 2. 粒感を揃える 3. 順序を整える 33
34. これを気持ち悪いと思えるか？ 春、夏、冬 野菜、肉、サンマ 昭和、平成、大正、令和 34
35. 枠組みの力を借りて情報伝達の精度を上げる 春、夏、秋、冬 野菜、肉、魚（サンマ） 大正、昭和、平成、令和 35
36. これらへの感度を上げよう 1. 漏れダブリをなくす 2. 粒感を揃える 3. 順序を整える 全体→詳細、時系列、大→小、頻出→レア、正常→異常 など 36
37. 構造化思考のポイント 文字列は何を伝えているのか？ 37
38. それぞれに意味がある 春、夏、秋、冬 野菜、肉、魚（サンマ） 大正、昭和、平成、令和 38 季節 食材 年号
39. こういう問題昔やりましたよね？ 問題：□に入るものを答えよ Q1：１, 2, 4, 8, □, 32, 64 Q2：J, F, M, A, M, □, J, A,・・・ 39 この問題の本質は、各Qの主題を探すことにいる
40. 構造化思考のポイント ある問題に対して答を見つけるために 考えるべきことを論点という 40
41. 今日の最重要ワード 論点 41
42. 論点とは その問いに答えるためには 何を考えるべきなのか？ どんなことを答えるべきなのか？ 42
43. 目次とはその資料の論点である 各資料内の目次構成 例：要件定義書 1. システム導入の目的と目標 2. システムの概要／システムの構想 3. システム導入後の業務フロー 4. 機能要求 5. 入力要求と出力要求 6. 品質・性能要求 7. セキュリティ要求 漏れ重複ない章立て （一般例） 43 要件定義書の論点 つまり 何を書けば 要件が定義できたと 言えるのか？
44. アインシュタインの言葉 「もし自分が死にそうな状況で、 助かる方法を考えるのに１時 間あるとしたら、最初の55分 は適切な質問を探すのに費や すだろう」 44 画像：https://honcierge.jp/articles/shelf_story/1521
45. 何かを考え、表現するときのコツ 何を伝えるべきなのか？（主題） ↓ それを伝えるためには 何を示せればよいのか？（論点） ↓ その内容 45 主題 論点1 論点2 論点X 内容1 内容2 内容X いきなり答を考えようとしない ・・・ ・・・
46. 構造化思考の演習 46
47. 構造化思考の演習 実際にやってみましょう 47
48. 構造化演習（１） 部門の飲み会の幹事を引き受けました。 参加数を最大化させられる案内文を考えたいです。 どんな項目が含まれているとよいですか？ 48
49. 構造化演習（１）考え方 目的：参加率を最大化するには？ →何を考えるべきかを考えるアプローチが大切。 ＜論点、切り口、アプローチ例＞ └周知先を最大化する └申込数を最大化する └イベントの魅力を高める └予算を適切にする └会場を気をつける └日程に配慮する └日程は選択型にして一番多い日を選ぶ └キャンセル数を最小化する 49
50. 構造化演習（２） プロジェクトの振返りの意見を集めたいと思います。 依頼フォームを検討してください。 50
51. 構造化演習（2）考え方 ▪ 振返りで起こりがちな問題 ・誰のための振返り？ ・後半のことばかりに気になってしまい前半のことが抜け落ちる →PJ全体を見て重要なことがカバーできているか？ ・その場限り、いきあたりばったり。振り返ったあとに何か得るものがあるか？ ・振り返った時に日本は自己評価が低い、北米ではいいところを観てくれる いいところも観てあげるべき。犯人さがしはNG ▪振返りの目的は？ 顧客との振返りであれば次の営業機会を探る場 プロジェクトの品質を今後あげていく 品質の良かった部分、プロセスをかき集める 合意形成とか 目的を「具体的改善活動につなげる」としたら何が論点になるか？ 何がだめだったか？ 組織として 個人として 51
52. 演習のポイント いきなり項目を挙げはじめるのはNG 目的を果たすために 何を考えればよいかを考える （目的が指示されてなければ仮説を立てる） 52
53. 構造化思考を効率的に進めるために 53
54. 先輩達は考えた 汎用的な事柄を考え表現するのに 毎回論点から考えるのは 非効率だし品質もばらつく 54
55. そこで生まれたのが 主題と論点及びその表現方法などの 組み合わせ一式を フレームワーク/テンプレートという 55
56. いろいろあるので調べてみよう ただ過剰に頼りすぎると 思考が縛られることもあるので注意 56 フレームワークやテンプレートはあくまでも 主題を得るための論点の１つの形でしかない。 背景や文脈にのっとってテーラリング（応用）できる力が必要 フレームワークやテンプレートは 初心者には極めて効果的な手法
57. フレームワークの活用事例～振返り～ 57 » コミュニケーションの方向に着目したふりかえりの方法 - よこなのへたのよこずき https://ihcomega.hatenadiary.com/entry/2020/04/28/055258 • 「KPT （Keep/Probrem/Try） 法」でやっていた • でも過去振り返りの時間が足りなくなることが頻発 • 議論しなくてもよいことは議論しなくてもいいのでは？ • チーム(または個人) で続けたいこと • 自分 がドヤりたいこと • チームメンバー にお礼したいこと フレームワークを使うことがゴールにならないように 結果や得たい成果を常に忘れないようにしたい
58. 生成AIの活用 58 1. 次期基幹システムの方針 2. ARIの対応可能範囲 3. ERP導入の考え方 4. 過去の支援事例 5. 現在の進捗 6. 基幹システムの対象領域 7. プロジェクト体制 8. 過去の検討内容 9. システム刷新の進め方 求める論点について 出力してくれる 論点を出せる/評価できれば 生成AIをより有効に使いこなせる 悪くないけど 最適かは 状況次第 （確率論）
59. 構造化を踏まえたドキュメント作成アプローチ 59
60. 良いドキュメントを書くには？ 1. そのドキュメントの読み手と主題を 正しく把握する （誰のどんな問題を解決する資料なのか？） 2. その主題の論点を考える 3. 各論点について回答を深堀りし 適切に言語化/図式化する 4. 見た目を最適化する 60
61. 仕事の進め方にもつながる構造化思考 タスク←ゴール アウトラインから考える 61
62. そのドキュメントの目的は明確か？ なんとなくの積み上げ ≠目的達成 62
63. ドキュメント作業に入るその前に ターゲットとなる読み手 目的や得たい成果 アプローチや論点 上司/依頼者と確認できているか？ 63
64. とりあえずまこなり社長の動画を見よう 64 https://www.youtube.com/watch?v=ArMNB_QTSXw
65. その他のスキルについて 65
66. 良いドキュメントを書くには？ 1. そのドキュメントの読み手と主題を 正しく把握する （誰のどんな問題を解決する資料なのか？） 2. その主題の論点を考える 3. 各論点について回答を深堀りし 適切に言語化/図式化する 4. 見た目を最適化する 66 ★ 構 造 化 思 考 ★ 作 文 表 現 技 術
67. 今日の内容を改めて体系化して学びたい方 67 この本を 激しく推薦します！
68. 作文技術やPJ知識もめちゃくちゃ大切 参考図書やリンク集 こちら参考になれば 68 https://qiita.com/yasuoyasuo/items/1eb7298f91a44dce7abc
69. 作文技術を学ぶ上で激しくおすすめの資料 69 https://speakerdeck.com/namura/shui-gadoujian-temosoutosikashou-kequ-renaiwen-shu-shu-gong-kai-ban
70. こちらも良ければ読んでみて 70 • 用語は文書内で一貫性をもたせる • 曖昧な代名詞の利用は避ける • 受動態は避け、能動態を優先する • 強い動詞を選択する1 • 曖昧な動詞よりも意味が限定される動詞を選ぶ • 1文1メッセージ • 長い文章はリスト形式に変換する • 不要な言葉は排除する • 順序が重要な場合は番号付きリストを使用し、順序 が重要でない場合は箇条書きリストを使用する • リストを使う場合は言葉の並列性を保つ • 番号の付いたリストは命令語で始める • リストと表を適切に使う • 段落の骨子を示す良いリード文を作る • 1段落1トピックに絞る • 読み手に伝えるべきことを定義する • 読み手を意識して書く • ドキュメントの最初にそのドキュメントの重要なポイ ントを明確に示す https://qiita.com/yasuoyasuo/items/c43783316a4d141a140f
71. ドキュメントライフサイクルプロセスを学ぶには 71 エンジニアのためのドキュメントライティング / Docs for Developers and Paragraph Writing https://speakerdeck.com/nttcom/docs-for-developers-and-paragraph-writing
72. 最後に 72
73. 今日のまとめ ✓ ドキュメント作成に求められるスキル ➢ 漏れなく誤解なく言語化する ➢ 知識＋作文能力＋構造化思考 ✓ 構造化思考とは？ ➢ 「分かる」は「分ける」 ➢ 分解＋グルーピング（思考の補助線） ✓ 構造化思考の演習 ➢ いきなり手を付けず、何を考えるべきかを考える ✓ ドキュメント作成の進め方 ➢ 目的から逆算して段取りを考える 73
74. 量が質に転嫁する ドキュメントを書く機会は 自分で作ろう 74 どの現場もあったら助かる資料は必ずあるはずです SNSやブログでも積極的に情報発信していこう
75. ドキュメントを活かすにはプロジェクトのOSを整えたい https://speakerdeck.com/yasuoyasuo/dao-falsezhen-nzhong-wokireinisurupuroziekutomanezimento 自分の失敗を 繰り返さないように マネジメント哲学を 言語化できた 多くの方に 目を通して いただきたい 道の真ん中 中野 で検索！
76. ご清聴ありがとうございました 資料は後ほど Xで共有させていただきます 懇親会参加できず（涙） 感想、フィードバック Xでコメント/DM いただけたら ありがたいです
77. エンジニアのための ドキュメント力養成講座 ～構造化思考から始めよう～ ＜完＞ 2025年2月 ver1.4 ＡＲアドバンストテクノロジ株式会社 中野ヤスオ（@yasuoyasuo） jbug広島#15 「ド。」～文書の運用について～