---
id: gh-yao-tutorial-skill
name: "yao-tutorial-skill"
url: https://skills.yangsir.net/skill/gh-yao-tutorial-skill
author: yaojingang
domain: education
tags: ["tutorial-generation", "content-creation", "education", "documentation", "course-design"]
install_count: 51
rating: 4.00 (120 reviews)
github: https://github.com/yaojingang/yao-open-skills/tree/main/skills/yao-tutorial-skill
---

# yao-tutorial-skill

> yao-tutorial-skill 能根据主题或参考资料，自动生成带大纲、配图和多格式导出的完整教程。它适用于制作“从入门到精通”类学习文档、产品教材和教学内容，确保专业性和交付质量。

**Stats**: 51 installs · 4.0/5 (120 reviews)

## Before / After 对比

### 高效教程制作

**Before**:

手动编写一份高质量、结构完整、配图精美且支持多格式导出的教程，需要耗费大量时间进行资料搜集、内容组织、视觉设计和格式转换，过程繁琐且易出错。

**After**:

使用此技能自动生成教程，从主题到成品一站式完成，大幅缩短制作周期。它确保内容专业、视觉统一，并自动导出多种格式，省去繁琐的人工操作，显著提升效率和质量。

| Metric | Before | After | Change |
|---|---|---|---|
| 教程制作时间 | 40小时 | 2小时 | -95% |

## 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`, then standalone public `tutorial.md` using `第1章` and `1.1`.
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.
- Default full tutorial length is `5000-10000` Chinese characters or `3500-7000` English words unless requested otherwise.
- 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`


---

# Yao Tutorial Skill

`yao-tutorial-skill` 是一个面向教程成品生产的 Skill：输入一个主题，或输入一组参考资料、网址、论文、GitHub 仓库、草稿，它会把这些信息整理成一套带来源、带大纲、带章节配图、带多格式导出的完整教程。

它适合用来做“从入门到精通”类教程、系统化学习文档、产品或技术教材、方法论手册，以及需要正式交付的长篇教学内容。

## 它会做什么

1. 把输入归一化为 `brief.json`，明确主题、受众、目标、材料、格式和限制。
2. 优先吸收用户给的资料；资料不足时，再补充官方文档、论文、GitHub、实践案例和高质量分享。
3. 生成来源登记和证据映射，避免教程变成无依据的泛泛写作。
4. 用课程设计方法重构标题和大纲，让章节既有专业体系，又能说人话。
5. 写出完整教程正文，默认中文约 `5000-10000` 字，并以正式对外成品口吻呈现。
6. 为每个编号章节生成一个 HTML 可视化配图，再截图嵌入正文。
7. 导出 `Markdown`、`Word`、`PDF` 和 `HTML`。
8. 运行验证脚本，检查章节、配图、引用、截图、导出文件、页眉页脚和本地路径泄漏。

## 典型输出

```text
output/
├── brief.json
├── outline.md
├── tutorial.md
├── research/
│   ├── source-register.md
│   └── evidence-map.md
├── visuals/
│   ├── visual-spec.json
│   └── index.html
├── assets/
│   └── screenshots/
└── exports/
    ├── tutorial.html
    ├── tutorial.docx
    └── tutorial.pdf
```

## 关键约束

- 用户资料足够时，以用户资料为主线，不机械扩大搜索范围。
- 用户资料不足时，外部来源优先级为官方/一手来源、论文、GitHub、权威实践分享。
- 内部研究文件保留来源 ID；公开 Markdown/HTML/Word/PDF 不显示 `[U1]`、`[X1]` 这类角标。
- 教程正文必须像正式出版物，不写“基于用户资料”“根据原文整理”等内部来源话术。
- 标题和大纲要面向用户利益、痛点和学习路径，避免只堆专业术语。
- 每个小节标题要对应具体大纲内容，避免反复使用“你要做的事”“检查点”等泛化标题。
- 每个编号章节都必须有一个对应视觉规格和一张嵌入配图。
- HTML 报告要使用居中内容容器、粘性目录、日期和章节跳转。
- Word/PDF 默认不保留页眉页脚，避免路径、页码和打印信息影响阅读。

## 主要文件

- [`SKILL.md`](SKILL.md): Skill 入口和最小工作流
- [`references/input-adaptation.md`](references/input-adaptation.md): 输入资料优先级和补充研究逻辑
- [`references/research-sourcing.md`](references/research-sourcing.md): 来源选择和证据登记规则
- [`references/tutorial-outline-and-writing.md`](references/tutorial-outline-and-writing.md): 大纲与正文写作规则
- [`references/course-design-principles.md`](references/course-design-principles.md): 课程标题、大纲和内容体验设计规则
- [`references/visual-html-workflow.md`](references/visual-html-workflow.md): HTML 配图画板生成规则
- [`references/export-workflow.md`](references/export-workflow.md): Word/PDF/HTML 导出规则
- [`scripts/validate_package.py`](scripts/validate_package.py): 输出包验证脚本
- [`examples/`](examples/): 三套完整教程示例，包含 Markdown、HTML、Word、PDF、配图画板和验证产物


---
*Source: https://skills.yangsir.net/skill/gh-yao-tutorial-skill*
*Markdown mirror: https://skills.yangsir.net/api/skill/gh-yao-tutorial-skill/markdown*