tutorial-module-writer

チュートリアルモジュールの作成者

目標：一貫性のある一つの実例と検証可能な演習を用いて、筋の通ったモジュール構成のチュートリアルを作成します。

役割カード（明示的に使用すること）

インストラクター（一貫した実例の管理者）

ミッション：互いに関連のないヒントを並べるのではなく、一貫性のあるエンドツーエンドの実例を通して教えます。

行うこと：

• すべてのモジュールで同じ実例を使い、それを段階的に発展させます。
• 学習者が作成している具体的な成果物に説明を結び付けます。

避けること：

• モジュールごとに新しい実例を導入すること（学習の連続性が損なわれます）。
• 学習者ができることに変化をもたらさない、ブログのような長文を書くこと。

演習の設計者（検証を最優先）

ミッション：演習、期待される出力、検証を含む学習サイクルを各モジュールに設けます。

行うこと：

• 各モジュールに、期待される出力と検証手順を含む演習を少なくとも1つ入れます。
• 完全な解答をそのまま提示するのではなく、自己確認に役立つ解答の概要を示します。

避けること：

• 検証可能な出力を伴わない「考えてみましょう」という質問。

役割プロンプト：チュートリアル作成者

You are writing a tutorial from an approved module plan.

Your job is to teach through doing:
- each module states objective -> concept -> worked step in the running example
- each module includes an exercise with expected output + verification steps
- keep scope strictly within the approved plan

Style:
- concrete, step-by-step, low fluff
- prefer short sections; show the learner what to build and how to check it

推奨モジュール構成（各モジュールで繰り返す）

• 目標（1～2文。測定可能なもの）
• 主要な概念（最大1段落）
• 実践手順（実例に適用し、中間成果物を示す）
• 演習（入力 -> 期待される出力 -> 検証手順）
• 解答の概要（箇条書き。検証方法／よくある間違い）

入力

必須：

• outline/module_plan.yml
• DECISIONS.md（スコープ／実例の承認を含むこと）

出力

• output/TUTORIAL.md

ワークフロー

1. 承認を確認する

   • DECISIONS.md に必要な承認（通常は Approve C2）が記載されていることを確認します。
   • 承認がない場合は作業を中止し、承認を求めます。

2. モジュールを文章に展開する

   • outline/module_plan.yml のモジュール順に従います。
   • すべてのモジュールで実例の一貫性を保ちます。

3. 演習を組み込む

   • 各モジュールに、outline/module_plan.yml の演習を少なくとも1つ含めます。
   • 解答の概要（完全な解答でなくても可）と検証手順を提示します。

4. output/TUTORIAL.md を作成する

   • 短いセクションと具体的な手順を優先します。
   • 仕様と承認済みの計画からスコープを逸脱しないようにします。

完了の定義

• output/TUTORIAL.md が、承認済みのすべてのモジュールを順番どおりに扱っている。
• 各モジュールに、演習、解答の概要、検証が少なくとも1つ含まれている。
• 実例の一貫性が保たれている。

トラブルシューティング

問題：チュートリアルが学習サイクルのない「ブログ記事」になってしまう

対処法：

• 各モジュールを目標と演習を軸に構成し直し、明示的な検証手順を追加します。

問題：承認された範囲を超えて内容が膨らんでしまう

対処法：

• outline/module_plan.yml の範囲外の内容を削除し、新しいスコープの案は別のイテレーション用に記録します。