帮助中心

常见问题

查找关于 Open Knowledge Format、OKF 工具、验证和最佳实践的常见问题答案。

通用

FAQ

什么是 Open Knowledge Format?

Open Knowledge Format (OKF) 是 Google Cloud 发布的开放规范,用于将精选知识打包为带 YAML frontmatter 的 Markdown 文件目录。它让知识对人类和 AI 智能体都可读。

谁维护 OKF?

OKF 由 Google Cloud 数据团队发布,是采用 Apache-2.0 许可证的开放规范。社区贡献工具和实现。

OKF v0.1 稳定吗?

OKF v0.1 处于草案状态。核心格式可用,但随着社区反馈和更多实现的出现,规范可能会发生变化。

使用 OKF 工具

FAQ

如何验证我的 OKF 文档?

使用 OKF 校验器工具。粘贴你的 Markdown 内容,它会检查必需的 frontmatter、验证规则,并提供带详细分解的 OKF Score。

我可以从 Sitemap 批量生成 OKF 吗?

可以。网页转 OKF 生成器支持 Sitemap 模式。输入 sitemap.xml URL,它将处理最多 20 个页面,生成包含索引、日志和验证报告的完整 bundle。

什么是 OKF Score?

OKF Score 是一个 0-100 的指标,衡量三个维度的文档质量:结构(40%)、覆盖度(30%)和连接性(30%)。更高的分数表示结构更好、更完整的知识。

Live Badge 如何工作?

Live Badge 验证你已部署的 OKF 文档 URL,并生成显示当前 OKF Score 的 SVG 徽章。你可以将它嵌入 README 文件或文档中,以显示实时验证状态。

技术问题

FAQ

需要哪些 frontmatter 字段?

唯一必需的字段是 'type'。推荐字段包括 title、description、id、tags 和 source_url。查看校验器以了解缺失推荐字段的警告。

如何提高我的 OKF Score?

通过添加完整的 frontmatter(type、title、description、id、tags)来改善结构。通过编写带标题的详细内容来改善覆盖度。通过添加 source_url 和内部链接来改善连接性。

我可以在商业项目中使用 OKF 吗?

可以。OKF 在 Apache-2.0 许可证下发布,允许商业使用。你可以将它用于内部知识库、产品文档或公共 API。

相关 OKF 工具与指南