teaching-style

Applies a structured pedagogical style guide when writing fluidpy notebooks and interactive explainers.

Updated Sep 13, 2026
One-click install
npx skills add https://github.com/shammun/fluidpy --skill teaching-style-shammun
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: teaching-style
Source: https://github.com/shammun/fluidpy/tree/main/.claude/skills/teaching-style
Command: npx skills add https://github.com/shammun/fluidpy --skill teaching-style-shammun

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing educational content for fluid mechanics notebooks and HTML explainers risks inconsistency: unexplained symbols, skipped derivation steps, uncommented code, and figures left uninterpreted. This Skill enforces a single, detailed teaching style so every notebook cell, derivation, and explainer walkthrough follows the same reader-first rules. ## Core Features & Use Cases - Structured logic chain: Enforces the problem → idea → maths → tiny example → code → output-interpretation sequence for every core concept, with plain words before symbols. - Full derivations: Requires one algebraic move per step, each with what-we-did, why-allowed, and in-words annotations, plus checks, unit verification, and sympy validation for hard derivations. - Self-contained explanations: Mandates primers and recaps so no term, symbol, math tool, or Python idiom is used before it is explained. - Use Case: When drafting a new chapter notebook on gravity waves, load this Skill so every section uses the standard headings ("What does the code above do?", "What you see / How to read it"), novice-grade code comments with units and equation citations, and walkthrough steps under 45 words for the interactive explainer. ## Quick Start Use the teaching-style skill to review this notebook cell and rewrite it following the fluidpy teaching conventions.

Frequently Asked Questions about teaching-style

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write educational notebook content in a consistent teaching style?

Load this Skill when writing or reviewing notebook cells. It enforces a fixed logic chain—problem in plain words, core idea, step-by-step maths, tiny worked example, commented code, then output interpretation—plus standardized headings readers can scan for.

How should step-by-step math derivations be formatted for teaching?

Each derivation states the goal and plan first, then shows one small algebraic move per step. Every step includes what was done, the new equation line, why the move is allowed, and a one-sentence physical interpretation, ending with checks and limiting cases.

What makes code comments novice-friendly in teaching notebooks?

Comments explain the physical meaning and units of each variable and cite the source equation number, rather than restating Python syntax. From-scratch implementations are paired with library calls and verified using assert np.allclose.

When should a primer or recap block be added to a notebook?

Add a primer whenever a concept, symbol, math tool, or Python idiom appears before being explained. If an earlier chapter already covered it, write a one-sentence recap naming that chapter instead of repeating the full primer.

What are the rules for interactive explainer walkthrough text?

Walkthroughs use 4–8 steps of at most 45 words each, written in second person with imperatives. Step one poses the question in plain words, middle steps build the idea with live numbers, and the final step hands over controls with a prediction challenge.