用途:说明如何在 OKF 起步项目(okf 起步包)中工作,使知识库从首次提交起就符合 Google 开放知识格式 OKF v0.1。项目已预置合规结构,但并非强制校验:OpenKnowledge 的原生 frontmatter 模式保持开放形态,不做 lint,作者可自由撰写。
主要约定:每个非保留文档的 frontmatter 必须含非空 type 值,这是唯一的一致性契约。值可自定,如 concept、reference、note、person、event 等,无官方分类表;无更合适值时可用 Document 作为通用兜底。文件夹模板已为各分区预设 type,可用 write({ document: { path, template: "<name>" } }) 创建并继承。
目录:concepts/ 存放持久概念与定义,type 为 concept;references/ 存放外部来源与引用,type 为 reference;notes/ 存放工作笔记与观察,type 为 note。
链接:鼓励使用标准 Markdown 链接 text,链接形成的图谱是核心价值,标准链接可移植到任何 OKF 消费者。OpenKnowledge 也接受 [[wiki-link]] 简写作为原生超集并逐字节保留,但种子内容使用标准链接以保持开箱合规。
保留文件:项目根目录两个小写文件不得含 frontmatter,加任何 frontmatter 都会破坏一致性。index.md(OKF §6)为导航中枢,链接关键文档与分区,需随重要文档增加而更新;log.md(OKF §7)为变更历史,最新条目在前,格式为 ## YYYY-MM-DD: <summary>,创建、编辑或重构内容时添加条目。工具不会自动维护这两个文件,维护属于作者职责。
可移植性三要点:非保留文档具有非空 type;index.md 与 log.md 保持小写且无 frontmatter;链接使用标准 Markdown 或 wiki-link 语法。
限制:本技能是包级指引,平台的 open-knowledge 技能(读、写、预览、链接、接地规则)仍管辖每次 Markdown 操作,OKF 约定叠加其上。资料未说明收费、价格、平台支持范围及具体效果。