Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 31 additions & 4 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,8 @@
"fr/organize/settings",
"fr/organize/navigation",
"fr/organize/pages",
"fr/organize/hidden-pages"
"fr/organize/hidden-pages",
"fr/organize/mintignore"
]
},
{
Expand Down Expand Up @@ -391,6 +392,7 @@
"fr/components/callouts",
"fr/components/cards",
"fr/components/code-groups",
"fr/components/color",
"fr/components/columns",
"fr/components/examples",
"fr/components/expandables",
Expand Down Expand Up @@ -531,6 +533,13 @@
{
"tab": "Guides",
"groups": [
{
"group": "Aperçu",
"icon": "book-open",
"pages": [
"fr/guides/index"
]
},
{
"group": "IA",
"icon": "bot",
Expand Down Expand Up @@ -651,7 +660,8 @@
"es/organize/settings",
"es/organize/navigation",
"es/organize/pages",
"es/organize/hidden-pages"
"es/organize/hidden-pages",
"es/organize/mintignore"
]
},
{
Expand Down Expand Up @@ -692,6 +702,7 @@
"es/components/callouts",
"es/components/cards",
"es/components/code-groups",
"es/components/color",
"es/components/columns",
"es/components/examples",
"es/components/expandables",
Expand Down Expand Up @@ -832,6 +843,13 @@
{
"tab": "Guías",
"groups": [
{
"group": "Descripción general",
"icon": "book-open",
"pages": [
"es/guides/index"
]
},
{
"group": "IA",
"icon": "bot",
Expand All @@ -852,7 +870,7 @@
]
},
{
"group": "Mejores prácticas",
"group": "Buenas prácticas",
"icon": "trophy",
"pages": [
"es/guides/accessibility",
Expand Down Expand Up @@ -952,7 +970,8 @@
"zh/organize/settings",
"zh/organize/navigation",
"zh/organize/pages",
"zh/organize/hidden-pages"
"zh/organize/hidden-pages",
"zh/organize/mintignore"
]
},
{
Expand Down Expand Up @@ -993,6 +1012,7 @@
"zh/components/callouts",
"zh/components/cards",
"zh/components/code-groups",
"zh/components/color",
"zh/components/columns",
"zh/components/examples",
"zh/components/expandables",
Expand Down Expand Up @@ -1133,6 +1153,13 @@
{
"tab": "指南",
"groups": [
{
"group": "概览",
"icon": "book-open",
"pages": [
"zh/guides/index"
]
},
{
"group": "人工智能",
"icon": "bot",
Expand Down
78 changes: 78 additions & 0 deletions es/guides/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
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 la API que permita a los usuarios probar y aprender a usar tu API, y que sea fácil de mantener.

* [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.

<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.
* [Mejora tu documentación](/es/guides/improving-docs): Usa datos y comentarios para mejorar tu documentación de forma continua.
* [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="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>
74 changes: 74 additions & 0 deletions fr/guides/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
title: "Guides"
description: "Apprenez à créer une documentation efficace grâce aux bonnes pratiques et aux workflows."
---

Les guides de cette section contiennent des conseils pour créer une documentation qui permet à vos utilisateurs de réussir. Que vous partiez de zéro ou que vous amélioriez une documentation existante, ces guides vous aident à planifier, rédiger et maintenir votre documentation.

Par-dessus tout, prenez en compte les besoins et les objectifs de vos utilisateurs. Documentez ce qui les aide à utiliser votre produit et à reprendre rapidement leurs tâches.

<div id="topics">
## Rubriques
</div>

### Outils d&#39;IA

Utilisez des outils d&#39;IA pour accélérer votre flux de travail de documentation.

* [Automate documentation updates](/fr/guides/automate-agent) : tutoriel qui explique comment configurer des mises à jour automatisées de la documentation à l&#39;aide de l&#39;agent.
* [Build an in-app assistant](/fr/guides/assistant-embed) : tutoriel qui explique comment ajouter un chatbot IA dans une application React pour aider les utilisateurs à trouver des réponses dans votre documentation.
* [Claude Code](/fr/guides/claude-code), [Cursor](/fr/guides/cursor), [Windsurf](/fr/guides/windsurf) : guides pour utiliser des assistants de programmation IA afin de maintenir la documentation.
* [GEO](/fr/guides/geo) : bonnes pratiques pour optimiser votre documentation pour les moteurs de recherche et de réponse basés sur l&#39;IA.

### Documentation d&#39;API

Créez une documentation d&#39;API qui permet aux utilisateurs de tester votre API et d&#39;apprendre à l&#39;utiliser, tout en restant facile à maintenir.

* [Migrer de MDX vers OAS](/fr/guides/migrating-from-mdx): Déplacez votre documentation d&#39;API de pages MDX individuelles vers des pages générées automatiquement à partir d&#39;une spécification OpenAPI.

<div id="best-practices">
### Bonnes pratiques
</div>

Faites de votre documentation une référence.

* [Accessibilité](/fr/guides/accessibility): Rendez votre documentation accessible au plus grand nombre possible.
* [Types de contenu](/fr/guides/content-types): Choisissez le bon format pour les tutoriels, guides pratiques, références et explications.
* [Améliorer votre documentation](/fr/guides/improving-docs): Utilisez les données et les retours pour améliorer continuellement votre documentation.
* [Maintenance](/fr/guides/maintenance): Gardez votre documentation précise et à jour.
* [Médias](/fr/guides/media): Ajoutez des images, des vidéos et d&#39;autres médias de manière efficace tout en maîtrisant la charge de maintenance.
* [Organiser la navigation](/fr/guides/navigation): Concevez une architecture de l&#39;information adaptée à vos utilisateurs.
* [SEO](/fr/guides/seo): Optimisez votre documentation pour les moteurs de recherche.
* [Style et ton](/fr/guides/style-and-tone): Écrivez avec un ton cohérent.
* [Comprendre votre audience](/fr/guides/understand-your-audience): Étudiez les besoins et objectifs de vos utilisateurs et répondez-y.

<div id="git-workflows">
### Flux de travail Git
</div>

Comprenez Git pour tirer le meilleur parti de Mintlify et d&#39;une approche « docs-as-code » de la documentation.

* [Concepts de Git](/fr/guides/git-concepts) : Apprenez les fondamentaux de Git pour la documentation.
* [Branches](/fr/guides/branches) : Utilisez des branches pour gérer les modifications de la documentation.

<div id="where-to-start">
## Par où commencer
</div>

<CardGroup cols={2}>
<Card title="Vous débutez avec la documentation ?" icon="rocket" href="/fr/guides/content-types">
Découvrez les types de contenu pour comprendre comment structurer votre documentation.
</Card>

<Card title="Vous améliorez une documentation existante ?" icon="chart-line" href="/fr/guides/improving-docs">
Découvrez comment utiliser les indicateurs et les retours pour améliorer votre documentation.
</Card>

<Card title="Vous configurez des fonctionnalités d’IA ?" icon="bot" href="/fr/guides/automate-agent">
Automatisez les mises à jour de la documentation avec l’agent.
</Card>

<Card title="Vous travaillez en équipe ?" icon="git-merge" href="/fr/guides/git-concepts">
Apprenez les workflows Git pour une documentation collaborative.
</Card>
</CardGroup>
Loading