SuperAPI AI 工具集

code-tour

通用与其它

查看项目

更新于 10-15 21:08

技能介绍

用途:创建 CodeTour 格式的 .tour 文件,把代码库讲解变成可复用的引导式走查,直接跳转到真实文件与行范围。文件放在 .tours/ 目录,只生成 .tour JSON,不修改源代码。

主要能力:按读者角色定制叙事,包括新人上手、快速概览、架构讲解、PR 评审、根因分析、安全审查、功能解释、调试路径等,并给出建议步数(如新人 9-13 步、架构 14-18 步、快速概览 5-8 步)。步骤类型支持 content、directory、file+line、selection、pattern、URI。

使用方式:先探索仓库(README、入口点、目录结构、配置、变更文件),再推断读者角色与深度,然后核实每个文件路径与行号锚点真实有效,写入 .tours/<persona>-<focus>.tour,最后校验路径存在、行号有效、首步锚定真实文件或目录、叙事连贯。描述遵循 SMIG:情境、机制、影响、易忽略点。叙事弧线为定位、模块地图、核心执行路径、边界或陷阱、收尾与下一步。

限制:不修改源码;不用于一次性聊天解释、纯文字文档、实现或重构任务;行号不得猜测,易变文件优先用 pattern 锚点;首步不能是纯 content;步数需与仓库规模和角色深度匹配;monorepo 应限定相关包。官方上游格式为 microsoft/codetour。