SuperAPI AI 工具集

tutorial-content-qa

写作与研究

查看项目

更新于 10-28 16:25

技能介绍

Tutorial Content QA 是一个用于 AI-Native 开发教程内容质量保证的技能,适用于 Foundation、Advanced、Terminal 三条学习路径的发布前检查、编辑后复查、拉取请求审阅、周期性内容审计以及新路径上线前的验收。

主要能力包括:运行覆盖全路径或指定路径的快速 QA 脚本,检查步骤数量、重复步骤 ID、prompt 数量、自定义块(prompt、diagram、collapsible、tabs)是否闭合、frontmatter 是否具备起止 ---、代码围栏是否为偶数、是否出现废弃术语;对 Terminal 路径额外检查元提示中的 === 分隔符是否位于 prompt 块内;对全路径执行图表审计,确认 :::diagram 引用的名称在 StepCard.tsx 中存在对应 case。

该技能还规定了各路径的具体格式:Foundation 使用数字步骤编号(Step 1 起)与数字 prompt 编号,并包含 {{projectName}} 等渲染期解析的模板变量,权威计数参考 .github/reference/step-map.md 与 prompt-map.md;Advanced 使用字母前缀步骤与 prompt 编号,每步可含多个 prompt,无模板变量;Terminal 使用字母前缀步骤(F、G、H)与 prompt 编号,每步可含多个 prompt,元提示以 === 分隔(之前为可复制提示,之后为说明性上下文),无模板变量。

使用方式为在内容仓库中执行技能提供的 PowerShell 脚本,并按检查清单逐项核对;发布前需完成快速 QA、版本检查(可配合 version-checker 技能)、可访问性与可读性检查,并确认 npm run build 构建成功。Terminal 路径还需核对 CLI 安装命令,例如 Claude Code 的 npm install -g @anthropic-ai/claude-code 与 GitHub Copilot CLI 的 gh extension install github/gh-copilot。

可访问性与可读性部分要求以约八年级阅读水平为目标、首次出现时解释术语与缩写、使用包容性语言、保持标题层级连续、为图表补充等价文字说明、为代码块添加语言提示、使用有意义的链接文本,并避免仅以颜色传达信息。

限制方面:该技能面向采用特定 Markdown 结构与自定义块语法的教程仓库,脚本依赖 PowerShell 与约定路径;对收费、平台支持范围等信息暂未提供。