tutorial-spec

WILLOSCAR 的头像作者 WILLOSCAR

定义教程范围、目标受众、先决条件、学习目标和运行示例;输出下游规划的教程规范。**触发器**:教程规范,范围,受众,先决条件,学习目标,运行示例,教程规格。**使用时**:教程管道的起点(C1),需要先锁定教学目标与边界,再进入概念图/模块规划。**如果**:你不是在做教程简单(或已经有明确且不允许接下来的教程规范)则跳过。**网络**:无。**Guardrail**:教程规范优先;避免提前写长教程散文(散文在) C3)。

📖 中文导读:定义教程范围、目标受众、先决条件、学习目标和运行示例;输出下游规划的教程规范。**触发器**:教程规范,范围,受众,先决条件,学习目标,运行示例,教程规格。**使用时**:教程管道的起点(C1),需要先锁定教学目标与边界,再进入概念图/模块规划。**如果**:你不是在做教程简单(或已经有明确且不允许接下来的教程规范)则跳过。**网络**:无。**Guardrail**:教程规范优先;避免提前写长教程散文(散文在) C3)。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: tutorial-spec description: | Define tutorial scope, target audience, prerequisites, learning objectives, and a running example; output a tutorial spec for downstream planning. Trigger: tutorial spec, scope, audience, prerequisites, learning objectives, running example, 教程规格. Use when: tutorial pipeline 的起点(C1),需要先锁定教学目标与边界,再进入 concept graph / module planning。 Skip if: 你不是在做教程产出(或已经有明确且不允许改动的 tutorial spec)。 Network: none. Guardrail: 结构化 spec 优先;避免提前写长教程 prose(prose 在 C3)。

Tutorial Spec

Goal: define an executable tutorial scope so downstream planning can be deterministic.

Inputs

Required:

  • STATUS.md (context + constraints)

Optional:

  • GOAL.md (topic phrasing)
  • DECISIONS.md (any pre-agreed constraints)

Outputs

  • output/TUTORIAL_SPEC.md
  • Audience (who this is for)
  • Prerequisites (what they must already know)
  • Learning objectives (3–8 measurable outcomes)
  • Non-goals (explicit out-of-scope)
  • Running example (one consistent example used throughout)
  • Deliverable format (Markdown/LaTeX, code language, expected length)

Workflow

  1. Extract constraints from STATUS.md (time, depth, language, audience).
    • If DECISIONS.md exists, treat it as authoritative for any pre-agreed constraints.
  2. If GOAL.md exists, reuse its topic phrasing/examples so the spec stays consistent.
  3. Propose a running example that can survive the whole tutorial (simple but non-trivial).
  4. Write output/TUTORIAL_SPEC.md using the template above.
  5. Ensure every learning objective is measurable (can be verified by an exercise later).

Definition of Done

  • output/TUTORIAL_SPEC.md exists and is structured (not long prose).
  • Running example is concrete and consistent.
  • Objectives are measurable and match the intended audience.

Troubleshooting

Issue: objectives are vague (“understand X”)

Fix:

  • Rewrite as observable outcomes (“implement Y”, “explain trade-off Z”, “debug W”).

Issue: running example is too large

Fix:

  • Reduce to a minimal end-to-end scenario that still exercises the core concepts.