diff --git a/README.md b/README.md index 73bd418..8b055bf 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,79 @@ AI コーディング(Claude Code 等)を中心に、散在しがちな情 --- +## 読み進め方(推奨ルート) + +「どの順番で・どの深さで読めばいいか分からない」と感じたら、次の 3 ルートから自分に合うものを選んでください。**どのルートも 25〜45 分** で初回通読できます。 + +### ルート A — はじめての方(30 分) + +> 「Claude Code をまだ触ったことがない/聞いたことはあるけど使っていない」 + +1. [`00-about/`](./00-about/index.html) — **必読**。なぜこの形(HTML × Git × AI)の教材なのか、思想を 10 枚で。ここを飛ばすと以降が宙に浮きます +2. [`01-claude-code-intro/`](./01-claude-code-intro/index.html) — Claude Code とは何か、何ができるか +3. [`02-setup/`](./02-setup/index.html) — 手元にインストールして触ってみる + +**ゴール**: Claude Code を自分の PC で動かして、ちょっとした質問を投げられる状態。 + +### ルート B — Claude Code は触っている方(25 分) + +> 「日常的に使っているが、もっと深く使いこなしたい/チームに紹介したい」 + +1. [`00-about/`](./00-about/index.html) — このリポジトリ自体の運用思想(5 分で目を通す) +2. [`03-claude-md/`](./03-claude-md/index.html) — `CLAUDE.md` の書き方・育て方(実は最も効果がある投資) +3. ルートの [`CLAUDE.md`](./CLAUDE.md) — 本リポジトリで採用している運用ルールの実例 + +**ゴール**: 自分のリポジトリの `CLAUDE.md` を 1 つ書き直して、AI の挙動を狙い通りに変えられる。 + +### ルート C — 教材として/作り手として読む方(45 分) + +> 「教育担当・社内教材を作る人・カンファレンス登壇者など、"作り方" 自体に興味がある」 + +1. [`00-about/`](./00-about/index.html) — 設計思想(必読) +2. [`CONTRIBUTING.md`](./CONTRIBUTING.md) — Issue / Discussion / PR の使い分け +3. [`CLAUDE.md`](./CLAUDE.md) — このリポジトリの運用方針全体 +4. 任意の章を 1 つ選んで [`shared/`](./shared/) の HTML スライドエンジンを覗く + +**ゴール**: 自前で同じ形式の教材を立ち上げる土台ができる。 + +### 読み方のスタイル(3 パターン) + +ルートを選んだら、次は **どう読むか**。3 パターンあります。 + +#### パターン 1 — スライドだけを見る + +ブラウザで `index.html` を開いて、矢印キー(`→` / `Space`)で読み進める。最短ルート。 + +- **向くとき**: 25 分以内でざっと全体像を掴みたい / 講義・勉強会で投影する +- **限界**: スライドは骨格と主張しか持っていない。詳細が気になっても、その場では深掘りできない + +#### パターン 2 — Claude Code に読ませて、対話で読む + +各章の URL(例: `https://co-lect.github.io/lectures/00-about/`)またはローカルの `index.html` パスを Claude Code に渡し、要約させる・疑問を投げる・自分の文脈に置き換えてもらう。 + +- **向くとき**: 視覚的なスライドより自分の課題に引き寄せて深く理解したい / 通勤中などスライド画面を見られない状況 +- **限界**: スライドの "見せ方" や図表が伝える情報は、AI のテキスト要約では落ちる + +#### パターン 3 — 両方(**おすすめ**) + +スライドを開きつつ、隣で Claude Code を起動。**章の URL を最初に AI に渡しておき**、スライドを進めながら気になったところで質問・改善提案・自分の現場での具体例を聞く。 + +- **何がいいか**: + - 図やレイアウトはスライドで(視覚情報を落とさない) + - 詳細・自分への応用は AI で(骨格に肉付けする) + - 読みながら出た疑問・改善案は、そのまま AI Buddy(各章末尾)経由で Discussions / Issue / PR に流せる +- **最初の一声**(コピペ用): + > 「これから https://co-lect.github.io/lectures/00-about/ を読みます。読み終わったら、私が詰まった点や改善提案を一緒に整理して、Issue / Discussion / PR のどれにするか提案してください。投稿案を作る前に、私の同意確認と個人情報(実名・会社名・社内パス・API キー等)の匿名化を必ず行ってください。必要なら Discussions の Q&A / Show and tell / Ideas、Issue(bug-report / improvement)、PR のどれが適切かまで分けてください。」 + +この 3 パターン目が **資料が読まれて終わらず、次の受講者の役に立つループ** を作る、本リポジトリの想定運用です。 + +### どのルートでも共通の前提 + +- **「読む」だけで終わらせない** — 隣に Claude Code(または Codex 等)を置いて、気になった用語はその場で深掘りしてください。スライドは骨格と主張だけしか持っていません([`00-about/`](./00-about/index.html) の解決策 02 参照) +- **詰まったら Issue / Discussion へ** — 「ここわからない」は Discussions / Q&A、「ここ直してほしい」は Issue。詳しくは [`CONTRIBUTING.md`](./CONTRIBUTING.md) + +--- + ## どう読むか ### 方法 1: 公開サイト(GitHub Pages)