|
| 1 | +--- |
| 2 | +title: "Guías" |
| 3 | +description: "Aprende a crear documentación eficaz con mejores prácticas y flujos de trabajo." |
| 4 | +--- |
| 5 | + |
| 6 | +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. |
| 7 | + |
| 8 | +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. |
| 9 | + |
| 10 | +<div id="topics"> |
| 11 | + ## Temas |
| 12 | +</div> |
| 13 | + |
| 14 | +<div id="ai-tools"> |
| 15 | + ### Herramientas de IA |
| 16 | +</div> |
| 17 | + |
| 18 | +Utiliza herramientas impulsadas por IA para acelerar tu flujo de trabajo de documentación. |
| 19 | + |
| 20 | +* [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. |
| 21 | +* [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. |
| 22 | +* [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. |
| 23 | +* [GEO](/es/guides/geo): Mejores prácticas para optimizar tu documentación para motores de búsqueda y respuesta basados en IA. |
| 24 | + |
| 25 | +<div id="api-documentation"> |
| 26 | + ### Documentación de la API |
| 27 | +</div> |
| 28 | + |
| 29 | +Crea documentación de la API que permita a los usuarios probar y aprender a usar tu API, y que sea fácil de mantener. |
| 30 | + |
| 31 | +* [Migrar de MDX a OAS](/es/guides/migrating-from-mdx): Mueve tu documentación de la API de páginas MDX individuales a páginas generadas automáticamente a partir de especificaciones OpenAPI. |
| 32 | + |
| 33 | +<div id="best-practices"> |
| 34 | + ### Mejores prácticas |
| 35 | +</div> |
| 36 | + |
| 37 | +Haz que tu documentación sea de primer nivel. |
| 38 | + |
| 39 | +* [Accesibilidad](/es/guides/accessibility): Haz que tu documentación sea accesible para el mayor número posible de usuarios. |
| 40 | +* [Tipos de contenido](/es/guides/content-types): Elige el formato adecuado para tutoriales, guías prácticas, referencias y explicaciones. |
| 41 | +* [Mejora tu documentación](/es/guides/improving-docs): Usa datos y comentarios para mejorar tu documentación de forma continua. |
| 42 | +* [Mantenimiento](/es/guides/maintenance): Mantén tu documentación precisa y actualizada. |
| 43 | +* [Medios](/es/guides/media): Agrega imágenes, videos y otros medios de forma eficaz mientras gestionas la carga de mantenimiento. |
| 44 | +* [Organiza la navegación](/es/guides/navigation): Diseña una arquitectura de la información que funcione para tus usuarios. |
| 45 | +* [SEO](/es/guides/seo): Optimiza tu documentación para los motores de búsqueda. |
| 46 | +* [Estilo y tono](/es/guides/style-and-tone): Escribe con una voz consistente. |
| 47 | +* [Comprende a tu audiencia](/es/guides/understand-your-audience): Investiga y atiende las necesidades y objetivos de tus usuarios. |
| 48 | + |
| 49 | +<div id="git-workflows"> |
| 50 | + ### Flujos de trabajo con Git |
| 51 | +</div> |
| 52 | + |
| 53 | +Entiende Git para sacar el máximo partido de Mintlify y de un enfoque de documentación como código (docs-as-code). |
| 54 | + |
| 55 | +* [Conceptos de Git](/es/guides/git-concepts): Aprende los fundamentos de Git para la documentación. |
| 56 | +* [Branches](/es/guides/branches): Usa branches para gestionar los cambios en la documentación. |
| 57 | + |
| 58 | +<div id="where-to-start"> |
| 59 | + ## Por dónde empezar |
| 60 | +</div> |
| 61 | + |
| 62 | +<CardGroup cols={2}> |
| 63 | + <Card title="¿Nuevo en la documentación?" icon="rocket" href="/es/guides/content-types"> |
| 64 | + Aprende acerca de los tipos de contenido para entender cómo estructurar tu documentación. |
| 65 | + </Card> |
| 66 | + |
| 67 | + <Card title="¿Mejorando la documentación existente?" icon="chart-line" href="/es/guides/improving-docs"> |
| 68 | + Aprende a usar métricas y comentarios para mejorar tu documentación. |
| 69 | + </Card> |
| 70 | + |
| 71 | + <Card title="¿Configurando funcionalidades de IA?" icon="bot" href="/es/guides/automate-agent"> |
| 72 | + Automatiza las actualizaciones de la documentación con el agente. |
| 73 | + </Card> |
| 74 | + |
| 75 | + <Card title="¿Trabajando con un equipo?" icon="git-merge" href="/es/guides/git-concepts"> |
| 76 | + Aprende flujos de trabajo de Git para documentación colaborativa. |
| 77 | + </Card> |
| 78 | +</CardGroup> |
0 commit comments