OKF templates

OKF Templates

Start from focused OKF templates built around high-intent jobs: API docs, datasets, metrics, runbooks, support articles, and product docs.

Searchers who need an OKF template for API documentation.

API Docs OKF Template

Starter OKF template for documenting REST and RPC APIs.

---
type: api_reference
id: api-docs
title: "API Docs OKF Template"
description: "Starter OKF template for documenting REST and RPC APIs."
tags: [template, api, developer-docs]
---

# API Name

Short description of what the API does.

## Authentication

Describe required credentials, scopes, and rate limits.

## Core endpoints

### METHOD /path

Describe the endpoint, required parameters, and response shape.

## Error handling

List common error codes and recovery actions.

Open dedicated page

Data owners publishing AI-readable dataset metadata.

Dataset OKF Template

Starter OKF template for a data catalog entry.

---
type: dataset
id: dataset
title: "Dataset OKF Template"
description: "Starter OKF template for a data catalog entry."
tags: [template, dataset, data-catalog]
---

# Dataset Name

Describe the dataset and its business purpose.

## Owner

Team or person responsible for correctness.

## Freshness

Update cadence and expected delay.

## Schema

- field_name: field meaning, type, and caveat

## Access

Explain who can query the dataset and where it lives.

Open dedicated page

Ops teams converting procedures into agent-readable runbooks.

Runbook OKF Template

Starter OKF template for incident response and operations.

---
type: runbook
id: runbook
title: "Runbook OKF Template"
description: "Starter OKF template for incident response and operations."
tags: [template, runbook, incident-response]
---

# Runbook Name

When to use this runbook.

## Signals

List alerts, dashboards, and thresholds.

## Diagnosis

1. Check the fastest signal.
2. Confirm blast radius.
3. Identify the likely owner.

## Mitigation

Write the smallest safe action first.

## Escalation

Define who to page and when.

Open dedicated page

Analytics and finance teams documenting metrics for AI tools.

Metric OKF Template

Starter OKF template for consistent metric definitions.

---
type: metric
id: metric
title: "Metric OKF Template"
description: "Starter OKF template for consistent metric definitions."
tags: [template, metric, analytics]
---

# Metric Name

One-sentence definition.

## Formula

Write the exact calculation.

## Grain

State whether the metric is account, user, event, or time-series based.

## Exclusions

List records that must be excluded.

## Common questions

Add interpretation guidance for agents and analysts.

Open dedicated page

Support teams preparing help docs for AI search and agents.

Support Knowledge Base OKF Template

Starter OKF template for support articles and help center content.

---
type: support_article
id: support-kb
title: "Support Knowledge Base OKF Template"
description: "Starter OKF template for support articles and help center content."
tags: [template, support, knowledge-base]
---

# Support Article Title

Describe the customer problem.

## Applies to

Plans, platforms, regions, or versions.

## Resolution

1. First customer action.
2. Second customer action.
3. Expected result.

## Troubleshooting

List common failure cases and next steps.

## Related articles

Add internal links or article IDs.

Open dedicated page

Product teams creating agent-readable product documentation.

Product Documentation OKF Template

Starter OKF template for SaaS feature documentation.

---
type: product_doc
id: product-docs
title: "Product Documentation OKF Template"
description: "Starter OKF template for SaaS feature documentation."
tags: [template, product-docs, saas]
---

# Feature Name

Describe the feature and its primary user outcome.

## Availability

Plans, roles, regions, or beta flags.

## Workflow

1. Step one.
2. Step two.
3. Step three.

## Constraints

Limits, permissions, and unsupported cases.

## Examples

Add practical usage examples.

Open dedicated page

Related OKF tools and guides

OKF Validator Website to OKF Generator OpenAPI to OKF Converter OKF vs JSON-LD OKF vs OpenAPI

FAQ

What are okf templates for?

They give developers a copy-ready starting point for publishing typed, agent-readable Markdown files.

Can I edit the frontmatter?

Yes. Keep type non-empty, then add fields such as title, description, id, tags, source_url, and owner as needed.

How should I validate a copied file?

Paste it into the OKF Validator before publishing or committing it to a knowledge bundle.