SuperAPI AI 工具集

okf

写作与研究

查看项目

更新于 10-16 09:55

技能介绍

OKF(Open Knowledge Format)是一种以「目录中的 Markdown 文件 + YAML frontmatter」表示知识的形式,设计上极简:没有 schema registry、没有运行时、没有 SDK。该技能的目标是产出、维护和消费符合规范(v0.2)的知识包,而非凭记忆操作;非琐碎工作前应先读规范 reference/SPEC.md。

用途与场景:把代码、README、docstring、配置、文档/维基、以及决策、手册、指标等沉淀为结构化概念文件,实现「知识即代码」。默认放在仓库根目录 .okf/ 下并与代码一同提交。

主要能力与约定:一个概念一个文件;文件路径(去掉 .md)即概念 ID。frontmatter 中 type 必填,可选 title、description、tags,以及仅当概念绑定真实资产时才写 resource。正文优先用结构化 Markdown(标题、表格、列表、代码块),惯用标题为 # Schema、# Examples、# Computation。交叉链接用标准 Markdown 链接,优先绝对包相对路径。保留文件为 index.md(目录清单,除包根 index 可带 okf_version 及 upkeep 标志外无 frontmatter)和 log.md(ISO 日期、最新在前,只记录生命周期事件,追加不重写)。v0.2 可选族包括 Trust(generated、verified,by 用 actor 约定)、Lifecycle(status、stale_after)、Provenance(sources、usage_window,脚注标签须匹配 sources[].id)、Attestation(type: Attested Computation,含 runtime 等)。v0.1 的 timestamp 与 # Citations 已分别被 generated.at 与 sources 取代。

三种模式:produce 新建或扩展包,可用 init 快速路径 uv run "${CLAUDE_SKILL_DIR}/scripts/okf_init.py" <target-dir> [--title "..."](目录已有 .md 时需 --force);maintain 同步现实,改动 body 与 generated.at、修链接、对已移除资产标 deprecated 并在 log.md 记录;consume 先读包根 index.md 渐进披露,再按链接深入相关概念,对 draft/deprecated、已过期 stale_after 或无 verified 的内容保持怀疑,需用 Attested Computation 的数字时按其参数运行计算,不要自己写查询。

验证:完成前用确定性检查器,/okf:validate <bundle-dir> --strict;若未安装则运行 uv run "${CLAUDE_SKILL_DIR}/../validate/scripts/okf_validate.py" <bundle-dir> --strict。必须解决所有 ERROR,--strict 下警告也会失败。

限制与说明:规范以 reference/SPEC.md 为准;除 type 与 frontmatter 可解析外均为软指导,消费者须容忍缺失可选字段、未知类型和坏链。其他细节资料暂未提供。