OKF 例

OKF 例

API、dataset、metric、runbook、製品ドキュメント向けの実用的な Open Knowledge Format 例をコピーできます。

OKF API 例を探している開発者。

API endpoint の OKF 例

エージェント可読 API ドキュメント向けの単一 endpoint リファレンスページ。

---
type: api_reference
id: api-endpoint
title: "API Endpoint OKF Example"
description: "A single endpoint reference page for agent-readable API documentation."
tags: [api, openapi, reference]
---

# Create Customer Endpoint

Creates a customer record and returns the canonical customer ID.

## Request

POST /v1/customers

Required JSON fields:

- email: customer email address
- name: display name

## Response

Returns 201 with id, email, name, and created_at.

専用ページを開く

エージェント向けカタログを文書化するデータチーム。

dataset の OKF 例

所有者、schema notes、更新頻度を含む dataset 項目。

---
type: dataset
id: dataset
title: "Dataset OKF Example"
description: "A dataset entry with ownership, schema notes, and update cadence."
tags: [dataset, catalog, analytics]
---

# Revenue Events Dataset

Revenue Events stores normalized billing events used by finance dashboards and forecasting jobs.

## Owner

Data Platform team.

## Freshness

Updated hourly from the billing warehouse.

## Fields

- event_id: stable event identifier
- account_id: customer account identifier
- amount_usd: normalized revenue amount
- occurred_at: event timestamp

専用ページを開く

AI 可読な metric 定義を標準化する分析チーム。

metric の OKF 例

式、注意点、ビジネス用途を含む metric 定義。

---
type: metric
id: metric
title: "Metric OKF Example"
description: "A metric definition with formula, caveats, and business usage."
tags: [metric, analytics, semantic-layer]
---

# Net Revenue Retention

Net Revenue Retention measures expansion and contraction in existing customer revenue.

## Formula

(Starting MRR + Expansion MRR - Contraction MRR - Churned MRR) / Starting MRR

## Usage

Use NRR for cohort-level retention analysis and investor reporting.

## Caveats

Exclude trial accounts and one-time services revenue.

専用ページを開く

運用知識を OKF に変換する DevOps チーム。

runbook の OKF 例

エージェントワークフロー向けに整えた本番インシデント runbook。

---
type: runbook
id: runbook
title: "Runbook OKF Example"
description: "A production incident runbook formatted for agent workflows."
tags: [runbook, incident, devops]
---

# API Latency Incident Runbook

Use this runbook when p95 API latency exceeds 900ms for more than five minutes.

## Triage

1. Check current deploy status.
2. Inspect database connection saturation.
3. Compare cache hit rate with the previous hour.

## Rollback

Rollback the latest deploy if latency rose within 15 minutes of release.

## Escalation

Page the platform owner when error rate exceeds 2%.

専用ページを開く

エージェント可読な製品ドキュメントを公開する SaaS チーム。

製品ドキュメントの OKF 例

簡潔な範囲とワークフローガイドを持つ製品機能ページ。

---
type: product_doc
id: product-docs
title: "Product Docs OKF Example"
description: "A product capability page with concise scope and workflow guidance."
tags: [product-docs, saas, support]
---

# Workspace Invitations

Workspace Invitations let administrators invite teammates by email and assign default roles.

## Availability

Available on Team and Enterprise plans.

## Workflow

1. Open Settings.
2. Select Members.
3. Enter email addresses.
4. Choose a role.
5. Send invitations.

## Permissions

Only owners and administrators can invite new members.

専用ページを開く

FAQ

これらの OKF 例は何に使いますか？

開発者が、型付きでエージェントが読める Markdown ファイルを公開するためのコピー可能な出発点になります。

frontmatter は編集できますか？

はい。type を空にせず、必要に応じて title、description、id、tags、source_url、owner などを追加します。

コピーしたファイルはどう検証しますか？

公開または knowledge bundle にコミットする前に、OKF バリデーターへ貼り付けてください。

API endpoint の OKF 例

dataset の OKF 例

metric の OKF 例

runbook の OKF 例

製品ドキュメントの OKF 例

関連する OKF ツールとガイド

FAQ