SuperAPI AI 工具集

okf

通用与其它

查看项目

更新于 10-16 00:21

技能介绍

用途:OKF 将知识(数据与系统的元数据和上下文)表示为一个 Markdown 文件目录,每个文件带 YAML frontmatter。无需 schema 注册表、SDK 或必需工具,能 cat 文件即可读,能 git clone 即可分发。权威规范为 OKF v0.1。

核心模型:Bundle 是 Markdown 文件目录树,是分发单位;Concept 是一个知识单元,即一个 Markdown 文件;Concept ID 是文件在 bundle 内的路径去掉 .md,路径即身份,移动或重命名会破坏所有入链;Links 是概念间的标准 Markdown 链接,关系类型写在正文中,推荐以 / 为根的 bundle 相对链接;保留文件为 index.md(目录列表)和 log.md(更新历史),这两个文件名不得用作概念文档。概念文档由 --- 分隔的 YAML frontmatter 加 Markdown 正文组成,type 字段必填且非空。

主要能力:从零创建 bundle,按类型建立浅层目录;编写概念文档;用 / 根链接交叉引用;为每个目录写 index.md 实现渐进披露;校验一致性;可选添加 log.md、作为 git 仓库分发或用可视化工具渲染。

使用方式:创建 bundle 目录并选择布局;每个知识单元写一个概念文档;交叉链接;写 index.md;运行 python3 scripts/validate_okf.py <bundle-dir> --strict 校验。加 --check-links 可审计悬空链接,仅作提示,不影响 CONFORMANT 结论。

限制:规范 §9 一致性只要求非空 type;参考工具更严格,要求 type、title、description、timestamp 均为真值,默认写全四个字段更兼容。校验不检查 index.md/log.md 内部结构。OKF 设计宽松,容忍未知类型、额外键和断链,断链视为尚未编写的知识而非错误。log.md 仅手工编写,无工具生成。