SuperAPI AI 工具集

knowledge-base

编程与开发

查看项目

更新于 10-15 21:36

技能介绍

用途:消除软件工程中的“知识诅咒”——资深开发者默认新人“应该知道”的上下文、代码中充斥领域缩写、架构决策背景被遗忘。该技能强制把默会知识转为显性知识,统一领域词汇,记录“为什么这样做”而不仅是“怎么做”。

主要能力:一是智能扫描,集成 ace-tool 分析代码库,识别高频词汇、类名和复杂逻辑,输出推荐创建的概念列表到 docs/knowledge/suggested_concepts.md;二是结构化文档,提供模板,强制包含 Definition(一句话定义)、Context(场景)、Anti-patterns(常见误解)、References(代码或外部链接);三是行业共识集成,通过 external 目录管理通用知识(如 RESTful 规范、React Hooks 规则),并标明项目是遵循标准还是有定制;四是术语表维护,扫描 concepts/ 下文档提取 Definition,生成扁平化 GLOSSARY.md 表格;五是索引生成,支持多层级显示。

使用方式:技能目录位于 ~/.pi/agent/skills/knowledge-base/,主脚本为 lib.ts,知识库存放于项目根目录 ./docs/knowledge/,分 concepts、guides、decisions、external 四类目录。命令建议在项目根目录执行: bun ~/.pi/agent/skills/knowledge-base/lib.ts init bun ~/.pi/agent/skills/knowledge-base/lib.ts scan bun ~/.pi/agent/skills/knowledge-base/lib.ts discover bun ~/.pi/agent/skills/knowledge-base/lib.ts create concept "UserAuthentication" auth/user bun ~/.pi/agent/skills/knowledge-base/lib.ts create guide "ErrorHandling" backend/api bun ~/.pi/agent/skills/knowledge-base/lib.ts create decision "WhyUsePostgres" database bun ~/.pi/agent/skills/knowledge-base/lib.ts search "关键词" bun ~/.pi/agent/skills/knowledge-base/lib.ts glossary bun ~/.pi/agent/skills/knowledge-base/lib.ts index create 支持无限层级分类路径。

适用场景:新人入职时阅读 index.md 并记录困惑点;代码 Review 中若解释逻辑超过三句即创建 guide 并链接;遇到不懂的缩写立即创建 concept 文档。

限制:依赖 bun 运行时、ace-tool 与网络搜索;文档存储在本地 docs/knowledge/ 目录;其收费方式、平台兼容范围、具体版本要求等资料暂未提供。