SuperAPI AI 工具集

okf

写作与研究

查看项目

更新于 10-16 08:47

技能介绍

OKF 是一个用于在代码仓库中读取、初始化或更新 Open Knowledge Format(OKF)文档包的技能。编辑前应先阅读技能目录下的 references/SPEC.md,该文件是 OKF v0.1 一致性的事实来源。

用途:把仓库文档组织为树状 OKF 包,默认根目录为 ./docs,除非用户另指定。OKF 包由带 YAML frontmatter 的 Markdown 概念文档,以及用于导航和历史记录的 index.md、log.md 组成。

三个工作流:/okf read 只读加载项目上下文,供规划或改代码前使用;/okf init 把现有文档重整为符合 OKF 的 ./docs 包,并写入 AGENTS.md 指南;/okf update 在会话、特性分支或 PR 结束时更新文档包。

必需结构:./docs 下需有 index.md(顶层路线图与渐进披露索引)、log.md(最新在前的更新历史)、specs/(含 index.md 路线图与 log.md)以及 adrs/(架构决策记录,含 index.md 与 log.md,即使暂无 ADR 也要初始化)。可按需增加 architecture/、guides/、reference/、runbooks/、domains/、research/ 等可选目录。

概念文档规则:./docs 下除 index.md、log.md 外的 Markdown 均为概念文档,需 YAML frontmatter,type 为必填,尽量补全 title、description、tags、timestamp;type 可用 Spec、Plan、ADR、Guide、Runbook、Reference、Architecture Note、Domain Concept、Research Note。更新已有文档时保留未知 frontmatter 键。

交叉链接:用标准 Markdown 链接表达持久关系,优先使用包内相对根路径链接(如 /specs/auth-redesign.md),必要时双向链接;不得编造关系,无法确认时应询问。

验证:可用时运行 python <skill-dir>/scripts/validate_okf.py <repo-root>,损坏的本地链接可加 --strict-links 使其失败而非警告。

限制:/okf read 期间不得编辑文件、更新日志或新建文档;移动 README.md、CONTRIBUTING.md、AGENTS.md 等根级文件、删除文档、编造产品方向或路线图承诺前,须先询问用户;不确定文档是否迁移时应先澄清。