mcpField
Y
yao-tutorial-skill

yao-tutorial-skill

github.com/yaojingang文档处理1.3k92 次安装2 周前更新
代码仓库

关于 yao-tutorial-skill

Yao Tutorial Skill 是用于制作正式教程的内容生产流程,适合需要研究、教学设计和多格式交付的场景。它将资料核验、章节写作、配套视觉内容、导出与质量检查纳入同一流程。

主要功能

  1. 01整理主题、受众与交付要求
  2. 02登记来源并建立证据映射
  3. 03编写独立成篇的教程和大纲
  4. 04为章节规划并生成视觉内容
  5. 05导出并验证交付文件

适用场景

  1. 01根据用户提供的资料编写教程
  2. 02为教程补充研究来源和证据
  3. 03制作带章节配图的教学材料
  4. 04检查 HTML、DOCX 或 PDF 交付包

安装

复制下面的命令,在终端中运行。

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

安装后在 Claude Code 中输入/yao-tutorial-skill确认已加载。

包含的文件

除 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

详细介绍

Yao 教程技能

工作流

  1. 将主题、受众、目标、语言、格式、用户材料、风格参考和排除项规范化,写入 brief.json。
  2. 阅读 references/input-adaptation.md;如果用户材料足够,就以其为主线,然后只补充必要的外部研究。
  3. 阅读 references/research-sourcing.md;必要时创建 research/user-materials-register.md,并创建 research/source-register.md 和 research/evidence-map.md。
  4. 阅读 references/tutorial-outline-and-writing.md 和 references/course-design-principles.md;撰写 outline.md、面向公众且可独立阅读的 tutorial.md(使用 第1章 和 1.1),以及 research/chapter-quality-review.md。
  5. 阅读编辑和视觉参考资料;创建 visuals/visual-spec.json,然后运行 build_visual_pack.py 和 capture_visuals.py。
  6. 阅读 references/export-workflow.md;先运行 export_tutorial.py,再运行 validate_package.py。
  7. 报告确切的失败和回退方案。绝不捏造 X 帖子、论文、仓库详情、日期或引用。

质量关卡

  • 用户材料足够有力时,以其为准;外部证据用于核实和填补空缺。
  • 面向公众的导出内容不得显示内部来源 ID 或参考资料包的来源信息。
  • 文稿应能作为正式教学产品独立阅读。
  • 每个编号章节都必须有匹配的视觉规范和嵌入式视觉内容。
  • 内容深度应以是否足以支持学习为准,而非固定字数限制;持续完善,直到学习者能够理解、应用并自我检查主题。
  • 每个编号章节都必须接受独立的质量审查,评估深度、示例、练习、证据、视觉适配度以及后半部分的一致性。
  • HTML 使用居中的 report-shell;DOCX/PDF 不得包含可见页眉、页脚、本地路径或打印装饰。
  • 交付内容必须通过 scripts/validate_package.py,或列明尚未解决的警告和失败。

参考资料

  • 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

评论

支持 Markdown