SuperAPI AI 工具集

tutorial-writing

写作与研究

查看项目

更新于 10-16 03:40

技能介绍

用途:tutorial-writing 用于生成详尽的实现教程文档,帮助开发者采用“教程文档 + 自己动手实现”的工作流,在实现过程中保持对代码的掌控并学习代码库。它输出 Markdown 文档,不生成代码改动,定位是教学而非代做。

主要能力:先向用户确认要实现的功能与教程保存路径,然后深入调研代码库,包括架构与目录结构、既有约定与模式、2-3 个相似实现、依赖与可用 API、测试方式、相关类型与 schema,并要求引用具体文件与行号。随后按固定结构生成教程:概述、背景与上下文、技术全景、设计理由、实现里程碑、测试策略、风险与缓解、延伸方向、参考。每个里程碑包含目标、排序理由、需创建或修改的文件、实现思路、验证清单与检查点。

使用方式:以 /tutorial 加需求描述调用,例如 /tutorial Add dark mode support to the component library。技能会先询问输出路径并给出默认建议,再把完整教程写入指定路径,最后总结产出并建议后续步骤。

适用场景:为现有项目新增功能、重构数据获取层、引入实时通知、补充错误边界等需要理解代码库上下文的实现任务。

限制:资料未提供具体安装命令、收费方式、支持平台与效果数据;其质量依赖对代码库的调研深度,且不直接产出可运行代码。