SuperAPI AI 工具集

dev-guide-generator

写作与研究

查看项目

更新于 11-06 16:21

技能介绍

用途

Dev Guide Generator 用于把一个技术主题转化为一份完整的技术教程。它通过结构化的 SOP 工作流,将主题扩展为涵盖前置知识、环境搭建、核心步骤、常见错误排查、进阶主题以及速查表的完整文档。触发方式为:用户提出撰写技术教程的请求。

主要能力

该技能按八个阶段组织输出:

  1. 主题界定与受众分析:解析主题,最多提出 4 个澄清问题(受众水平、操作系统、完成后的目标、版本或技术栈约束);若用户要求跳过澄清,则采用默认假设。输出不超过 150 字的教程元数据摘要。
  2. 前置知识:列出读者开始前需具备的知识与工具,分为“必须知道”和“最好知道”两级,每项附一句“为什么需要它”的说明。若前置项超过 5 个,建议缩小范围或拆分为系列。
  3. 环境搭建:列出需安装/配置的工具及推荐版本,区分必需与可选,提供各操作系统的安装命令(仅使用官方推荐方式或主流包管理器),并给出安装后的验证命令与预期输出。配置文件中使用占位符(如 YOUR_API_KEY),不包含真实密钥。
  4. 核心步骤:将操作拆分为 5–10 个步骤,按依赖排序,每步包含步骤编号、标题、目标、操作、解释和验证。步骤 1–3 为最小可运行示例,中间逐步引入真实功能,最后 1–2 步整合为完整示例。
  5. 常见错误排查:列出 5–8 个常见错误场景,每条包含完整错误信息、原因、解决方案和验证修复的方法。错误信息必须真实,解决方案必须可操作,且不得包含可能造成安全风险的操作(如 chmod 777、关闭防火墙)。
  6. 进阶主题:提供 3–5 个进阶方向,每个方向附简短说明、难度标签(中级/高级)和推荐资源;另提供 2–3 个动手项目建议和 3–5 条最佳实践提示。
  7. 速查表:将教程要点提炼为一页速查表,包含环境信息、常用命令、常用代码片段(最多 5 个,每个不超过 10 行)和快速排查表。总长度控制在 2 页 A4 以内。
  8. 文档组装与输出:将前七个阶段的输出组装为完整教程文档,包含教程概述、前置知识、环境搭建、核心步骤、错误排查、进阶主题、速查表和附录(术语表、参考链接)。

使用方式

用户提供技术主题或操作目标,Agent 根据输入详细程度选择交互模式:

  • 仅提供技术名称(如“Docker 教程”):引导模式,执行第一阶段提问,等待回答后继续。
  • 提供具体目标(如“用 Docker 部署 Node.js 应用”):半自动模式,提出 1–2 个关键问题并同时规划步骤。
  • 提供详细描述(含受众、环境、目标):全自动模式,直接从第二阶段开始输出。
  • 用户表示“直接写/不要问”:快速模式,基于默认假设输出完整教程。

若用户对教程提供反馈,技能会定位反馈对应的阶段,从该阶段重新执行,并级联更新所有下游内容,保持步骤编号连续。

适用场景

  • 工具使用:Git、Docker、Kubernetes、Vim 等工具的教程。
  • 环境搭建:开发环境、CI/CD 流水线、服务器配置等。
  • 编程入门:语言入门、框架快速上手、库的使用等。
  • 运维手册:部署、监控、日志、备份与恢复等。
  • 数据处理:数据库操作、ETL 工作流、数据分析工具使用等。

限制

  • 不包含真实 API 密钥、密码、令牌等敏感值,配置文件中使用占位符。
  • 不提供可能造成安全风险的操作建议(如 chmod 777、关闭防火墙)。
  • 不依赖付费 API 或仅订阅可用的工具(除非该工具本身即为教程主题)。
  • 所有安装命令必须来自官方文档或主流包管理器,不使用第三方脚本。
  • 错误信息必须真实,不得编造。
  • 速查表总长度应控制在 2 页 A4 以内。
  • 关于收费、价格、平台等具体信息,资料中暂未提供。