SuperAPI AI 工具集

knowledge-capture

编程与开发

查看项目

更新于 10-16 08:10

技能介绍

用途:在开发分析或实现过程中,把发现的可复用知识沉淀为文档,并按类型归档。

主要能力:三级目录结构——docs/domain/ 记录业务规则、领域逻辑、工作流、校验规则与权限;docs/patterns/ 记录技术模式、架构方案、代码结构与错误处理模式;docs/interfaces/ 记录外部 API 契约、第三方集成、Webhook 与数据交换格式。工作流要求先做去重:用 grep -ri "main keyword" docs/domain/ docs/patterns/ docs/interfaces/ 和 find docs -name "topic-keyword" 查找已有文档,找到则用 Edit 更新而非新建,避免文档碎片化。随后判定类别(业务逻辑/构建方式/外部服务),选择新建或更新,使用可搜索的描述性文件名,并套用 templates/ 下的 pattern-template.md、interface-template.md、domain-template.md。文档应包含标题与目的、上下文、细节、示例、参考链接,并在相关文档间交叉引用。完成后按固定格式报告创建或更新的文件、用途与动作。

维护:文档可能过时,可通过 Git 中文档与代码的修改时间比对检测,源码变更晚于文档即标记复审;价格、时长等未提供。还应在实现时同步维护:函数签名变更更新 API 文档,新公开 API 先写文档,破坏性变更更新全部引用并加迁移说明。

限制:资料未提供具体安装命令、平台或运行环境要求,也未说明收费方式;仅依赖 grep、find 等命令行工具与既定目录约定,实际效果取决于项目是否遵循该结构。