Open Knowledge Format Skill

中文文档

A reusable Agent Skill for creating, validating, converting, and maintaining Open Knowledge Format knowledge bundles.

OKF represents knowledge as Markdown files with YAML frontmatter, directory-level indexes, update logs, citations, and normal Markdown cross-links. This skill helps AI coding agents and knowledge agents turn scattered project context into portable, human-readable, agent-readable knowledge bundles.

Status

Initial v0.1 skill for OKF bundle creation, conversion, validation, and maintenance.

What this skill does

• Creates OKF bundles from project docs, schemas, APIs, metrics, runbooks, and wiki content.
• Converts existing material into one-concept-per-file Markdown documents.
• Validates OKF v0.1 conformance.
• Generates concept documents with YAML frontmatter.
• Generates index.md files for progressive disclosure.
• Generates log.md files for traceable knowledge changes.
• Adds citations, cross-links, examples, tags, and schema sections.
• Designs OKF bundle structures for data, software, product, and enterprise knowledge systems.

When to use

Use this skill when you need to turn scattered project context into an OKF-compatible knowledge bundle for agents, developers, data teams, or documentation systems.

Typical use cases:

• Creating an OKF bundle for a software project.
• Converting API docs, schemas, metrics, and runbooks into OKF concept files.
• Validating whether a directory follows OKF v0.1.
• Generating index.md and log.md files for an OKF bundle.
• Preparing agent-readable project context for coding agents, data agents, or internal knowledge tools.

Install / Use

Install with the skills CLI:

npx skills add hu-qi/OpenKnowledgeFormat-Skill

Or copy SKILL.md into your agent's skill directory manually.

Typical local layout:

.codex/skills/open-knowledge-format/SKILL.md

Example prompts

Create an OKF bundle for this Vue + mock data dashboard project.

Convert these API docs and data schema notes into OKF concept files.

Validate this okf/ directory against OKF v0.1 and report errors and warnings.

Generate index.md and log.md files for this OKF bundle.

Repository structure

.
├── SKILL.md
├── README.md
├── README.zh-CN.md
├── LICENSE
├── CHANGELOG.md
├── CONTRIBUTING.md
├── CODE_OF_CONDUCT.md
├── SECURITY.md
├── examples/
│   └── software-project-okf/
├── templates/
│   └── concept.md
└── .github/
    ├── ISSUE_TEMPLATE/
    │   ├── bug_report.md
    │   └── request.md
    └── pull_request_template.md

OKF references

• Google Cloud blog: How the Open Knowledge Format can improve data sharing
• OKF README
• OKF SPEC

License

MIT