mcpField
Y
yao-tutorial-skill

yao-tutorial-skill

github.com/yaojingangDocuments1.3k92 installsUpdated 2w ago
Repository

About yao-tutorial-skill

Yao Tutorial Skill is a production workflow for formal tutorials, suited to work that requires research, instructional design, and delivery in multiple formats. It combines source review, chapter writing, visuals, export, and quality checks.

Key features

  1. 01Normalize topics, audiences, and deliverables
  2. 02Register sources and map supporting evidence
  3. 03Write a standalone tutorial and outline
  4. 04Plan and build chapter visuals
  5. 05Export and validate delivery files

Use cases

  1. 01Develop a tutorial from user-provided material
  2. 02Add research sources and evidence to a tutorial
  3. 03Create teaching materials with chapter visuals
  4. 04Check HTML, DOCX, or PDF delivery packages

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/yaojingang/yao-open-skills --skill yao-tutorial-skill

After installing, type/yao-tutorial-skillin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

agents/
interface.yaml
evals/
semantic_config.json
trigger_cases.json
examples/english-freedom-route/
brief.json
outline.md
tutorial.md
examples/english-freedom-route/exports/
tutorial-reference.docx
examples/english-freedom-route/research/
chapter-quality-review.md
evidence-map.md
source-register.md
user-materials-register.md
examples/english-freedom-route/visuals/
chapter-01.svg
chapter-02.svg
chapter-03.svg
chapter-04.svg
chapter-05.svg
chapter-06.svg
chapter-07.svg
index.html
visual-spec.json
examples/meta-skill-giants-shoulders/
brief.json
outline.md
tutorial.md
examples/meta-skill-giants-shoulders/exports/
tutorial-reference.docx
examples/meta-skill-giants-shoulders/research/
chapter-quality-review.md
evidence-map.md
source-register.md
examples/meta-skill-giants-shoulders/visuals/
chapter-01.svg
chapter-02.svg
chapter-03.svg

Details

From the project README

Yao Tutorial Skill

Workflow

  1. Normalize topic, audience, outcome, language, formats, user material, style references, and exclusions into brief.json.
  2. Read references/input-adaptation.md; use user material as the spine when sufficient, then add only needed external research.
  3. Read references/research-sourcing.md; create research/user-materials-register.md when needed, research/source-register.md, and research/evidence-map.md.
  4. Read references/tutorial-outline-and-writing.md plus references/course-design-principles.md; write outline.md, standalone public tutorial.md using 第1章 and 1.1, and research/chapter-quality-review.md.
  5. Read the editorial and visual references; create visuals/visual-spec.json, then run build_visual_pack.py and capture_visuals.py.
  6. Read references/export-workflow.md; run export_tutorial.py and then validate_package.py.
  7. Report exact failures and fallbacks. Never fabricate X posts, papers, repo details, dates, or citations.

Quality Gates

  • User material controls intent when strong enough; external evidence fills verification and gaps.
  • Public exports never show internal source IDs or reference-packet provenance.
  • Copy reads as a standalone formal teaching product.
  • Every numbered chapter has a matching visual spec and embedded visual.
  • Depth is governed by learning sufficiency, not a fixed word limit; continue until the learner can understand, apply, and self-check the topic.
  • Every numbered chapter has an independent quality review for depth, examples, practice, evidence, visual fit, and back-half consistency.
  • HTML uses centered report-shell; DOCX/PDF have no visible headers, footers, local paths, or print chrome.
  • Delivery passes scripts/validate_package.py or names the remaining warnings/failures.

References

  • references/input-adaptation.md
  • references/research-sourcing.md
  • references/tutorial-outline-and-writing.md
  • references/course-design-principles.md
  • references/editorial-production.md
  • references/visual-html-workflow.md
  • references/visual-board-benchmarks.md
  • references/export-workflow.md
  • scripts/build_visual_pack.py, scripts/capture_visuals.py, scripts/export_tutorial.py, scripts/validate_package.py
  • templates/topic-brief-template.json, templates/visual-spec-template.json, templates/tutorial-style.css

Comments

Markdown supported