用途:按上游 OKF v0.2 规范创建、迁移、检查、查询、校验或维护知识包(bundle)。OKF 是互操作格式,不是领域分类法,也不替代 OpenAPI、schema、ADR 或 Diátaxis。
主要能力:先确定 bundle 根目录,仅根内 Markdown 属于该包。硬性要求包括:每个非保留 Markdown 概念都有可解析的 YAML frontmatter;每个概念 frontmatter 有非空 type;index.md 与 log.md 遵循保留结构。未知类型、缺失可选元数据、缺失索引或断链不视为硬错误,而作为生产者质量问题单独报告。
生产者规范:新写或实质修改的概念需 generated.by 与 generated.at(ISO 8601),不写 v0.1 的 timestamp;溯源放入 sources,每条需 resource,正文脚注引用时加稳定 id;不建旧式 # Citations 列表。仅在证据充分时添加 status、stale_after、verified、credibility 或 attestation,缺失即表示稳定,不得编造信任。保留未知字段,并校验变更的本地链接与外部来源。
操作方式:创建或转换时先盘点原子概念与路径,再交叉链接,写索引与日志。迁移 v0.1 到 v0.2 需改根声明为 okf_version: "0.2",替换 timestamp,迁移引用,转换日志格式。维护时更新事实、关系、generated、sources 与索引。查询从根 index.md 开始,按 type、title、description、tags、sources、status 等筛选,只读必要正文并引用概念路径。
校验:使用 Node.js 运行 node scripts/validate-okf.mjs /path/to/bundle;Workspace Package 场景可加 --workspace-root,并用 node scripts/generate-package-digests.mjs /path/to/repository 生成摘要。校验器发现 apps//package.json、benches/package.json、packages//package.json,每个清单需恰好一个 Workspace Package 概念且 workspace_package、resource、source_digest 匹配。报告分三类:一致性错误、生产者规范错误、警告。
限制:资料未提供具体安装步骤、收费与平台信息;使用前应完整阅读 references/okf-v0.2.md,联网时核对上游规范。