okf-knowledge-format
Author and validate knowledge as OKF (Open Knowledge Format) bundles — a directory of markdown files with YAML frontmatter, where every concept is one .md file with a REQUIRED `type` field, reserved index.md/log.md files, bundle-relative cross-links, and a permissive conformance
Install
npx skills add https://github.com/ejklock/living-docs-skill/tree/main/skills/okf-knowledge-format
claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install ejklock-living-docs-skill@llmmart
git clone https://github.com/ejklock/living-docs-skill.git
The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole ejklock/living-docs-skill collection as a plugin from our marketplace. Git is the plain clone.
Skill manifest
OKF — Open Knowledge Format
Represent knowledge as an OKF bundle: a directory tree of UTF-8 markdown files with YAML frontmatter, designed to be read by humans, written by agents, and exchanged across organizations with no required tooling. "If you can cat a file, you can read OKF." This skill is the repo's standard for how knowledge markdown is structured — frontmatter shape, reserved files, cross-links, and conformance.
The authoritative rules live in the vendored spec at reference/SPEC.md (OKF v0.1). This SKILL.md is the operational summary; when a detail is ambiguous, open reference/SPEC.md and follow it.
Provenance — not ours. OKF is a published, vendor-neutral standard from Google Cloud Platform (OKF v0.1, 2026-06-12), not a format coined in this repo. We adopt and vendor it (
reference/SPEC.mdis refreshed from upstream viascripts/update-spec.sh). Source: GOOGLE CLOUD PLATFORM, Open Knowledge Format — Specification v0.1 — full citation in../../references/prior-art-landscape.md.
Using this skill (progressive disclosure)
This SKILL.md is a slim stub — a trigger plus a task->topic router. The living-docs CLI holds the full OKF details and discloses them progressively. Before authoring anything, load the topic for your task:
living-docs read guide --list— discover every topic.living-docs read guide <topic> --skill okf-knowledge-format— load that topic.
Piped output is minified JSON (machine default); --plain for human text, --json to force JSON. Topics: conformance, model, procedure, concept, index, log, about. The vendored spec lives at reference/SPEC.md.
This stub is a pure router (ADR 0017): it triggers and points at topics — it holds no rules inline. The five conformance hard rules that define OKF (§9) are a topic, not stub prose; load them before authoring or checking a bundle: living-docs read guide conformance --skill okf-knowledge-format.
When to invoke
- Standing up a new knowledge bundle/catalog, or organizing existing markdown knowledge into one.
- Reviewing the five conformance hard rules that define OKF (§9) →
living-docs read guide conformance --skill okf-knowledge-format. - Writing a concept document or normalizing its frontmatter →
living-docs read guide concept --skill okf-knowledge-format. - Adding or regenerating a directory
index.md→living-docs read guide index --skill okf-knowledge-format; or alog.md→living-docs read guide log --skill okf-knowledge-format. - Deciding how to cross-link concepts, cite sources, name a
type, or reviewing the core model / frontmatter fields / bundle structure →living-docs read guide model --skill okf-knowledge-format. - Checking a corpus for OKF conformance, authoring a concept or maintaining a directory step by step, or refreshing the vendored spec from upstream (
scripts/update-spec.sh) →living-docs read guide procedure --skill okf-knowledge-format.
Files (living-docs-skill)
-
reference
-
SPEC.md 14.7 KB
Loading… -
SPEC.source.md 596 B
Loading…
-
-
rules
-
about.md 589 B
Loading… -
conformance.md 1.1 KB
Loading… -
model.md 3.2 KB
Loading… -
procedure.md 2 KB
Loading…
-
-
scripts
-
update-spec.sh 2.8 KB
Loading…
-
-
templates
-
concept.md 895 B
Loading… -
index.md 555 B
Loading… -
log.md 515 B
Loading…
-
-
SKILL.md 3.8 KB
--- name: okf-knowledge-format description: Author and validate knowledge as OKF (Open Knowledge Format) bundles — a directory of markdown files with YAML frontmatter, where every concept is one .md file with a REQUIRED `type` field, reserved index.md/log.md files, relative cross-links, and a permissive conformance model. Use when standing up or maintaining a knowledge bundle/catalog, writing or normalizing a concept document's frontmatter, deciding how to structure markdown knowledge for agents to consume, or checking a corpus against OKF conformance. The canonical spec is vendored under reference/SPEC.md and refreshed from GitHub via scripts/update-spec.sh. version: "0.1" metadata: type: skill layer: procedural tags: [documentation, knowledge-format, okf, frontmatter, metadata, conformance] --- # OKF — Open Knowledge Format Represent knowledge as an **OKF bundle**: a directory tree of UTF-8 markdown files with YAML frontmatter, designed to be read by humans, written by agents, and exchanged across organizations with no required tooling. "If you can `cat` a file, you can read OKF." This skill is the repo's standard for *how knowledge markdown is structured* — frontmatter shape, reserved files, cross-links, and conformance. The authoritative rules live in the vendored spec at `reference/SPEC.md` (OKF v0.1). This SKILL.md is the operational summary; when a detail is ambiguous, open `reference/SPEC.md` and follow it. > **Provenance — not ours.** OKF is a published, vendor-neutral standard from **Google Cloud Platform** (OKF v0.1, 2026-06-12), not a format coined in this repo. We adopt and vendor it (`reference/SPEC.md` is refreshed from upstream via `scripts/update-spec.sh`). Source: GOOGLE CLOUD PLATFORM, *Open Knowledge Format — Specification v0.1* — full citation in `../../references/prior-art-landscape.md`. --- ## Using this skill (progressive disclosure) This SKILL.md is a **slim stub** — a trigger plus a task->topic router. The `living-docs` CLI holds the full OKF details and discloses them progressively. **Before authoring anything, load the topic for your task:** - `living-docs read guide --list` — discover every topic. - `living-docs read guide <topic> --skill okf-knowledge-format` — load that topic. Piped output is minified JSON (machine default); `--plain` for human text, `--json` to force JSON. Topics: conformance, model, procedure, concept, index, log, about. The vendored spec lives at reference/SPEC.md. This stub is a **pure router** (ADR 0017): it triggers and points at topics — it holds no rules inline. The **five conformance hard rules** that define OKF (§9) are a topic, not stub prose; load them before authoring or checking a bundle: `living-docs read guide conformance --skill okf-knowledge-format`. --- ## When to invoke - Standing up a new knowledge bundle/catalog, or organizing existing markdown knowledge into one. - Reviewing the **five conformance hard rules** that define OKF (§9) → `living-docs read guide conformance --skill okf-knowledge-format`. - Writing a **concept document** or normalizing its frontmatter → `living-docs read guide concept --skill okf-knowledge-format`. - Adding or regenerating a directory **`index.md`** → `living-docs read guide index --skill okf-knowledge-format`; or a **`log.md`** → `living-docs read guide log --skill okf-knowledge-format`. - Deciding how to cross-link concepts, cite sources, name a `type`, or reviewing the core model / frontmatter fields / bundle structure → `living-docs read guide model --skill okf-knowledge-format`. - Checking a corpus for **OKF conformance**, authoring a concept or maintaining a directory step by step, or refreshing the vendored spec from upstream (`scripts/update-spec.sh`) → `living-docs read guide procedure --skill okf-knowledge-format`.
Comments (0)
Sign in to join the conversation.
Reviews (0)
No reviews yet.
No comments yet.