OKF 模板

OKF 模板

从聚焦高意图任务的 OKF 模板开始：API 文档、数据集、指标、运行手册、支持文章与产品文档。

需要 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 可读数据集元数据的数据负责人。

数据集 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.

打开独立页面

把流程转成智能体可读运行手册的运维团队。

运行手册 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 工具记录指标的分析与财务团队。

指标 OKF 模板

用于统一指标定义的起始 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 搜索与智能体准备帮助文档的支持团队。

支持知识库 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 等字段。

如何校验复制后的文件？

在发布或提交到知识包之前，把它粘贴进 OKF 校验器。

API 文档 OKF 模板

数据集 OKF 模板

运行手册 OKF 模板

指标 OKF 模板

支持知识库 OKF 模板

产品文档 OKF 模板

相关 OKF 工具与指南

FAQ