What is an OKF template?
An OKF template is a copy-ready Markdown starter with YAML frontmatter fields such as type, title, description, resource, tags, and timestamp.
Template library
Copy-ready OKF templates for YAML knowledge files
Copy practical OKF templates for websites, API docs, SaaS, documentation, AI agent context, and data catalogs.
Copy a template first
Start with the template closest to your source material, replace the placeholder resource, title, tags, and timestamp, then paste the result into the OKF Validator. Do not start by reading theory if your goal is to create a working OKF file.
The templates below are practical starters, not official certification tests. They help you create focused Markdown files with YAML metadata that are easier to review, index, and connect.
Choose the right template
- Use the Website OKF template for public pages, landing pages, pricing pages, help pages, and trust pages.
- Use the API OKF template for endpoint meaning, request notes, errors, limits, and surrounding business context.
- Use the SaaS OKF template for product concepts such as workspaces, seats, billing limits, roles, and feature gates.
- Use the Documentation OKF template for task pages, reference pages, onboarding guides, and troubleshooting topics.
- Use the AI Agent Context OKF template for policies, routing rules, tool boundaries, and escalation notes.
- Use the Data Catalog OKF template for tables, metrics, dashboards, freshness notes, and ownership context.
Before you copy an OKF template
- Keep one concept per file instead of mixing unrelated topics.
- Replace every placeholder URL, timestamp, tag, and title before publishing.
- Use a stable URN or internal identifier when a concept has no public URL.
- Remove private or restricted records before putting any bundle on a public website.
- Validate copied Markdown with the OKF Validator before expanding the body.
Bad example vs fixed example
A weak template copy usually lacks `type`, source context, and a stable resource. A fixed OKF example keeps the same concept but adds metadata that makes the file easier to review and reuse.
---
title: Pricing
---
# Pricing
This page has everything about pricing.Fixed OKF template example
---
type: Website Page
title: Pricing page
description: Explains plan tiers, billing limits, refunds, and upgrade paths.
resource: https://openknowledgeformat.online/sample/pricing/
tags: [website, pricing, billing]
timestamp: 2026-06-21T00:00:00Z
---
# Pricing page
Use this file for stable pricing facts, exclusions, source links, and review notes.Validate a copied OKF template
- Open the OKF Validator.
- Paste the copied template Markdown.
- Fix missing `type`, `title`, `description`, or `tags` warnings before publishing.
- Run the OKF Folder Validator when the template becomes part of a multi-file bundle.
- Manually review factual claims because frontmatter validation cannot prove the content is true.
- Read OKF vs RAG and OKF vs MCP if the template will be used in an agent workflow.
Template limits
Templates are blank starters you copy before writing source-specific facts. A template does not prove official conformance, factual accuracy, SEO impact, or AI citation visibility.
- Use OKF examples when you need to compare finished bundle shapes.
- Run the folder validator after a template becomes part of a bundle.
Optional v0.2 review fields
You may record `generated`, `verified`, `status`, `stale_after`, and `sources` when the source owner can review them. Treat every field as a review aid, not an official required schema or proof that copied content is correct.
FAQ
How do I use an OKF template?
Copy the closest template, replace placeholders with your real source details, write one focused Markdown body, then validate the file.
Can OKF templates work with RAG?
Yes. OKF templates can help prepare cleaner source files before a RAG system indexes and retrieves content.
Can OKF templates work with MCP?
Yes. MCP can expose tools or resources that read, search, validate, or update OKF files, but OKF itself is not MCP.
How do I validate an OKF file?
Paste the Markdown into the OKF Validator, fix frontmatter errors first, then manually review the actual claims and links.
Template
Website OKF template
Use case
Use this when you want search pages, help pages, pricing pages, or landing pages to become a structured knowledge bundle.
Copy-ready template
Use the code block beside this note as the starting point, then update the sample paths and field values.
Field notes
- `type` identifies this as a website page concept.
- `resource` points to the live URL the knowledge describes.
- `tags` group this page with other website and conversion documents.
Common mistakes
- Using promotional copy instead of stable facts.
- Leaving out pricing exclusions that an agent needs for accurate answers.
- Pointing `resource` to the home page when the concept is about a specific URL.
Recommended next step
Create one OKF file per important public URL, then add an index file for the section.
---
type: Website Page
title: Pricing Page
description: Explains plan tiers, billing limits, refund policy, and upgrade paths.
resource: https://openknowledgeformat.online/sample/pricing/
tags: [website, pricing, conversion]
timestamp: 2026-06-21T00:00:00Z
---
# Audience
Describe who should read this page and what decision it supports.
# Key facts
- List the offer, limits, exclusions, and trust statements.
- Link to related OKF documents for product, support, and legal context.
# Citations
[1] Source page or internal owner record.Template
API OKF template
Use case
Use this for REST, GraphQL, or webhook endpoints that agents need to call, explain, or troubleshoot.
Copy-ready template
Use the code block beside this note as the starting point, then update the sample paths and field values.
Field notes
- `type` tells consumers this document describes an endpoint.
- `title` should match the business action, not only the URL.
- `resource` can be the endpoint URL or canonical API reference URL.
Common mistakes
- Documenting only the happy path.
- Omitting authentication, rate limits, and error responses.
- Mixing multiple endpoints into one concept file.
Recommended next step
Add one companion OKF file for shared authentication and one for common error codes.
---
type: API Endpoint
title: Create customer endpoint
description: Creates a customer record and returns the new customer identifier.
resource: https://openknowledgeformat.online/sample-api/v1/customers
tags: [api, customers, write]
timestamp: 2026-06-21T00:00:00Z
---
# Method
POST /v1/customers
# Request fields
| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| email | string | yes | Must be unique. |
# Response
Return the created customer id and status.Template
SaaS OKF template
Use case
Use this for product concepts such as accounts, workspaces, roles, billing limits, or feature gates.
Copy-ready template
Use the code block beside this note as the starting point, then update the sample paths and field values.
Field notes
- `type` can be a precise business concept label.
- `description` should be one sentence so search snippets stay clean.
- `tags` connect the concept to billing, workspace, and support topics.
Common mistakes
- Using internal jargon without a plain definition.
- Skipping edge cases such as suspended users or pending invites.
- Failing to link to plan limits and support playbooks.
Recommended next step
Build a concept map for the main product objects and support workflows.
---
type: SaaS Product Concept
title: Workspace seats
description: Defines how seats are counted, invited, removed, and billed.
resource: https://openknowledgeformat.online/sample/docs/workspace-seats
tags: [saas, billing, workspace]
timestamp: 2026-06-21T00:00:00Z
---
# Definition
A seat is counted when a user has active access to a paid workspace.
# Rules
- Pending invites do not count until accepted.
- Suspended users stop counting at the next billing sync.
# Related concepts
See [Billing plans](/billing/plans.md).Template
Documentation OKF template
Use case
Use this when developer docs or product docs need a machine-readable summary next to human instructions.
Copy-ready template
Use the code block beside this note as the starting point, then update the sample paths and field values.
Field notes
- `title` mirrors the documentation task.
- `description` summarizes the user goal and main steps.
- `timestamp` records the last meaningful update.
Common mistakes
- Turning a long page into one giant OKF document.
- Missing prerequisites, permissions, or rollback notes.
- Not linking related troubleshooting topics.
Recommended next step
Split large docs into one OKF document per task, concept, or reference topic.
---
type: Documentation Topic
title: Import contacts from CSV
description: Guides admins through CSV preparation, upload, validation, and rollback.
resource: https://openknowledgeformat.online/sample/docs/import-csv
tags: [docs, import, csv]
timestamp: 2026-06-21T00:00:00Z
---
# Prerequisites
- Admin role.
- UTF-8 CSV file.
- Required columns: email, first_name, last_name.
# Procedure
1. Open Admin Settings.
2. Upload the CSV file.
3. Review validation warnings before confirming.
# Rollback
Export the affected contacts and remove the imported batch if needed.Template
AI Agent Context OKF template
Use case
Use this to package policies, routing rules, tool boundaries, and escalation notes for an agent.
Copy-ready template
Use the code block beside this note as the starting point, then update the sample paths and field values.
Field notes
- `resource` can be a stable URN when no public URL exists.
- `type` marks this as context, not a customer-facing page.
- `tags` help route this context into the correct agent workflow.
Common mistakes
- Mixing policy, tool secrets, and user data in one file.
- Writing instructions that conflict with the product policy.
- Forgetting escalation conditions.
Recommended next step
Review the file with support owners before adding it to an agent context bundle.
---
type: Agent Context
title: Refund support routing
description: Tells the support agent when to answer, when to request proof, and when to escalate refund cases.
resource: urn:agent-context:refund-support-routing
tags: [agent, support, refunds]
timestamp: 2026-06-21T00:00:00Z
---
# Scope
The agent may explain the refund policy and collect order details.
# Boundaries
- Do not promise refunds before eligibility is checked.
- Escalate orders older than 90 days.
# Tool notes
Use the order lookup tool only after the user provides an order id.Template
Data Catalog OKF template
Use case
Use this for tables, datasets, metrics, dashboards, or lineage notes that need human and agent review.
Copy-ready template
Use the code block beside this note as the starting point, then update the sample paths and field values.
Field notes
- `resource` should identify the table, dashboard, or metric asset.
- `description` should state grain and purpose.
- `tags` support cross-cutting search by domain or metric group.
Common mistakes
- Leaving out data grain.
- Not documenting freshness or ownership.
- Using vague column descriptions that repeat the column name.
Recommended next step
Add related metric, dashboard, and playbook OKF files, then link them together.
---
type: Data Table
title: Orders fact table
description: One row per submitted order with revenue, customer, and fulfillment fields.
resource: bigquery://acme.analytics.orders
tags: [data, orders, revenue]
timestamp: 2026-06-21T00:00:00Z
---
# Schema
| Column | Type | Description |
| --- | --- | --- |
| order_id | string | Unique order id. |
| customer_id | string | Customer identifier. |
| total_usd | numeric | Order total in US dollars. |
# Freshness
Updated hourly from the commerce ingestion pipeline.Source boundary
This guide is unofficial. It uses public draft references for orientation and adds practical examples for learning.