Saltar al contenido principal
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.

​
Temas

​
Herramientas de IA

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

​
Documentación de la API

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.

​
Mejores prácticas

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.
  • Mejora tu documentación: Usa datos y comentarios para mejorar tu documentación de forma continua.
  • 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

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.

​
Casos de uso

Descubre cómo Mintlify se adapta a distintos casos de uso y encuentra la solución que mejor funcione para ti.
  • 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.

​
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.