Okf knowledge format

Skill ejklock/living-docs-skill/skills/okf-knowledge-format

Living Docs — a AI agent skill that runs your project's documentation as a living system: constitution, ADRs, BDRs, PRDs, issues, research notes & Mermaid architecture diagrams under five no-drift governance invariants. OKF-formatted, stack-agnostic. Works with Claude Code, Cursor, Copilot, OpenCode & Pi.

Install

npx -y skills add ejklock/living-docs-skill --skill okf-knowledge-format

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

2 things to look at

no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
8 stars8 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

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 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.

SKILL.md

3.7 KB, as published. Nobody here has run it

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 skill okf-knowledge-format --list — discover every topic.
living-docs skill okf-knowledge-format --topic <topic> — 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 skill okf-knowledge-format --topic conformance.

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 skill okf-knowledge-format --topic conformance.
Writing a concept document or normalizing its frontmatter → living-docs skill okf-knowledge-format --topic concept.
Adding or regenerating a directory index.md → living-docs skill okf-knowledge-format --topic index; or a log.md → living-docs skill okf-knowledge-format --topic log.
Deciding how to cross-link concepts, cite sources, name a type, or reviewing the core model / frontmatter fields / bundle structure → living-docs skill okf-knowledge-format --topic model.
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 skill okf-knowledge-format --topic procedure.