mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
6d2ace8440
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
91 lines
5.4 KiB
Plaintext
91 lines
5.4 KiB
Plaintext
---
|
|
title: "Guías"
|
|
description: "Aprende a crear documentación eficaz con mejores prácticas y flujos de trabajo."
|
|
---
|
|
|
|
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.
|
|
|
|
<div id="topics">
|
|
## Temas
|
|
</div>
|
|
|
|
<div id="ai-tools">
|
|
### Herramientas de IA
|
|
</div>
|
|
|
|
Utiliza herramientas impulsadas por IA para acelerar tu flujo de trabajo de documentación.
|
|
|
|
* [Automatizar actualizaciones de la documentación](/es/guides/automate-agent): Tutorial que enseña cómo configurar actualizaciones automatizadas de la documentación usando el agent.
|
|
* [Crear un assistant dentro de tu aplicación](/es/guides/assistant-embed): 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.
|
|
* [Claude Code](/es/guides/claude-code), [Cursor](/es/guides/cursor), [Windsurf](/es/guides/windsurf): Guías para usar asistentes de programación con IA para mantener la documentación.
|
|
* [GEO](/es/guides/geo): Mejores prácticas para optimizar tu documentación para motores de búsqueda y respuesta basados en IA.
|
|
|
|
<div id="api-documentation">
|
|
### Documentación de la API
|
|
</div>
|
|
|
|
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](/es/guides/migrating-from-mdx): 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.
|
|
|
|
<div id="best-practices">
|
|
### Mejores prácticas
|
|
</div>
|
|
|
|
Haz que tu documentación sea de primer nivel.
|
|
|
|
* [Accesibilidad](/es/guides/accessibility): Haz que tu documentación sea accesible para el mayor número posible de usuarios.
|
|
* [Tipos de contenido](/es/guides/content-types): Elige el formato adecuado para tutoriales, guías prácticas, referencias y explicaciones.
|
|
* [Plantillas de contenido](/es/guides/content-templates): Copia y modifica plantillas para cada tipo de contenido.
|
|
* [Mejora tu documentación](/es/guides/improving-docs): Usa datos y comentarios para mejorar tu documentación de forma continua.
|
|
* [Internacionalización](/es/guides/internationalization): Configura documentación multilingüe para llegar a una audiencia global.
|
|
* [Enlaces](/es/guides/linking): Crea enlaces internos, haz referencia a endpoints de la API y mantén la integridad de los enlaces en toda tu documentación.
|
|
* [Mantenimiento](/es/guides/maintenance): Mantén tu documentación precisa y actualizada.
|
|
* [Medios](/es/guides/media): Agrega imágenes, videos y otros medios de forma eficaz mientras gestionas la carga de mantenimiento.
|
|
* [Organiza la navegación](/es/guides/navigation): Diseña una arquitectura de la información que funcione para tus usuarios.
|
|
* [SEO](/es/guides/seo): Optimiza tu documentación para los motores de búsqueda.
|
|
* [Estilo y tono](/es/guides/style-and-tone): Escribe con una voz consistente.
|
|
* [Comprende a tu audiencia](/es/guides/understand-your-audience): Investiga y atiende las necesidades y objetivos de tus usuarios.
|
|
|
|
<div id="git-workflows">
|
|
### Flujos de trabajo con Git
|
|
</div>
|
|
|
|
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](/es/guides/git-concepts): Aprende los fundamentos de Git para la documentación.
|
|
* [Branches](/es/guides/branches): Usa branches para gestionar los cambios en la documentación.
|
|
|
|
<div id="use-cases">
|
|
### Casos de uso
|
|
</div>
|
|
|
|
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](/es/guides/developer-documentation): 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](/es/guides/knowledge-base): 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](/es/guides/support-center): 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.
|
|
|
|
<div id="where-to-start">
|
|
## Por dónde empezar
|
|
</div>
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="¿Nuevo en la documentación?" icon="rocket" href="/es/guides/content-types">
|
|
Aprende acerca de los tipos de contenido para entender cómo estructurar tu documentación.
|
|
</Card>
|
|
|
|
<Card title="¿Mejorando la documentación existente?" icon="chart-line" href="/es/guides/improving-docs">
|
|
Aprende a usar métricas y comentarios para mejorar tu documentación.
|
|
</Card>
|
|
|
|
<Card title="¿Configurando funcionalidades de IA?" icon="bot" href="/es/guides/automate-agent">
|
|
Automatiza las actualizaciones de la documentación con el agente.
|
|
</Card>
|
|
|
|
<Card title="¿Trabajando con un equipo?" icon="git-merge" href="/es/guides/git-concepts">
|
|
Aprende flujos de trabajo de Git para documentación colaborativa.
|
|
</Card>
|
|
</CardGroup> |