SuperAPI AI 工具集

doc-skill-generator

编程与开发

查看项目

更新于 10-15 15:43

技能介绍

用途

Doc Skill Generator 用于从技术框架或编程语言的官方网站自动提取文档内容,并通过智能分析生成符合规范的 Skill 子技能包,帮助用户系统性学习该技术栈。它本身是一个母技能,负责调度抓取、摘要、模板填充、验证与打包等环节,产出可交付的子技能包。

主要能力

  • 智能抓取官网文档,基于文档类型过滤路径(如 /docs/、/guide/、/api/ 等)。
  • 自动提取版本号和元数据,并在文件头部注入来源 URL、抓取时间、版本号。
  • 通过 LLM 进行内容摘要与核心能力图谱生成。
  • 模板化子技能生成,覆盖语言类、框架类、工具类三种模板。
  • 自动验证技能完整性,包括元数据、目录结构与内容质量检查。
  • 打包生成 .skill 文件交付。

使用方式

前置准备

依赖安装:

crawl4ai>=0.4.0
playwright==1.40.0

首次使用需初始化 Playwright 浏览器:

playwright install chromium

操作步骤

  1. 信息收集与准备:从用户请求中提取官网 URL(必需)、技术栈名称(可选)、文档类型(可选,可智能推断)、抓取深度(可选,默认 2 层)。

  2. 网站文档抓取:调用 scripts/crawl_website.py,示例:

python scripts/crawl_website.py \
  --url "https://vuejs.org" \
  --depth 2 \
  --output "/workspace/projects/vue-skills/raw_docs" \
  --type framework

参数包括 --url、--depth、--output、--max-pages(默认 50)、--type(language/framework/tool)。

  1. 内容摘要与分析:调用 scripts/summarize_pages.py,示例:
python scripts/summarize_pages.py \
  --input "/workspace/projects/vue-skills/raw_docs" \
  --output "/workspace/projects/vue-skills/summary.json" \
  --type framework

输出页面统计、文档结构分析、核心概念图谱、技能类型推荐、优先阅读页面列表。

  1. 子技能模板选择与填充:根据文档类型从 references/templates/ 选择 language-skill.md、framework-skill.md 或 tool-skill.md,填充元数据与核心内容,并生成参考文档(core-concepts.md、api-reference.md、best-practices.md、examples.md)和代码模板(hello-world、basic-template、advanced-example)。

  2. 技能验证(可选):调用 scripts/validate_skill.py,示例:

python scripts/validate_skill.py \
  --skill-path "/workspace/projects/vue-skills" \
  --output "/workspace/projects/vue-skills/validation_report.json"
  1. 打包交付:调用 package_skill(skill_dir_name="<技术栈名称>-skills")。

触发条件示例

  • "帮我生成一个 Vue 的学习技能包"
  • "根据 React 官网创建对应的技能"
  • "我需要一个 Go 语言的技能包"
  • "生成基于 TypeScript 官网的技能"

适用场景

  • 为前端框架(Vue、React、Angular)生成学习技能包。
  • 为编程语言(Go、Python、Rust)生成学习技能包。
  • 为工具类(Webpack、Docker、ESLint)生成学习技能包。

限制与注意事项

  • 爬取策略需根据文档类型自动过滤路径,控制抓取深度和页面数,避免对目标网站造成压力,并遵守网站 robots.txt 规则。
  • 智能体职责边界:智能体负责内容分析、模板选择、文档生成、示例创作,以及根据摘要报告设计子技能结构;不负责 HTML 解析、链接发现、文件格式转换和元数据提取(由脚本完成)。
  • 建议在打包前运行验证脚本,检查所有验证项是否通过,并根据验证报告修复问题。
  • 关于收费、价格、平台支持等具体信息暂未提供。