Plantillas OKF - Archivos iniciales de Open Knowledge Format

Plantillas OKF

Empieza con plantillas OKF enfocadas en tareas de alta intención: documentación de API, datasets, métricas, runbooks, artículos de soporte y documentación de producto.

Usuarios que necesitan una plantilla OKF para documentación de API.

Plantilla OKF de documentación API

Plantilla OKF inicial para documentar APIs REST y RPC.

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

Abrir página dedicada

Responsables de datos que publican metadatos de datasets legibles por AI.

Plantilla OKF de dataset

Plantilla OKF inicial para una entrada de catálogo de datos.

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

Abrir página dedicada

Equipos de operaciones que convierten procedimientos en runbooks legibles por agentes.

Plantilla OKF de runbook

Plantilla OKF inicial para respuesta a incidentes y operaciones.

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

Abrir página dedicada

Equipos de análisis y finanzas que documentan métricas para herramientas de AI.

Plantilla OKF de métrica

Plantilla OKF inicial para definiciones de métricas consistentes.

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

Abrir página dedicada

Equipos de soporte que preparan documentación de ayuda para búsqueda con AI y agentes.

Plantilla OKF de base de conocimiento de soporte

Plantilla OKF inicial para artículos de soporte y contenido de centro de ayuda.

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

Abrir página dedicada

Equipos de producto que crean documentación de producto legible por agentes.

Plantilla OKF de documentación de producto

Plantilla OKF inicial para documentación de funcionalidades SaaS.

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

Abrir página dedicada

Herramientas y guías OKF relacionadas

Validador OKF Generador web a OKF Conversor OpenAPI a OKF OKF vs JSON-LD OKF vs OpenAPI

FAQ

¿Para qué sirven estas plantillas OKF?

Dan a los desarrolladores un punto de partida listo para copiar para publicar archivos Markdown tipados y legibles por agentes.

¿Puedo editar el frontmatter?

Sí. Mantén type no vacío y añade campos como title, description, id, tags, source_url y owner cuando haga falta.

¿Cómo debo validar un archivo copiado?

Pégalo en el Validador OKF antes de publicarlo o confirmarlo en un paquete de conocimiento.