SuperAPI AI 工具集

open-knowledge-pack-codebase-wiki

智能体与模型

查看项目

更新于 10-15 22:38

技能介绍

用途:Codebase Wiki 项目(codebase-wiki 起始包)的工作指南。该项目在仓库内保存一份由编码智能体阅读源码后编写的、可导航且含图表的源码依据型 Wiki,Markdown 位于 wiki/ 下,可版本控制与 diff,默认私有,人机可共同编辑,并可作为未来智能体会话的持久依据上下文。没有独立问答界面,问答即“OK 依据的智能体 + 搜索”。本技能是包级指导,平台 open-knowledge 技能(读写/预览/链接/依据规则)仍约束所有 Markdown 操作。

结构:wiki/OVERVIEW.md 为枢纽,含总体架构图与导航图,frontmatter 携带 profile(受众/深度)与 source_commit(新鲜度锚点);log.md 为仅追加的生成/刷新审计记录;architecture/ 系统边界、分层、子系统与横切关注点;modules/ 每个包或模块一页;flows/ 关键端到端流程的时序/流程图与叙述;concepts/ 领域术语与核心抽象的原子词条;guides/ 面向任务的“如何/在哪改 X”。

生成与刷新:不要随意手写,先读 references/generate-and-refresh.md 并遵循分阶段、带 STOP 门控的流程。自动检测模式:OVERVIEW.md 为桩(source_commit 为空)则生成(调研→总览→架构→模块→流程→概念→链接图审计);已有 source_commit 则刷新(diff source_commit..HEAD,仅更新受影响页面并重新打戳)。两套工具:用原生工具(Read/Grep/Glob/Bash)读源码,OK MCP 不索引非 Markdown 源码;用 OK MCP 动词编写与审计 Wiki(write/edit 写页面,links/search 查图),切勿用原生 Write/Edit 手写 Wiki Markdown。

两个旋钮:从用户请求读取并记录在 OVERVIEW.md frontmatter 的 profile: <audience>/<depth>,以保持刷新一致。audience 为 internal(默认)或 public;public 要求文风精炼、不含机密/内部基础设施/工单号,并使用 GitHub URL 源码引用。depth 为 tour | standard(默认)| exhaustive,决定覆盖范围。

源码引用约定:Wiki 内导航用 OK 文档链接以构建反向链接/枢纽/孤儿图,应多链接;代码引用用相对链接加符号 code-span(内部)或 GitHub blob URL(公开)。源码文件链接不进入导航图,但错误深度路径会在 write/edit 的 brokenLinks 响应中暴露,需从页面所在文件夹计算 ../ 跳数,切勿虚构路径,只引用实际读过的文件。完整规则见 references/generate-and-refresh.md。

各文件夹规则:architecture/ 每个架构领域一页,含 mermaid 系统上下文或组件图、关键组件与设计决策,使用 architecture-page 模板,tour 深度时模块并入此处;modules/ 每个包或模块一页,含用途、职责、公共 API/入口、关键文件、依赖与参与流程,使用 module-page 模板,tour 时跳过;flows/ 关键端到端序列的 mermaid 时序/流程图与叙述,使用 flow-page 模板,exhaustive 时增加失败模式章节,并链接所经每个模块与概念;concepts/ 原子词条页,每页一个术语,含定义、重要性、代码位置,使用 concept-page 模板,保持小而密集互链;guides/ 面向任务的“如何/在哪改 X”演练,含目标、步骤、相关代码与注意事项,使用 guide-page 模板,standard 时填充,exhaustive 时丰富,tour 时稀少或为空。

新鲜度纪律(必须):OVERVIEW.md frontmatter 的 source_commit 是上次生成/刷新所依据的 git HEAD,是新鲜度锚点;刷新模式 diff source_commit..HEAD 仅更新受影响页面后重新打戳。每次生成或刷新后必须重新打戳,过期锚点会静默破坏增量刷新。

日志纪律(必须):wiki/log.md 为仅追加审计记录,每次生成或刷新追加一条带日期条目(每次运行一条,而非每页一条),用 Markdown 链接引用所涉页面以登记反向链接图。条目形如:## YYYY-MM-DD: <generate | refresh>,下列 Profile、source_commit、Coverage、Pages。

模板:每个文件夹附带起始模板(architecture-page、module-page、flow-page、concept-page、guide-page),用 write({ document: { path, template: "<name>" } }) 创建。模板仅含结构(标题与 frontmatter 骨架),各章节用途见上文与 references/generate-and-refresh.md,不在正文重复。

限制:资料未提供具体安装命令、收费、价格、平台或效果信息。