---
title: Metadatos de contenido
description: Todo artículo declara su metadata en el front-matter. Campos obligatorios, valores de allan.topic, las cinco alertas y cómo se declara la navegación en TOC.yml.
allan.topic: reference
allan.service: allan-docs
allan.date: 08/03/2026
allan.audiencia: [desarrollador]
allan.aplica_a: colaboradores del repositorio allan-docs
---

Todo artículo declara su metadata en el front-matter. Si falta un campo
obligatorio, la validación falla y el artículo no se publica.

## Ejemplo

```yaml
---
title: Conexiones
description: Enlace su cuenta con las herramientas externas que su
  organización ha activado. Estados, cascada y resolución.
allan.topic: how-to
allan.service: platform-ui
allan.date: 08/03/2026
allan.ruta: /dashboard/connections
allan.fuente: [services/connector_resolver.py]
---
```

## Campos obligatorios

| Campo | Descripción | Validación |
|---|---|---|
| `title` | Título del artículo. | 60 caracteres como máximo |
| `description` | Resumen para buscadores y para el extracto que devuelve el servidor MCP. | 75–300 caracteres |
| `allan.topic` | Tipo de artículo. Determina la plantilla y el orden. | lista cerrada |
| `allan.date` | Fecha de la última revisión humana, no la del último commit. | `MM/DD/AAAA` |
| `allan.service` | Servicio o repositorio al que pertenece. | lista cerrada |

## Valores de allan.topic

| Valor | Cuándo se usa |
|---|---|
| `overview` | Presenta un área. Qué es y para qué sirve. |
| `quickstart` | Un camino corto y feliz hasta un primer resultado. |
| `tutorial` | Aprendizaje guiado, más largo, con contexto. |
| `how-to` | Resolver una tarea concreta. El lector ya sabe qué quiere. |
| `concept-article` | Explicar por qué algo funciona así. Sin instrucciones. |
| `reference` | Describir la maquinaria. Generado siempre que se pueda. |
| `troubleshooting` | Un síntoma, sus causas y su solución. |
| `whats-new` | Novedades por periodo. |
| `term` | Nodo del vocabulario controlado. |
| `does-not-exist` | El anti-corpus: documenta una ausencia. |

## Las cinco alertas

```markdown
> [!NOTA]
> Información que el lector agradece pero puede omitir.

> [!SUGERENCIA]
> Un atajo o una buena práctica.

> [!IMPORTANTE]
> Información necesaria para tener éxito.

> [!PRECAUCIÓN]
> Consecuencias negativas posibles.

> [!ADVERTENCIA]
> Consecuencias graves o irreversibles.
```

> [!NOTA]
> Las cinco se renderizan igual en la web, en el markdown crudo que sirve `.md`
> y en las respuestas del servidor MCP. No invente otras: el validador rechaza
> cualquier etiqueta fuera de esta lista.

## Navegación: TOC.yml

La navegación lateral no se deduce del sistema de ficheros: se declara. Un
artículo que no esté en `content/TOC.yml` se publica y es accesible por URL, pero
no aparece en el árbol.

```yaml
- area: doc
  name: Documentacion
  groups:
    - name: Area de trabajo
      items:
        - name: Conexiones
          href: area-de-trabajo/conexiones
```

## Pasos siguientes

- [Servidor MCP de documentación](servidor-mcp-documentacion.md)