Guías

Las guías de esta sección contienen recomendaciones para crear documentación que ayude a tus usuarios a tener éxito. Tanto si estás empezando desde cero como si estás mejorando la documentación existente, estas guías te ayudan a planificar, redactar y mantener tu documentación.

Ante todo, ten en cuenta las necesidades y objetivos de tus usuarios. Documenta aquello que les ayude a utilizar tu producto y volver a sus tareas.

Utiliza herramientas impulsadas por IA para acelerar tu flujo de trabajo de documentación.

• Crear un assistant dentro de tu aplicación: Tutorial que enseña cómo agregar un chat bot de IA en una app de React para ayudar a los usuarios a encontrar respuestas en tu documentación.
• Configurar automerge: Agrega la aplicación GitHub de Mintlify a la lista de bypass de un ruleset para habilitar la fusión automática para automatizaciones.
• Usar automatizaciones: Elige el activador de automatización adecuado, escribe instrucciones efectivas y obtén resultados consistentes del mantenimiento automatizado de contenido.
• Claude Code, Codex, Cursor, Devin Desktop: Guías para usar asistentes de programación con IA para mantener la documentación.
• GEO: Mejores prácticas para optimizar tu documentación para motores de búsqueda y respuesta basados en IA.

Crea documentación de tu API que permita a los usuarios hacer pruebas y aprender a usarla, y que además sea fácil de mantener.

• Migrar de MDX a OAS: Migra la documentación de tu API de páginas individuales en MDX a páginas autogeneradas a partir de una especificación de OpenAPI.

Haz que tu documentación sea de primer nivel.

• Accesibilidad: Haz que tu documentación sea accesible para el mayor número posible de usuarios.
• Tipos de contenido: Elige el formato adecuado para tutoriales, guías prácticas, referencias y explicaciones.
• Plantillas de contenido: Copia y modifica plantillas para cada tipo de contenido.
• Diseños de página personalizados: Usa modos de página y componentes para crear páginas de destino y otros diseños personalizados.
• Mejora tu documentación: Usa datos y comentarios para mejorar tu documentación de forma continua.
• Internacionalización: Configura documentación multilingüe para llegar a una audiencia global.
• Enlaces: Crea enlaces internos, haz referencia a endpoints de la API y mantén la integridad de los enlaces en toda tu documentación.
• Mantenimiento: Mantén tu documentación precisa y actualizada.
• Medios: Agrega imágenes, videos y otros medios de forma eficaz mientras gestionas la carga de mantenimiento.
• Organiza la navegación: Diseña una arquitectura de la información que funcione para tus usuarios.
• SEO: Optimiza tu documentación para los motores de búsqueda.
• Estilo y tono: Escribe con una voz consistente.
• Comprende a tu audiencia: Investiga y atiende las necesidades y objetivos de tus usuarios.

Entiende Git para sacar el máximo partido de Mintlify y de un enfoque de documentación como código (docs-as-code).

• Conceptos de Git: Aprende los fundamentos de Git para la documentación.
• Branches: Usa branches para gestionar los cambios en la documentación.

Descubre cómo Mintlify se adapta a distintos casos de uso y encuentra la solución que mejor funcione para ti.

• Crear documentación para desarrolladores: Ayuda a tus usuarios a sacar el máximo partido de tu producto o API con documentación para desarrolladores que responda preguntas y les permita volver rápidamente a sus tareas principales.
• Crear una base de conocimientos: Configura una base de conocimientos interna para consolidar la información de tu equipo, mejorar las búsquedas y reducir la carga de mantenimiento.
• Crear un centro de ayuda: Crea un centro de ayuda de autoservicio que permita a los usuarios encontrar respuestas por sí mismos, reduzca el volumen de tickets y mejore la satisfacción del cliente.
• Crear un frontend personalizado: Usa la integración de Mintlify con Astro para mostrar tu documentación con un frontend totalmente personalizado.