Convierte Windsurf en un experto en documentación que comprenda tu guía de estilo, componentes y el contexto del proyecto mediante reglas del espacio de trabajo y memorias.

​
Uso de Windsurf con Mintlify

El Asistente de IA Cascade de Windsurf puede configurarse para redactar documentación conforme a tus estándares utilizando los Componentes (Mintlify). Las reglas del espacio de trabajo y las memorias proporcionan contexto persistente sobre tu proyecto, lo que garantiza sugerencias más consistentes de Cascade.
  • Reglas del espacio de trabajo: se almacenan en tu repositorio de documentación y se comparten con tu equipo.
  • Memorias: proporcionan contexto individual que se va acumulando con el tiempo.
Recomendamos configurar reglas del espacio de trabajo para los estándares de documentación compartidos. Puedes ir desarrollando memorias a medida que trabajas, pero como no se comparten, no serán coherentes entre los miembros del equipo. Crea reglas del espacio de trabajo en el directorio .windsurf/rules de tu repositorio de documentación. Consulta Memories & Rules en la documentación de Windsurf para obtener más información.

​
Regla de ejemplo para el espacio de trabajo

Esta regla le proporciona a Cascade contexto sobre los Componentes (Mintlify) y las mejores prácticas generales de redacción técnica. Puedes usar esta regla de ejemplo tal cual o personalizarla para tu documentación:
  • Estándares de redacción: Actualiza las pautas de lenguaje para que se alineen con tu guía de estilo.
  • Patrones de componentes: Agrega componentes específicos del proyecto o modifica los ejemplos existentes.
  • Ejemplos de código: Reemplaza ejemplos genéricos con llamadas y respuestas reales de la API de tu producto.
  • Preferencias de estilo y tono: Ajusta la terminología, el formato y otras reglas.
Guarda tu regla como un archivo .md en el directorio .windsurf/rules del repositorio de tu documentación. 
# 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 la segunda persona ("you") para las instrucciones
- Escribe en voz activa y tiempo presente
- Inicia los procedimientos con requisitos previos
- Incluye los resultados esperados para los pasos principales
- Usa encabezados descriptivos y con palabras clave
- Mantén oraciones concisas pero informativas

## Estructura de página requerida

Cada página debe comenzar con un 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 crear el archivo docs.json y la navegación del sitio

### Avisos

- `<Note>` para información complementaria útil
- `<Warning>` para advertencias importantes y cambios incompatibles
- `<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 corresponda, incluye ejemplos completos y ejecutables
- Usa `<CodeGroup>` para ejemplos en varios 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 corresponda
- Divide los procedimientos complejos en pasos más pequeños

### Organización del contenido

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

## Requisitos para la documentación de API

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

## Estándares de calidad

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

​
Trabajar con Cascade

Una vez que hayas configurado tus reglas, puedes usar Cascade para asistir en varias tareas de documentación. Consulta Cascade en la documentación de Windsurf para obtener más información.

​
Ejemplos de prompts

Redacción de contenido nuevo: 
Crea una nueva página que explique cómo autenticarse con nuestra API. Incluye ejemplos de código en JavaScript, Python y cURL.
Mejorar contenido existente: 
Revisa esta página y sugiere mejoras para la claridad y el uso de componentes. Enfócate en que los pasos sean más fáciles de seguir.
Crear ejemplos de código: 
Genera un ejemplo de código completo que muestre el manejo de errores para este endpoint de la API. Usa datos realistas e incluye las respuestas esperadas.
Mantener la coherencia: 
Verifica si esta nueva página sigue nuestros estándares de documentación y sugiere los cambios necesarios.