OKF テンプレート

OKF テンプレート

API ドキュメント、dataset、metric、runbook、サポート記事、製品ドキュメントなど、高意図タスク向けの OKF テンプレートから始められます。

API ドキュメント用 OKF テンプレートを必要とする検索ユーザー。

API ドキュメント OKF テンプレート

REST と RPC API を文書化するための OKF 初期テンプレート。

---
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.

専用ページを開く

AI 可読 dataset メタデータを公開するデータ責任者。

dataset OKF テンプレート

データカタログ項目向けの OKF 初期テンプレート。

---
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.

専用ページを開く

手順をエージェント可読 runbook に変換する運用チーム。

runbook OKF テンプレート

インシデント対応と運用向けの OKF 初期テンプレート。

---
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.

専用ページを開く

AI ツール向けに metric を記録する分析・財務チーム。

metric OKF テンプレート

一貫した metric 定義のための OKF 初期テンプレート。

---
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.

専用ページを開く

AI 検索とエージェント向けにヘルプ文書を準備するサポートチーム。

サポート KB OKF テンプレート

サポート記事とヘルプセンターコンテンツ向けの OKF 初期テンプレート。

---
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.

専用ページを開く

エージェント可読な製品ドキュメントを作るプロダクトチーム。

製品ドキュメント OKF テンプレート

SaaS 機能ドキュメント向けの OKF 初期テンプレート。

---
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.

専用ページを開く

FAQ

これらの OKF テンプレートは何に使いますか？

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

frontmatter は編集できますか？

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

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

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

API ドキュメント OKF テンプレート

dataset OKF テンプレート

runbook OKF テンプレート

metric OKF テンプレート

サポート KB OKF テンプレート

製品ドキュメント OKF テンプレート

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

FAQ