SuperAPI AI 工具集

feature-map

编程与开发

查看项目

更新于 10-17 16:43

技能介绍

用途

feature-map 是 Onyx 仓库内的功能地图文档体系,位于 .agents/feature-map/ 目录。其目标是把 Onyx 的每个产品界面(product surface)整理成一份组件文档,回答三个问题:这个功能对用户呈现什么、背后对应哪些代码、一次改动可能影响或破坏什么。资料建议在修改代码之前先查阅它。

主要能力

每份组件文档包含多个部分,资料明确提及的有:

  • §1 与 §4:代码必须实现的行为;
  • §5 契约与不变量(Contracts and invariants):即使测试不失败也可能被改动破坏的规则;
  • §6 中的 [[component]] 链接:指向改动涉及的其他组件;
  • §7 影响范围(Blast radius):按改动类型需要一并检查的其他文件;
  • §9 已知陷阱(Footguns)。

此外还有三个索引与辅助文件:

  • PATHS.md:按代码路径查找组件,采用最长匹配前缀规则;没有对应行的路径即为未映射,需自行阅读最近的代码与测试;
  • INDEX.md:按功能名称浏览组件;
  • GLOSSARY.md:澄清术语。资料指出 Onyx 中 Persona、Tool、turn、SearchDoc 等词有不止一种含义,因此在信任某个名称之前应先查阅该术语表。

使用方式

  1. 定位组件:已知代码路径时查 PATHS.md,已知功能名时查 INDEX.md;确认术语含义时查 GLOSSARY.md。
  2. 修改代码前:阅读 .agents/feature-map/components/ 下对应的组件文档,重点关注 §1、§4、§5、§7、§9,并按 §6 的链接检查改动波及的其他区域。
  3. 审查 diff 或 PR 时:按 .agents/feature-map/VERIFYING.md 逐步执行,对每个受影响组件的 §5 中每条不变量给出结论,并报告无法验证的部分。
  4. 维护地图:若改动改变了组件文档所描述的行为,应在同一个 PR 中更新该文档;若新增代码路径,应在 PATHS.md 中补充对应行。引用只能使用真实存在的路径与符号,错误的引用比没有引用更糟。

适用场景

适用于 Onyx 项目的开发与代码审查流程:在改动功能前理解其行为与依赖,在评审 PR 时系统核对不变量,以及随代码演进同步维护功能文档。

限制

资料未提供安装命令、独立运行方式、平台支持、收费或价格信息。该工具以仓库内文档形式存在,依赖开发者按上述流程查阅与维护;对于未映射的代码路径,资料明确要求自行阅读最近的代码与测试。