Example library

OKF examples you can copy

Start from practical OKF examples for websites, API docs, product documentation, support playbooks, SaaS metrics, and knowledge bases.

Example bundle types

The examples below show bundle shapes rather than official certification tests. Use them to choose folders, file boundaries, and review notes before creating your own Open Knowledge Format files.

Website examples show how to describe public pages, help pages, and policy pages.
API endpoint examples show how to add context around OpenAPI references without replacing the contract.
Support and policy examples show where escalation notes and owner review matter.
Data catalog examples show how to describe metrics, tables, owners, and freshness boundaries.

OKF file example

If you need a single Markdown file before a whole bundle, start with the OKF file example. It shows YAML frontmatter, body sections, validation checks, and common mistakes.

Minimal OKF file example

---
type: Documentation Topic
title: API rate limit policy
description: Explains the public rate limit rules, retry behavior, and related API documentation.
resource: https://openknowledgeformat.online/sample/api-rate-limits/
tags: [okf, api, rate-limits]
timestamp: 2026-06-21T00:00:00Z
---

# API rate limit policy

This file describes the stable knowledge a reader or AI agent needs before answering questions about API rate limits.

## Key facts

- Requests are limited per workspace and endpoint group.
- Retry behavior should follow the canonical API documentation.
- Support teams should escalate repeated limit errors to the API owner.

## Related links

- [OKF Validator](/okf-validator/)
- [API OKF template](/templates/api-okf-template/)

How to read an OKF example

Read type first to understand what concept the file represents.
Check title and description for a narrow, reviewable scope.
Use resource to trace the source page, API reference, policy, table, or stable identifier.
Treat tags as grouping hints, not proof that the file is complete.
Review the Markdown body for boundaries, examples, citations, and related links before copying the pattern.

Copy safely into a template

Pick the example closest to your source material.
Copy the bundle shape, not the sample facts.
Create one Markdown file per durable concept.
Validate each file before adding it to the bundle.
Review claims with the source owner before publishing.

Before you trust an example

OKF file example for a complete single-file starter.
OKF YAML frontmatter for field rules and examples.
OKF Validator for checking one Markdown file.
OKF Folder Validator for checking example bundles.
Validate OKF Bundle before publishing a copied pattern.
OKF Templates for copy-ready file starters.

Example

Website content bundle

Who it is for

A marketing and docs team wants agents to answer questions from public website pages without scraping every page from scratch.

Copy-ready example

Use the code block beside this note as the starting point, then update the sample paths and field values.

Field notes

`index.md` lists the bundle contents for progressive reading.
Each page file uses frontmatter fields for type, title, description, resource, tags, and timestamp.
Markdown links connect pricing, privacy, support, and product documents.

Common mistake

Copying entire HTML pages instead of clean Markdown summaries.
Missing canonical resource URLs.
Not separating legal pages from product pages.

Recommended next step

Start with the top traffic URLs, then add internal docs only after public pages are stable.

Validate this example

Website content bundle

bundle/
  index.md
  pages/
    home.md
    pricing.md
    privacy.md
  products/
    okf-validator.md
  support/
    contact.md

Example

API endpoint bundle

Who it is for

A developer relations team wants agents to explain endpoints, parameters, limits, and errors.

Copy-ready example

Use the code block beside this note as the starting point, then update the sample paths and field values.

Field notes

Endpoint files describe one action per concept.
Reference files hold authentication and shared error details.
Cross-links keep repeated rules out of endpoint files.

Common mistake

Putting every endpoint in one file.
Omitting error responses.
Letting samples drift from the live API reference.

Recommended next step

Draft endpoint context from OpenAPI, then use the OpenAPI to OKF guide for manual review.

Validate this example

API endpoint bundle

bundle/
  index.md
  api/
    create-customer.md
    update-subscription.md
    list-invoices.md
  references/
    auth.md
    rate-limits.md
    error-codes.md

Example

Product documentation bundle

Who it is for

A docs team wants task pages, reference pages, and troubleshooting notes to stay readable by humans and agents.

Copy-ready example

Use the code block beside this note as the starting point, then update the sample paths and field values.

Field notes

Concept files define product objects.
Task files explain step-by-step procedures.
Troubleshooting files capture symptoms, causes, fixes, and escalation.

Common mistake

Blending concept, task, and troubleshooting content.
Skipping prerequisites.
Not documenting who owns the page.

Recommended next step

Map docs IA first, then create one OKF file for each durable topic.

Validate this example

Product documentation bundle

bundle/
  index.md
  concepts/
    workspace.md
    roles.md
  tasks/
    invite-user.md
    import-csv.md
  troubleshooting/
    csv-validation-errors.md

Example

Support playbook bundle

Who it is for

A support team wants agents to route cases, ask for the right evidence, and avoid unsupported promises.

Copy-ready example

Use the code block beside this note as the starting point, then update the sample paths and field values.

Field notes

Playbooks define trigger, triage steps, boundaries, and escalation.
Policy files hold stable rules that many playbooks reference.
Tags separate refund, security, billing, and account topics.

Common mistake

Writing agent actions that bypass human approval.
Forgetting negative cases where support must refuse.
Not listing escalation thresholds.

Recommended next step

Review each playbook with policy owners before production agent use.

Validate this example

Support playbook bundle

bundle/
  index.md
  playbooks/
    refund-request.md
    login-lockout.md
    billing-dispute.md
  policies/
    refund-policy.md
    account-security.md

Example

SaaS metrics bundle

Who it is for

A growth or finance team wants consistent definitions for ARR, churn, activation, and usage metrics.

Copy-ready example

Use the code block beside this note as the starting point, then update the sample paths and field values.

Field notes

Metric files state formula, grain, exclusions, and owner.
Dashboard files explain where numbers appear and how they are filtered.
Table files document upstream data and freshness.

Common mistake

Publishing a metric without numerator and denominator.
Not marking exclusions.
Using dashboard labels as definitions.

Recommended next step

Create metric OKF files before dashboard OKF files so the dashboard has source definitions.

Validate this example

SaaS metrics bundle

bundle/
  index.md
  metrics/
    arr.md
    logo-churn.md
    activation-rate.md
  dashboards/
    executive-overview.md
  tables/
    subscription-events.md

Example

Knowledge base bundle

Who it is for

An operations team wants a lightweight knowledge base that can be edited in Git and consumed by agents.

Copy-ready example

Use the code block beside this note as the starting point, then update the sample paths and field values.

Field notes

Runbooks focus on repeatable actions.
Decision files capture why a choice was made.
Reference files hold supporting facts and links.

Common mistake

Treating OKF as a file dump with no index.
Keeping outdated decisions without timestamps.
Mixing private credentials into agent-readable files.

Recommended next step

Add a review cadence and remove sensitive data before sharing the bundle.

Validate this example

Knowledge base bundle

bundle/
  index.md
  runbooks/
    deploy-checklist.md
    incident-triage.md
  decisions/
    why-static-export.md
  references/
    vendor-contacts.md

Source boundary

This guide is unofficial. It uses public draft references for orientation and adds practical examples for learning.