Windsurf

# Regla de redacción técnica de Mintlify

## Contexto del proyecto

- Este es un proyecto de documentación en la plataforma Mintlify
- Usamos archivos MDX con frontmatter YAML  
- La navegación se configura en `docs.json`
- Seguimos las mejores prácticas de redacción técnica

## Estándares de redacción

- Usa segunda persona ("tú") para las instrucciones
- Escribe en voz activa y tiempo presente
- Comienza los procedimientos con prerrequisitos
- Incluye resultados esperados para los pasos principales
- Usa encabezados descriptivos y ricos en palabras clave
- Mantén las oraciones concisas pero informativas

## Estructura de página requerida

Cada página debe comenzar con frontmatter:

```yaml
---
title: "Título claro y específico"
description: "Descripción concisa para SEO y navegación"
---
```

## Componentes de Mintlify

### docs.json

- Consulta el [esquema de docs.json](https://mintlify.com/docs.json) al construir el archivo docs.json y la navegación del sitio

### Llamadas de atención

- `<Note>` para información suplementaria útil
- `<Warning>` para precauciones importantes y cambios disruptivos
- `<Tip>` para mejores prácticas y consejos de expertos  
- `<Info>` para información contextual neutral
- `<Check>` para confirmaciones de éxito

### Ejemplos de código

- Cuando sea apropiado, incluye ejemplos completos y ejecutables
- Usa `<CodeGroup>` para ejemplos de múltiples lenguajes
- Especifica etiquetas de lenguaje en todos los bloques de código
- Incluye datos realistas, no marcadores de posición
- Usa `<RequestExample>` y `<ResponseExample>` para documentación de API

### Procedimientos

- Usa el componente `<Steps>` para instrucciones secuenciales
- Incluye pasos de verificación con componentes `<Check>` cuando sea relevante
- Divide procedimientos complejos en pasos más pequeños

### Organización de contenido

- Usa `<Tabs>` para contenido específico de plataforma
- Usa `<Accordion>` para divulgación progresiva
- Usa `<Card>` y `<CardGroup>` para resaltar contenido
- Envuelve imágenes en componentes `<Frame>` con texto alternativo descriptivo

## Requisitos de documentación de API

- Documenta todos los parámetros con `<ParamField>` 
- Muestra la estructura de respuesta con `<ResponseField>`
- Incluye ejemplos tanto de éxito como de error
- Usa `<Expandable>` para propiedades de objetos anidados
- Siempre incluye ejemplos de autenticación

## Estándares de calidad

- Prueba todos los ejemplos de código antes de publicar
- Usa rutas relativas para enlaces internos
- Incluye texto alternativo para todas las imágenes
- Asegura una jerarquía de encabezados adecuada (comienza con h2)
- Verifica patrones existentes para mantener consistencia