SuperAPI AI Directory

tutorial-writer-review

Testing & quality

View repository

Updated 10-16 01:19

About this skill

Tutorial Writer — ✅ Quality Verification

Skill Positioning

This sub-skill is responsible for the late-stage quality verification phaseof tutorial creation (REVIEW in PRWRD+D), performing a full gate check on chapter content before delivery.

Input: The chapter .md file with a completed first draft Output: Quality scorecard (pass/fail determination + issue list)

Core Process

① 通读全文 → 建立整体印象
    │
    ├── ② 逐项执行质量门禁
    │   ├── Q1-Q2: 阻塞项(规划先行、搜索先行)
    │   ├── Q3-Q9: 标准项(长度、支撑、结构、语言等)
    │   └── Q10-Q14: 增强项(跨章一致性、网页构建)
    │
    ├── ③ 跨章一致性检查
    │   ├── R7: 技术栈与决策记录一致
    │   ├── R8: 数据结构与相邻章节兼容
    │   └── R9: 代码逻辑审查
    │
    ├── ④ 填写质量评分卡
    │
    └── ⑤ 输出判定
        ├── 阻塞项全过 + 非阻塞项 ≥ 11/12 → ✅ 通过
        └── 任意阻塞项不通过 → ❌ 回退修正

14-Item Quality Gate Quick Reference

# Abbreviation Level Pass Criteria
Q1 PLAN P0-Blocking Has a content plan and it has been confirmed
Q2 SEARCH P0-Blocking Materials have been searched for and archived
Q3 LENGTH P1-Warning Line count within ±20% of target range
Q4 SOURCE P1-Warning Key data is supported by materials
Q5 ALIGN P1-Warning Content is consistent with the outline structure
Q6 LANG P1-Warning No comments/placeholders
Q7 CITE P2-Suggestion Data sources are annotated
Q8 FMT P2-Suggestion Code blocks/tables conform to standards
Q9 ARCHIVE P2-Suggestion Materials have been archived and the index updated
Q10 TECH P1-Warning Tech stack is consistent with the whole book
Q11 DATA P0-Blocking Data format is compatible with adjacent sections
Q12 COVERAGE P1-Warning All outline key points are covered
Q13 DEPTH P1-Warning Core concepts S5 ≥ 4/6
Q14 WEB P1-Warning /web Build has no errors (Astro preview passes)

Reference Files