SuperAPI AI 工具集

concept-workflow

写作与研究

查看项目

更新于 10-15 16:30

技能介绍

用途

concept-workflow 是一个端到端工作流技能,用于从零开始创建完整、高质量的 JavaScript 概念文档页面。它把五个专门技能按最优顺序编排在一起,覆盖从研究到最终审查的全过程。

适用场景包括:

  • 从零创建全新的概念页面
  • 完全重写已有的概念页面
  • 需要包含全部质量检查的完整端到端流程

如果只做部分任务,应改用对应的单个技能:只添加资源用 resource-curator;只写内容用 write-concept;只添加测试用 test-writer;只验证准确性用 fact-check;只优化 SEO 用 seo-review。

主要能力(工作流阶段)

工作流以概念名称(如 hoisting、event-loop、promises)为输入,依次执行五个阶段:

阶段 1:资源整理(resource-curator) 在写作前收集高质量外部资源。识别概念类别,搜索 MDN 参考,寻找 4-6 篇可信来源文章和 3-4 个可信创作者视频,评估每个资源并撰写具体描述(每个 2 句),格式化为 Card 组件。交付物包括 2-4 个 MDN/参考链接、4-6 个文章链接、3-4 个视频链接,以及可选的 1-2 门课程或书籍。质量门禁:所有链接验证可用(200 响应)、资源聚焦 JavaScript、描述具体而非泛泛、兼顾初学者与进阶内容。

阶段 2:概念写作(write-concept) 创建完整文档页面。确定文件组织类别,创建 frontmatter(title、sidebarTitle、description),撰写开篇钩子(吸引读者的问题),在前 200 词内加入开篇代码示例,撰写“你将学到什么”信息框(5-7 个要点),撰写主体章节(什么是该概念,含 40-60 词定义用于精选摘要;现实类比;工作原理含图示;多个渐进复杂度的代码示例;常见错误;边界情况),添加关键要点(8-10 条编号)、知识自测(5-6 个问答折叠项)、相关概念(4 个 Card 链接)、资源(粘贴阶段 1 成果)。交付物为 /docs/concepts/{concept-name}.mdx 文件,如为新页面则加入 docs.json 导航。质量门禁:frontmatter 完整、以问题钩子开篇、前 200 词含代码示例、有“你将学到什么”信息框、所有必需章节齐全、资源章节完整、1500 词以上。

阶段 3:测试编写(test-writer) 为所有代码示例创建全面测试。扫描页面中所有代码示例并分类(可测试、DOM 相关需 jsdom、错误示例用 toThrow、概念性跳过),在 tests/{category}/{concept}/{concept}.test.js 创建测试文件,必要时创建 DOM 测试文件 tests/{category}/{concept}/{concept}.dom.test.js,为每个代码示例编写带源码行引用的测试并运行验证。质量门禁:所有可测试示例都有测试、注释含源码行引用、测试通过(npm test -- tests/{category}/{concept}/)、DOM 测试单独文件并带 jsdom 指令。

阶段 4:事实核查(fact-check) 验证所有内容的技术准确性。运行测试并手动检查未测试示例,验证输出注释与实际输出一致;点击所有 MDN 链接验证可用,对照 MDN 比较 API 描述,查阅 ECMAScript 规范核实细微论断;检查所有文章/视频链接可用并核对描述与内容相符;审计技术论断(查找“总是/从不”表述、验证性能声明、检查常见误解);生成事实核查报告。质量门禁:所有测试通过、所有 MDN 链接有效、所有外部资源可访问、无技术不准确、无常见误解。

阶段 5:SEO 审查(seo-review) 优化搜索可见性。审计标题标签(50-60 字符、主关键词在前半、以“in JavaScript”结尾、含吸引人的钩子);审计元描述(150-160 字符、以动作词开头如 Learn/Understand/Discover、含主关键词、承诺具体价值);审计关键词位置(标题、描述、前 100 词、至少一个 H2);审计内容结构(问题钩子开篇、前 200 词含代码、“你将学到什么”框、短段落);审计精选摘要优化(“What is” H2 后 40-60 词定义、问题格式 H2、操作类内容用编号步骤);审计内链(3-5 个相关概念链接、描述性锚文本、相关概念章节完整);计算得分并修复问题。交付物为含得分(X/27)的 SEO 审计报告。质量门禁:得分 24+/27(90%+)、标题优化、元描述优化、关键词自然放置、精选摘要优化、内链完整。

使用方式

工作流提供主检查清单跟踪各阶段进度,包含每个阶段的复选框、状态标记(未开始/进行中/完成)、测试结果、SEO 得分和最终状态(所有阶段完成、可发布、完成日期)。

执行说明:

  1. 初始化:声明概念名称、类别、文件路径和测试路径。
  2. 逐阶段执行:每个阶段先声明阶段名和所用技能,加载该技能获取详细指令,按技能方法论执行,报告完成情况(交付物和质量门禁),只有质量门禁通过后才进入下一阶段。
  3. 最终报告:所有阶段完成后输出摘要(概念页路径、测试文件路径、词数、代码示例数及测试数、资源数量)、质量指标(测试通过数、事实核查结果、SEO 得分)、创建/修改的文件列表和可发布状态。

阶段依赖关系:阶段 1 在阶段 2 之前(资源指导写作内容);阶段 2 在阶段 3 之前(需先有内容才能写测试);阶段 3 在阶段 4 之前(测试是事实核查的一部分);阶段 4 在阶段 5 之前(先修复准确性问题再做 SEO 打磨)。部分阶段可部分并行。

快速开始:确定概念名称和类别,加载 concept-workflow 技能,依次执行阶段 1 至 5,生成最终报告并提交更改。示例提示:“Create a complete concept page for 'hoisting' using the concept-workflow skill”。

时间估算

阶段 1 资源:15-30 分钟(取决于优质资源可得性);阶段 2 写作:1-3 小时(取决于概念复杂度);阶段 3 测试:30-60 分钟(取决于代码示例数量);阶段 4 事实核查:15-30 分钟(大部分通过测试自动化);阶段 5 SEO:15-30 分钟(主要是清单核对)。总计 2-5 小时完成一个完整概念页。

限制

资料未提供该技能的收费、价格、平台支持范围等商业信息。各阶段的具体执行细节需加载对应技能的 SKILL.md 文件获取。