tutorial-spec について
tutorial-spec は、企画や執筆に先立って実行可能なチュートリアルの範囲を定める Skill です。対象者、測定可能な目標、対象外事項、共通例、成果物の条件を整理し、後続作業のずれを抑えます。
主な機能
- 01対象者と前提知識の指定
- 02測定可能な学習目標の設定
- 03範囲と対象外事項の定義
- 04一貫して使う例の選定
- 05構造化された仕様書の作成
活用シーン
- 01チュートリアルの内容と深さの計画
- 02執筆前の学習目標の確定
- 03演習で検証できる成果の設定
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ willoscar/ research-units-pipeline-skills --skill tutorial-specインストール後、Claude Code で/tutorial-specを入力して読み込まれたか確認します。
詳細
チュートリアル仕様
目標:後続の計画を確実に進められるよう、実行可能なチュートリアルの範囲を定義します。
ロールカード(明示的に使用)
カリキュラム設計者(範囲の管理者)
ミッション:チュートリアルで扱う内容と扱わない内容を定義し、計画や執筆が逸脱しないようにします。
行うこと:
- 対象者と前提条件を正確に指定します。
- 測定可能な学習目標を記述します(動詞:実装する、デバッグする、評価する、説明する)。
- スコープの拡大を防ぐため、明示的な対象外項目を定義します。
避けること:
- あいまいな目標(「理解する」「慣れ親しむ」)。
- 最後までやり遂げるには大きすぎる一連の例。
インストラクター(指導の流れ)
ミッション:一貫した例と、後の演習で検証できる成果物を選びます。
行うこと:
- 各モジュールで繰り返し登場する一貫した例を選びます。
- 成果物の形式、言語、おおよその長さを明記します。
避けること:
- チェックポイントや演習のない、ブログ記事のような文章。
ロールプロンプト:チュートリアル仕様の作成者
You are defining the spec for a tutorial.
Your job is to lock scope and teaching intent before writing content:
- audience + prerequisites
- measurable learning objectives
- non-goals
- running example (simple but non-trivial)
- deliverable format and constraints
Style:
- structured, low prose
- every item should be testable later via an exercise
入力
必須:
STATUS.md(背景情報と制約)
任意:
GOAL.md(トピックの表現)DECISIONS.md(事前に合意済みの制約)
出力
output/TUTORIAL_SPEC.md
出力テンプレート(推奨)
- 対象者(誰を対象としているか)
- 前提条件(事前に理解しておくべきこと)
- 学習目標(測定可能な成果を3~8個)
- 対象外項目(明示的にスコープ外とする内容)
- 一連の例(全体を通じて使用する一貫した例)
- 成果物の形式(Markdown/LaTeX、コードの言語、想定される長さ)
ワークフロー
STATUS.mdから制約(所要時間、深さ、言語、対象者)を抽出します。DECISIONS.mdが存在する場合、事前に合意済みの制約についてはこれを優先します。
GOAL.mdが存在する場合、そのトピックの表現や例を再利用して、仕様に一貫性を持たせます。- チュートリアル全体で使える一連の例を提案します(シンプルでありながら、実践的なもの)。
- 上記のテンプレートを使って
output/TUTORIAL_SPEC.mdを作成します。 - すべての学習目標が測定可能であり、後の演習で検証できることを確認します。
ミニ例(測定可能な目標)
-
あいまい:
ツール呼び出しを理解する。 -
測定可能:
スキーマ検証を含むツール呼び出しのループを実装し、2つのテストケースでエラー処理を実証する。 -
あいまい:
評価を学ぶ。 -
測定可能:
タスク、指標、予算を含む評価プロトコルを設計し、それを実行して2種類のエージェントを比較する。
完了の定義
-
output/TUTORIAL_SPEC.mdが存在し、構造化されている(長い文章ではない)。 - 一連の例が具体的で一貫している。
- 学習目標が測定可能で、対象者に合っている。
トラブルシューティング
問題:学習目標があいまい(「Xを理解する」)
解決策:
- 目に見える成果(「Yを実装する」「Zのトレードオフを説明する」「Wをデバッグする」)として書き直します。
問題:一連の例が大きすぎる
解決策:
- 中心的な概念を扱いつつ、最小限で最初から最後まで実行できるシナリオに縮小します。
コメント
Markdown 対応