Source: instructional-designer pedagogy review, docs/reviews/2026-06-13-pedagogy-review.md (Part 2, item #5 — Medium impact / High feasibility, "Next").
User story
As a tutorial author, I want a key-term caption mode in addition to verbatim captions, so I can reduce redundancy load for sound-on learners while still teaching vocabulary — keeping full verbatim captions as the accessible default.
Context / correction to the review
The review proposes captions: 'full' | 'keyterms' | 'off'. The actual config field today is subtitles: 'burn' | 'sidecar' | 'off' (packages/core/src/types.ts:130), generated in packages/core/src/post/subtitles.ts (SRT) and packages/core/src/post/captions.ts (burned pills). This issue should map the new mode onto the existing subtitles option rather than introduce a parallel captions field — decide whether key-term-vs-verbatim is an orthogonal axis (a new option, e.g. captionText: 'verbatim' | 'keyterms') or folded into the existing enum. Recommend an orthogonal option so burn/sidecar/off (delivery) stays separate from verbatim/keyterm (content).
Scope
- Add a content mode that emits only signaled labels / key vocabulary per step instead of the full narration sentence.
- Author surface for declaring key terms per step (e.g. an
opts.keyTerms?: string[], or derive from signaled callout labels). Define how terms are sourced.
verbatim remains the default (accessibility-correct).
Acceptance criteria
Open decision (for maintainer)
Where key terms come from — explicit per-step authoring vs. auto-derived from callout/signal labels. Recommend explicit author field for v1 (predictable), auto-derivation later.
Source: instructional-designer pedagogy review,
docs/reviews/2026-06-13-pedagogy-review.md(Part 2, item #5 — Medium impact / High feasibility, "Next").User story
As a tutorial author, I want a key-term caption mode in addition to verbatim captions, so I can reduce redundancy load for sound-on learners while still teaching vocabulary — keeping full verbatim captions as the accessible default.
Context / correction to the review
The review proposes
captions: 'full' | 'keyterms' | 'off'. The actual config field today issubtitles: 'burn' | 'sidecar' | 'off'(packages/core/src/types.ts:130), generated inpackages/core/src/post/subtitles.ts(SRT) andpackages/core/src/post/captions.ts(burned pills). This issue should map the new mode onto the existingsubtitlesoption rather than introduce a parallelcaptionsfield — decide whether key-term-vs-verbatim is an orthogonal axis (a new option, e.g.captionText: 'verbatim' | 'keyterms') or folded into the existing enum. Recommend an orthogonal option soburn/sidecar/off(delivery) stays separate from verbatim/keyterm (content).Scope
opts.keyTerms?: string[], or derive from signaled callout labels). Define how terms are sourced.verbatimremains the default (accessibility-correct).Acceptance criteria
burnandsidecardelivery.translations.docs/getting-started.md(currently describes captions at :83-85).Open decision (for maintainer)
Where key terms come from — explicit per-step authoring vs. auto-derived from callout/signal labels. Recommend explicit author field for v1 (predictable), auto-derivation later.