57 lines
2.4 KiB
Markdown
57 lines
2.4 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"
|
|
|
|
Features:
|
|
- Produce conformant OKF bundles from a pasted/exported schema, docs, or a research topic
|
|
- Validate a bundle for OKF v0.1 conformance + broken-link report
|
|
- Visualize a bundle as a self-contained interactive graph
|
|
version: "1.0"
|
|
author: OurDigital
|
|
environment: Desktop
|
|
---
|
|
|
|
# OurDigital OKF (Desktop)
|
|
|
|
Work with **Open Knowledge Format (OKF) v0.1** — an open standard that represents knowledge
|
|
as a directory of markdown files with YAML frontmatter. Each file is a *concept* (table,
|
|
dataset, metric, playbook, API, reference); the path is its identity; markdown links form a
|
|
graph. The only required frontmatter field is `type`.
|
|
|
|
## What this skill helps with
|
|
|
|
- **Produce** — draft a conformant OKF bundle from a pasted/exported schema (BigQuery DDL,
|
|
GA4 export schema, CSV/JSON-Schema/OpenAPI), from existing docs/markdown, or from a
|
|
research topic. Write one `type`-bearing concept per file, cross-link them with
|
|
bundle-relative links, and add an `index.md` per directory for progressive disclosure.
|
|
- **Validate** — check that every non-reserved `.md` has a parseable frontmatter block
|
|
with a non-empty `type`; treat broken cross-links as tolerated warnings.
|
|
- **Visualize** — render the bundle as a concept graph.
|
|
|
|
## OKF authoring rules (summary)
|
|
|
|
- One concept per file; `type` is required; add `title`, `description`, `resource`,
|
|
`tags`, `timestamp` when applicable.
|
|
- Reserved filenames: `index.md` (directory listing), `log.md` (date-grouped history).
|
|
- Cross-link with bundle-relative paths (`/tables/customers.md`); broken links are allowed.
|
|
- Conventional body headings: `# Schema`, `# Examples`, `# Citations`.
|
|
|
|
## Scripts
|
|
|
|
The validator and visualizer are Python standard-library scripts in `code/scripts/`. In
|
|
the Claude Desktop environment, run them from a terminal:
|
|
|
|
```bash
|
|
python3 code/scripts/okf_validate.py <bundle>
|
|
python3 code/scripts/okf_viz.py --bundle <bundle>
|
|
```
|
|
|
|
Always confirm the output directory with the user before creating a bundle. See
|
|
`code/references/okf-spec-v0.1.md` for the full authoring rules.
|