Guía de aprendizaje
Tutorial OKF
Aprende Open Knowledge Format paso a paso: desde comprender los conceptos básicos hasta generar, validar y publicar paquetes de conocimiento listos para producción.
Paso 1: Entender OKF
Open Knowledge Format (OKF) es una forma ligera de empaquetar conocimiento como archivos Markdown con frontmatter YAML. Cada archivo OKF representa un concepto, endpoint de API, dataset, métrica o pieza de documentación.
El frontmatter contiene metadatos estructurados (type, title, description, tags), mientras que el cuerpo Markdown contiene el contenido de conocimiento real. Esto hace que OKF sea tanto legible por humanos como analizable por máquinas.
Paso 2: Validar tu primer documento
El Validador OKF verifica la estructura de tu documento y proporciona un OKF Score. Comienza con una plantilla, pégala en el validador y mira cómo puntúa.
El validador muestra tres métricas clave: Estructura (integridad del frontmatter), Cobertura (profundidad del contenido) y Conectividad (enlaces y referencias). Usa la retroalimentación para mejorar tu documento.
Paso 3: Generar OKF desde sitios web
Puedes generar automáticamente documentos OKF desde páginas web existentes. El Generador de web a OKF admite tres modos: URL única, Sitemap (hasta 20 páginas) o lista de URLs.
Para generación por lotes, la herramienta crea un paquete completo con index.md, registros de generación, informes de validación y archivos de conceptos individuales. Puedes previsualizar la primera página antes de procesar todas las URLs.
Paso 4: Mejorar OKF Score
Un OKF Score alto significa conocimiento mejor estructurado y más descubrible. Aquí está cómo mejorar cada dimensión:
- Estructura (40 puntos): Agrega todos los campos de frontmatter: type (10pts), title (10pts), description (10pts), id (5pts), tags (5pts).
- Cobertura (30 puntos): Escribe contenido detallado: cuerpo no vacío (10pts), 100+ palabras (10pts), 300+ palabras (5pts), usa encabezados (5pts).
- Conectividad (30 puntos): Agrega enlaces: source_url (10pts), enlaces internos (10pts), 3+ enlaces internos (10pts).
Apunta a 90+ puntos para documentos listos para producción. Usa el Live Badge para monitorear continuamente tus documentos OKF implementados.
Herramientas y guías OKF relacionadas
FAQ
¿Necesito saber Markdown?
El conocimiento básico de Markdown ayuda, pero OKF es simple: solo agrega frontmatter YAML en la parte superior de un archivo Markdown. El tutorial cubre todo lo que necesitas.
¿Cuánto tiempo lleva aprender OKF?
Puedes crear tu primer documento OKF válido en 5-10 minutos. Comprender todas las funciones y mejores prácticas lleva unos 30 minutos.
¿Por dónde debería empezar?
Comienza con el Paso 1 para entender qué es OKF, luego usa el Validador en el Paso 2 para practicar. Los Pasos 3-4 te muestran cómo generar y mejorar documentos OKF.