SuperAPI AI 工具集

okf-creator

写作与研究

查看项目

更新于 10-16 09:29

技能介绍

用途:将任意来源(代码库、文档站、数据表结构、笔记、PDF 抽取文本)整理成符合 OKF v0.2 且正文质量过关的知识包(bundle)。OKF 合规门槛很低(任何带 type 的 Markdown 即合规),本 Skill 的价值在于产出可读、可被智能体检索复用的知识。

主要能力:从零创建 OKF 知识库;为代码库或文档站生成知识文档;把零散笔记、Wiki、PDF 文本整理成概念库;校验并修复 bundle 的 OKF 符合性。

使用方式与工作流:先梳理来源、列出要捕获的概念清单;用 scripts/scaffold_okf.py 生成骨架(根 index.md、log.md 与目录);逐个写概念文档(头信息 type 必填,加结构化正文、交叉链接与必要的 # Citations);更新各级 index.md 与根 log.md;最后用 scripts/validate_okf.py <bundle> 校验至 0 错误。

核心原则:先定边界再动手,明确来源、消费者与覆盖概念;一个概念一个文件,路径即概念 ID,按领域组织;正文使用标题、列表、表格、代码块等结构,规范约定 # Schema、# Examples、# Citations 三个标题;概念间用 Markdown 链接互连,推荐包内绝对路径;写完自问无上下文者只读此篇能否使用。

代码与多媒体处理:代码概念 type 用 Repository、Package、Module、Class、Function、Interface、Config、Script、Notebook,加 language、symbol、signature 字段,resource 用带行号锚点的 permalink,关系用 calls:、depends-on:、deprecated-by: 前缀,正文必写 # Signature 与行为说明。PDF 与图片原件放 assets/,正文承载抽取文本、图说或 OCR 文本。

反模式:把整本文档塞进单个巨型文件;正文无结构;只贴代码不解释行为;图片不写图说;跳过校验脚本。

限制:详细字段、保留文件名与链接规则见 references/okf-spec-cheatsheet.md;OKF 对代码、PDF、图片的原生支持较弱,需按本 Skill 约定补充。相关 Skill 有 awesome-to-okf、book-to-okf、okf-to-book。