Skip to content

docs(readme): 読み進め方ガイド(推奨ルート3パターン)を追加#35

Draft
watanabe-kohei-jp wants to merge 2 commits into
mainfrom
docs/issue-32-reading-guide
Draft

docs(readme): 読み進め方ガイド(推奨ルート3パターン)を追加#35
watanabe-kohei-jp wants to merge 2 commits into
mainfrom
docs/issue-32-reading-guide

Conversation

@watanabe-kohei-jp
Copy link
Copy Markdown
Collaborator

Closes #32

何を変えるか(What)

README に「読み進め方(推奨ルート)」セクションを新設し、受講者が「どの順番で・どの深さで読めばいいか」を選べる導線を追加する。

変更内容

  • 「何が読めるか」テーブルに 02-setup/03-claude-md/ を追加
    • 現状 main にあるのに README から漏れていた(章一覧と実態のズレを解消)
  • 「読み進め方(推奨ルート)」セクションを新設
    • ルート A: はじめての方(30 分)000102
    • ルート B: Claude Code 経験者(25 分)0003-claude-mdCLAUDE.md
    • ルート C: 作り手として読む方(45 分)00CONTRIBUTINGCLAUDE.mdshared/
  • 各ルートに「想定読者」「ステップ」「ゴール」を 1 セットで明示
  • 「共通の前提」として「読むだけで終わらせない」「詰まったら Issue/Discussion」を再掲

なぜ(Why)

受講者から 「この資料をどのように読み進めていったら良いか具体的に教えてほしい」 という改善提案があった(Issue #32)。

現状の README は:

  • ✅ 「公開サイトで読める」「ローカルで開ける」「キー操作」は案内できている
  • どの順番で・どんな深さで・どこから手を動かせばいいか のガイドが無い
  • ❌ 章テーブル自体が古い(00, 01 しか載っていない)

結果、初見の受講者が「とりあえず 00 から順番に?」と迷子になる構造になっていた。

スコープ外(Out of scope)

レビューで確認してほしい点

  1. 3 ルートの粒度: A / B / C の切り分けが受講者像と噛み合っているか
  2. 所要時間(25〜45 分): 現実的か、過小/過大か
  3. ルート C の妥当性: 「作り手として読む」読者層がそもそも想定読者に入るか
  4. 位置: 「何が読めるか」と「どう読むか」の間に挟んだが、別位置の方が良いか

Test plan

  • GitHub 上で README のレンダリング確認(テーブル・見出し階層・引用ブロックが崩れない)
  • 各章リンクが切れていない(特に 02-setup/ 03-claude-md/
  • CI green(prompt-injection-check 等)

🤖 Generated with Claude Code

ユーザーから「この資料をどう読み進めればいいか具体的に教えてほしい」と
いう声を受けて、README に推奨ルートセクションを追加した。

- 「何が読めるか」テーブルに 02-setup / 03-claude-md を追加
  (現状 main にあるのに README から漏れていた)
- 「読み進め方(推奨ルート)」セクションを新設
  - ルート A: はじめての方(30 分) — 00 → 01 → 02
  - ルート B: Claude Code 経験者(25 分) — 00 → 03-claude-md → CLAUDE.md
  - ルート C: 作り手として読む方(45 分) — 00 → CONTRIBUTING → CLAUDE.md → shared/
- 「共通の前提」で「読むだけで終わらせない」「詰まったら Issue/Discussion」を再掲

章番号や全体構成の見直しは Issue #27 のスコープなので踏み込まない。
本コミットは現状の章をどう読むかのガイドに留める。

Refs #32
「読み進め方(推奨ルート)」セクションに、誰向け軸(ルート A/B/C)に
加えて「どう読むか」の軸を追加。

- パターン 1: スライドだけを見る(最短ルート)
- パターン 2: Claude Code に読ませて対話で読む(深掘り重視)
- パターン 3: 両方 ← おすすめ(スライド × AI 対話で読みながら Issue/PR まで流す)

パターン 3 にはコピペできる「最初の一声」も同梱し、Issue #32 原文の
「具体的に教えてほしい」に粒度で応える。

既存「## どう読むか」(媒体・操作話)とは別軸(スタイル話)なので
そちらには手を入れない。

Refs #32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: この資料の読み進め方を具体的に案内する導線を追加する

1 participant