SuperAPI AI 工具集

dev-guide-writer

写作与研究

查看项目

更新于 11-06 16:21

技能介绍

用途

dev-guide-writer 是一个技术教程生成器,用于将任何技术主题转化为完整教程。教程内容包含前置知识、环境搭建、核心步骤、常见报错和进阶拓展,并附带速查表(Cheatsheet)。当用户提到编写教程、操作指南、入门手册、环境搭建步骤,或使用如“tutorial”、“step-by-step”、“getting started”、“how-to”等表述时适用。

主要能力

该技能通过结构化 SOP 流程生成教程,共分八个阶段:

  1. 主题定位与受众分析:解析主题,识别核心技术、操作目标和预期产出物;可提出最多 4 个澄清问题(读者技术水平、操作系统环境、完成后能做什么、版本或技术栈约束);若用户要求跳过澄清,则基于默认假设继续。输出教程元信息摘要(主题、受众、目标、范围,不超过 150 字)。
  2. 前置知识梳理:分析知识依赖,按“必须掌握”和“了解即可”两个层次分类,每项附带一句话说明“为什么需要它”。若前置知识超过 5 项,考虑缩小范围或拆分为系列教程。
  3. 环境搭建:列出所有需要安装/配置的工具及推荐版本,区分“必须安装”和“可选安装”;按操作系统分别给出安装命令,每条命令前说明其作用;每个工具安装后提供验证命令和预期输出。
  4. 核心步骤:将操作拆分为 5-10 个步骤,按依赖关系排序;每步包含步骤编号、标题、目标说明、操作、解释和验证;代码块标注语言类型,占位符使用全大写加下划线格式;前 1-3 步为最小可运行示例,中间步骤加入真实场景特性,最后 1-2 步组合成完整示例。
  5. 常见报错与排查:列出 5-8 个最常见报错场景,每条包含完整错误信息、原因、解决方案和验证修复;错误信息必须真实存在,解决方案具体可操作。
  6. 进阶拓展:推荐 3-5 个进阶方向,标注难度等级(中级/高级),附推荐资源;提供 2-3 个实战项目建议;给出 3-5 条最佳实践提示。
  7. Cheatsheet 速查表:提炼教程精华为一页速查表,包含环境信息、常用命令、常用代码片段和快速排错;总长度控制在可打印的 2 页 A4 纸以内。
  8. 文档组装与输出:将前七个阶段的产出组装成完整教程文档,包含教程概览、前置知识、环境搭建、核心步骤、常见报错与排查、进阶拓展、Cheatsheet 速查表和附录(术语表、参考链接)。

使用方式

用户只需提供技术主题或操作目标,Agent 按照 SOP 流程自动生成完整教程。示例:用户输入“帮我写一个 Docker 入门教程”,Agent 按 SOP 流程输出完整技术教程和 Cheatsheet。

根据用户输入的详细程度,技能会选择不同交互模式:

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

如果用户对教程有反馈,技能会定位反馈涉及的 Phase,从该 Phase 重新执行,并向下级联更新所有受影响的内容,保持步骤编号的连续性。

适用场景

本教程生成器适用于以下类型的技术教程:

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

限制

技能包含质量检查清单,要求:前置知识清单完整无知识断层;环境搭建步骤每条命令都有验证方式;核心步骤每步包含“操作 + 解释 + 验证”三部分;步骤之间依赖关系正确;常见报错不少于 5 个且解决方案具体可操作;进阶方向至少 3 个并附资源推荐;Cheatsheet 可独立使用;所有代码块标注语言类型;不包含任何硬编码的密钥、token 或个人路径;不包含可能导致安全问题的操作建议(如 chmod 777);不依赖任何付费 API 或需要付费订阅的工具(除非该工具本身是教程主题)。

关于该技能的安装方式、平台支持、收费模式等信息,资料中暂未提供。