Skip to Content

Build OKF

Semantic vocabulary

The concept types and relationship types Docklee uses, so every concept and link means the same thing everywhere.

A link that just says "related" tells an engine very little. The semantic vocabulary gives every concept a precise type and every link a precise meaning, so an engine knows that a table joins with another table, or that a new policy supersedes an old one.

How it's used

  • Types are hierarchical. A database-table is a kind of data structure, which is a kind of concept, so a question can match at any level.
  • Variations are normalized. "DB table", "db_table", and "Database Table" all become database-table.
  • Questions map to types. A question about how data flows looks for tables, pipelines, and datasets, not playbooks.
  • Links are checked. Only relationship types that make sense between two concept types are kept.

Concept types

AreaTypes
Datadatabase-table, database-view, data-pipeline, data-model, dataset, schema
APIs and eventsapi-endpoint, api-schema, webhook, event, message-queue
Softwareservice, module, function, class, configuration, library
Businessmetric, kpi, playbook, process, policy, rule, decision-record, requirement
Peopleteam, role, person, department, vendor
Documentationdocument, guide, tutorial, faq, runbook, specification
Infrastructureservice-deployment, environment, dependency, resource, alert
Generalconcept

Relationship types

AreaTypes
Datajoins-with, references, contains, derived-from
Dependenciesdepends-on, required-by, imports, extends
Flowfeeds-into, produces, consumes, triggers, reads-from, writes-to
Structurehas-child, part-of, belongs-to, instance-of
Purposedocuments, implements, validates, monitors, configures
Changesupersedes, contradicts, preceded-by, evolved-from
Ownershipowned-by

supersedes and contradicts change how retrieval ranks. A superseded concept is dropped, and contradicting concepts are both returned and marked. See How OKF retrieval works.

When you write OKF content yourself, name things the way the vocabulary does. "The orders table joins the customers table" is turned into a typed link more reliably than "orders and customers are connected".

Next steps

You know the vocabulary. See how concepts are kept consistent next.

On this page