Temas
Herramientas de IA
- Automatizar actualizaciones de la documentación: Tutorial que enseña cómo configurar actualizaciones automatizadas de la documentación usando el agent.
- 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 de flujos de trabajo.
- Claude Code, Cursor, Windsurf: 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.
Documentación de la API
- 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.
Mejores prácticas
- 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.
- 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.
Flujos de trabajo con Git
- Conceptos de Git: Aprende los fundamentos de Git para la documentación.
- Branches: Usa branches para gestionar los cambios en la documentación.
Casos de uso
- 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 soporte: Crea un centro de soporte de autoservicio que ayude a los clientes a encontrar respuestas, 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.
Por dónde empezar
¿Nuevo en la documentación?
Aprende acerca de los tipos de contenido para entender cómo estructurar tu documentación.
¿Mejorando la documentación existente?
Aprende a usar métricas y comentarios para mejorar tu documentación.
¿Configurando funcionalidades de IA?
Automatiza las actualizaciones de la documentación con el agente.
¿Trabajando con un equipo?
Aprende flujos de trabajo de Git para documentación colaborativa.