66 lines
2.6 KiB
Markdown
66 lines
2.6 KiB
Markdown
---
|
|
name: ourdigital-okf
|
|
description: |
|
|
Produce, visualize, and validate Google Open Knowledge Format (OKF) v0.1
|
|
knowledge bundles. Activated with the "ourdigital" or "our" keyword for OKF work.
|
|
|
|
Triggers (ourdigital or our prefix):
|
|
- "ourdigital okf", "our okf"
|
|
- "ourdigital open knowledge format", "our knowledge bundle"
|
|
- "ourdigital okf 만들기", "our okf 검증", "our okf 시각화"
|
|
|
|
Features:
|
|
- Produce conformant OKF bundles from a pasted/exported schema, a docs folder, or a research topic
|
|
- Validate a bundle for OKF v0.1 conformance + broken-link report
|
|
- Visualize a bundle as a self-contained interactive graph (viz.html)
|
|
version: "1.0"
|
|
author: OurDigital
|
|
environment: Both
|
|
---
|
|
|
|
# OurDigital OKF
|
|
|
|
Work with **Open Knowledge Format (OKF) v0.1** — Google's open, vendor-neutral standard
|
|
for representing knowledge as a directory of markdown files with YAML frontmatter. Each
|
|
file is a *concept* (table, dataset, metric, playbook, API, reference); the file path is
|
|
its identity; markdown links make the directory a graph. The only required field is
|
|
`type`.
|
|
|
|
This skill has three modes:
|
|
|
|
- **produce** — Claude drafts a conformant OKF bundle from one of three inputs: a
|
|
pasted/exported **schema** (BigQuery DDL, GA4 export schema, CSV/JSON-Schema/OpenAPI), a
|
|
**docs/markdown** folder, or a **research topic** (via `/reference-curator`). It plans a
|
|
concept hierarchy, writes one `type`-bearing concept per file, cross-links them, and
|
|
generates `index.md` files — then self-validates.
|
|
- **validate** — lint a bundle for OKF v0.1 conformance (parseable frontmatter + non-empty
|
|
`type`) and report broken cross-links as warnings.
|
|
- **visualize** — render a bundle as a self-contained interactive graph in one HTML file.
|
|
|
|
## Quick start
|
|
|
|
```bash
|
|
# Validate
|
|
python3 code/scripts/okf_validate.py <bundle> [--json]
|
|
|
|
# Visualize → writes <bundle>/viz.html (or --out PATH)
|
|
python3 code/scripts/okf_viz.py --bundle <bundle> [--name "Display Name"]
|
|
```
|
|
|
|
The scripts are Python standard-library only — no install needed.
|
|
|
|
## Where to look
|
|
|
|
- **Detailed mode flows:** `code/SKILL.md` (the Claude Code variant).
|
|
- **Authoring authority:** `code/references/okf-spec-v0.1.md` — read before producing.
|
|
- **Field guidance:** `code/references/frontmatter-fields.md`.
|
|
- **Templates:** `code/assets/{concept,index,log}.md`.
|
|
- **Design + plan:** `DESIGN.md`, `docs/IMPLEMENTATION-PLAN.md`.
|
|
|
|
## Guardrails
|
|
|
|
- Confirm the output directory with the user before creating it.
|
|
- A bundle is "done" only after the validator reports CONFORMANT with zero errors.
|
|
- Verified against Google's reference bundles at
|
|
`~/Documents/reference-library/open-knowledge-format/okf/bundles/`.
|