mcpField
T
teaching-notes-writing

teaching-notes-writing

github.com/quan0715Documents1442 installsUpdated 9w ago
Repository

About teaching-notes-writing

A portable writing skill for learner-facing teaching materials such as handouts, worksheets, study guides, and tutorial chapters. It offers flexible content structures, explanation strategies, examples, and exercise guidance without imposing a fixed chapter template.

Key features

  1. 01Start from learners’ likely mental models
  2. 02Compare related concepts before formal rules
  3. 03Explain procedures with visible steps
  4. 04Suggest suitable practice and answer placement
  5. 05Identify when a diagram may help

Use cases

  1. 01Draft a learner-facing study guide
  2. 02Explain a procedure step by step
  3. 03Design practice questions and answer flow
  4. 04Decide where a teaching page needs a diagram

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/quan0715/open-press --skill teaching-notes-writing

After installing, type/teaching-notes-writingin Claude Code to confirm it loaded.

Bundled filesreferences/programming.mdreferences/teaching-patterns.md

Details

From the project README

Teaching Notes Writing

This is a portable writing skill: usable standalone, and loaded by openpress-create-pages when page content is learner-facing teaching material (handouts, worksheets, study guides, tutorial chapters). openpress-create-pages owns the trigger and conflict-resolution rules.

Teaching notes are for learners who are still building the mental model. This skill provides suggested content skeletons, explanation strategies, examples, practice ideas, and answer-flow guidance. It does not mandate one rigid chapter template.

Responsibilities

  • Start from the learner's likely mental model.
  • Compare nearby ideas before introducing formal rules.
  • Show procedures step by step with visible state changes.
  • Put reasons, warnings, and interpretation in prose rather than overloading figures.
  • Suggest practice surfaces that match the chapter content.
  • Put answers after the learner has had a chance to try.
  • Suggest when a structure, relationship, or state change should become a diagram; use openpress-diagram-drawing for the actual diagram semantics.

Boundaries

  • openpress-create-pages owns public-content hygiene and H1/H2/H3/H4 structure for page-based artifacts.
  • openpress-diagram-drawing owns diagram semantics.
  • openpress-create-pages owns page visual style and component implementation.
  • openpress owns CLI, validation/export/render commands, and source/generated boundaries.
  • This skill owns learner-facing explanation suggestions and exercise-design patterns only.

Suggested Skeleton

Use this as a starting skeleton, not a required template:

  1. Start from the learner's concrete problem or confusion.
  2. Compare nearby concepts, states, or representations.
  3. Show the operation or idea step by step.
  4. Add one small check, trace, or practice task when it helps.
  5. Put full answers after the learner has had a chance to attempt.

If the concept depends on spatial structure, ownership, arrows, state transitions, or before/after relationships, hand the visual semantics to openpress-diagram-drawing.

Learner Boundary

Rendered teaching pages should speak to the learner, not the teacher or agent.

  • Do not include teacher-only reminders, production notes, internal rationale, or starter-skill commentary.
  • Keep internal rules in skills, design docs, or source references.
  • Use consistent terms and variable names across prose, diagrams, tables, and code.

When To Read References

  • Read references/teaching-patterns.md for comparison writing, explanation order, practice question types, and answer placement.
  • Read references/programming.md when teaching code, pseudocode, data structures, pointer diagrams, memory state, or program traces.

Comments

Markdown supported