用途:把智能体后续会阅读的开发文档统一记录为 OKF 文档包。适用于设计决策(ADR)、设计书与规范、实现计划、调查与验证记录、运行手册、参考资料、经验教训、术语表等,不限于 ADR 或术语表。README、CLAUDE.md/AGENTS.md、生成物和代码注释不在范围内。
主要能力:以 frontmatter 为唯一事实来源(SSoT),index.md 和面向人的表格视为由 frontmatter 生成的派生物。OKF SPEC v0.1 要求 frontmatter 必填键仅为 type,title/description/tags/timestamp 可选;status、timestamp 等标量元数据放在 frontmatter,不写进正文散文;index.md 与 log.md 为保留文件名,log.md 日期用 ISO 8601;index.md 和生成表格不得手工编辑。
使用方式:脚本均为 python3 单文件、无依赖。okf_validate.py --bundle-root DIR 校验 frontmatter(必填 type、ISO timestamp,支持 --require、--exclude、--skip-missing);okf_index.py --bundle-root DIR --index 生成 index.md;okf_index.py --bundle-root DIR --table --columns ... --link-column ... 生成以 frontmatter 键为列的 Markdown 表格;--check 只校验生成物是否最新(漂移检测),--table-output 目标含 <!-- OKF-TABLE:START --> / <!-- OKF-TABLE:END --> 标记时只替换标记之间内容。--skip-missing 用于渐进迁移,允许无 frontmatter 的旧文档,仅对已加 frontmatter 的文档强制校验。
工作流:新增、编辑或改号文档后,先运行校验补齐 frontmatter,再重新生成索引与表格,最后连同生成物一起提交。由智能体判断触发,不依赖 CI 自走;允许索引暂时过时,但生成是确定性的,不会产生内容漂移。
限制:项目特有的 REFERENCE-DRIFT(代码比概念更新)检测依赖各项目的 enactment surface,不在本技能范围内,需由项目专用工具承担。type 词表可由项目固定,但新文档必须带 frontmatter。其他细节暂未提供。