mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
cfa24dc0a6
* docs: fix quality gaps in recently changed pages * docs: mirror PR changes into es, fr, zh translations * docs: address review feedback on quality-check fixes - route53-cloudfront: split the Route 53 section into "Add your domain to the distribution" and "Create the Route 53 record", give the alternate domain name / ACM step numbered steps and the console path, and warn that CloudFront only accepts certificates issued in us-east-1 - cli/commands: drop the intro sentence that restated the frontmatter description; match the link text to the target page title - poc-onboarding: stop coupling DNS setup to authentication in the participants table, since auth works on .mintlify.site - editor/pages: note that "Move to trash" has no trash view to restore from, and that recovery after publishing is through the repository Mirrored into es, fr, and zh. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * Update pages.mdx --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
363 lines
18 KiB
Plaintext
363 lines
18 KiB
Plaintext
---
|
|
title: "Onboarding de POC"
|
|
description: "Configura y evalúa una prueba de concepto de Mintlify, desde conectar tu repositorio hasta revisar los flujos de trabajo de publicación, IA y seguridad."
|
|
keywords: ["POC", "prueba de concepto", "prueba", "evaluación", "onboarding empresarial", "piloto"]
|
|
noindex: true
|
|
---
|
|
|
|
Usa esta guía para configurar un sitio de documentación funcional y evaluar Mintlify con tu equipo. La mayoría de las tareas se realizan en el dashboard, pero necesitarás ayuda breve de los administradores de GitHub y de TI para algunos pasos.
|
|
|
|
<Note>
|
|
Si te quedas atascado, contacta a tu ejecutivo de cuenta (AE, account executive) o a tu ingeniero de soluciones (SE, solutions engineer), o escribe a [support@mintlify.com](mailto:support@mintlify.com).
|
|
</Note>
|
|
|
|
<div id="poc-workflow">
|
|
## Flujo de trabajo de la POC
|
|
</div>
|
|
|
|
Completa estos pasos en orden:
|
|
|
|
| Paso | Resultado |
|
|
|---|---|
|
|
| 1. Conecta tu repositorio | Despliega un sitio inicial. |
|
|
| 2. Invita a tu equipo | Da a los participantes el acceso que necesitan. |
|
|
| 3. Agrega contenido de muestra | Prueba páginas representativas y complejas. |
|
|
| 4. Publica un cambio | Verifica tu flujo de trabajo de redacción y revisión. |
|
|
| 5. Aplica tu marca | Alinea el sitio con tu producto. |
|
|
| 6. Prueba las funciones de IA | Evalúa las respuestas del asistente y un flujo de trabajo de IA. |
|
|
| 7. Revisa los resultados | Compara la POC con tus criterios de éxito. |
|
|
|
|
Tu repositorio sigue siendo la fuente de la verdad. El dashboard te permite editar, configurar y publicar los archivos `.mdx` y la configuración `docs.json` de ese repositorio. Tu sitio en vivo muestra el resultado publicado.
|
|
|
|
<div id="before-you-begin">
|
|
## Antes de comenzar
|
|
</div>
|
|
|
|
<div id="identify-participants">
|
|
### Identifica a los participantes
|
|
</div>
|
|
|
|
| Rol | Responsabilidad | Tiempo necesario |
|
|
|---|---|---|
|
|
| Responsable de la documentación | Dirige la POC y completa la mayoría de los pasos. | Unas pocas horas en total |
|
|
| Administrador de GitHub | Aprueba la aplicación de GitHub de Mintlify. | 15 minutos |
|
|
| Diseñador o responsable de marca | Proporciona logotipos, colores y fuentes. | 30 minutos |
|
|
| Administrador de identidad o TI | Conecta tu proveedor de identidad, si pruebas la [autenticación](/es/deploy/authentication-setup). Configura el DNS si además configuras un dominio personalizado. | 1 a 2 horas |
|
|
|
|
<div id="gather-your-content-and-brand-assets">
|
|
### Reúne tu contenido y tus recursos de marca
|
|
</div>
|
|
|
|
Recopila:
|
|
|
|
- Variantes clara y oscura del logotipo en formato SVG o PNG.
|
|
- Un favicon, preferiblemente en formato SVG.
|
|
- Los colores de tu marca como valores hexadecimales.
|
|
- Los archivos de fuentes o los nombres de tus Google Fonts.
|
|
- Un enlace a tu documentación actual o una exportación del contenido.
|
|
- Tu archivo o URL de OpenAPI, si documentas una API.
|
|
- Tus 20 a 30 páginas con más tráfico.
|
|
|
|
<div id="define-success">
|
|
### Define el éxito
|
|
</div>
|
|
|
|
Elige uno de los impulsores de valor con los que los clientes suelen evaluar Mintlify y registra su línea base actual:
|
|
|
|
- **Adquisición:** Mejorar la tasa de activación o el tiempo hasta la primera integración.
|
|
- **Desvío:** Reducir el volumen de tickets de un tema de soporte frecuente.
|
|
- **Ahorro de tiempo de ingeniería:** Reducir las horas de ingeniería dedicadas a redactar, revisar y mantener la documentación.
|
|
- **Retención:** Aumentar la adopción de una funcionalidad después del lanzamiento.
|
|
|
|
Agrega dos o tres criterios que puedas probar durante la POC. Por ejemplo:
|
|
|
|
- Un redactor sin experiencia en Git puede publicar un cambio sin ayuda.
|
|
- Tu página de referencia de API más compleja se renderiza correctamente.
|
|
- El asistente responde 8 de 10 preguntas de soporte frecuentes y cita las páginas correctas.
|
|
- Tu proveedor de identidad admite el inicio de sesión en el dashboard.
|
|
|
|
Comparte el objetivo, la línea base y los criterios con tu AE o SE.
|
|
|
|
<div id="step-1-connect-your-repository">
|
|
## Paso 1: Conecta tu repositorio
|
|
</div>
|
|
|
|
<Warning>
|
|
Un propietario de la organización de GitHub o un administrador del repositorio debe aprobar la aplicación de GitHub de Mintlify antes de que tu sitio pueda desplegarse.
|
|
</Warning>
|
|
|
|
<Steps>
|
|
<Step title="Crea tu cuenta">
|
|
Ve a [mintlify.com/start](https://mintlify.com/start) y regístrate con tu correo electrónico de trabajo.
|
|
</Step>
|
|
|
|
<Step title="Elige un repositorio">
|
|
Conecta GitHub durante la configuración inicial. Crea un repositorio o selecciona uno vacío en la organización de tu empresa. Un repositorio privado llamado `docs` es una opción habitual.
|
|
|
|
No selecciones un repositorio que contenga código de aplicación o archivos no relacionados.
|
|
</Step>
|
|
|
|
<Step title="Instala la aplicación de GitHub">
|
|
Pide a tu administrador de GitHub que instale la aplicación de GitHub de Mintlify. Concede acceso al repositorio de documentación seleccionando **Only select repositories**.
|
|
|
|
Consulta [Instalar la aplicación de GitHub](/es/deploy/github#install-the-github-app) para ver los permisos solicitados.
|
|
|
|
<Accordion title="Solicita la aprobación de un propietario de la organización">
|
|
Si no puedes aprobar la aplicación, envía la solicitud de instalación. GitHub notifica a los propietarios de tu organización.
|
|
|
|
Para continuar mientras la aprobación está pendiente, omite el proveedor de Git durante la configuración inicial. Mintlify crea un repositorio privado que puedes mover más tarde desde [Git settings](https://app.mintlify.com/settings/deployment/git-settings). Consulta [Clonar en tu propio repositorio](/es/deploy/github#clone-to-your-own-repository).
|
|
</Accordion>
|
|
</Step>
|
|
|
|
<Step title="Abre tu sitio">
|
|
Después de que el contenido inicial se despliegue, encuentra tu URL en la página **Overview** del [dashboard](https://app.mintlify.com/). Abre la URL `https://<your-subdomain>.mintlify.site` y confirma que carga.
|
|
</Step>
|
|
</Steps>
|
|
|
|
Usa la URL `.mintlify.site` durante la POC. La [autenticación](/es/deploy/authentication-setup) funciona en tu subdominio `.mintlify.site` o en un [dominio personalizado](/es/customize/custom-domain), pero no funciona en un subpath personalizado como `yourcompany.com/docs`.
|
|
|
|
<div id="step-2-invite-your-team">
|
|
## Paso 2: Invita a tu equipo
|
|
</div>
|
|
|
|
Abre la página [Members](https://app.mintlify.com/settings/organization/members) y asigna a cada participante el rol más restringido que necesite:
|
|
|
|
- **Admin:** Gestiona la configuración de la organización, la facturación y las integraciones.
|
|
- **Editor:** Crea y publica contenido.
|
|
- **Viewer:** Revisa el dashboard y las analíticas sin editar.
|
|
|
|
Consulta [Roles](/es/dashboard/roles) para ver la lista completa de permisos.
|
|
|
|
Invita al menos a un redactor que no use Git, a un ingeniero y al responsable de la decisión. Usa sus correos electrónicos de trabajo para que sus cuentas puedan conectarse a tu proveedor de identidad si pruebas la autenticación.
|
|
|
|
<div id="step-3-add-sample-content">
|
|
## Paso 3: Agrega contenido de muestra
|
|
</div>
|
|
|
|
<div id="choose-representative-pages">
|
|
### Elige páginas representativas
|
|
</div>
|
|
|
|
Comienza con tus 20 a 30 páginas con más tráfico. Incluye:
|
|
|
|
- Tu página de referencia de API más compleja.
|
|
- Una página con una tabla grande o una lista con anidamiento profundo.
|
|
- Una página con imágenes, video o diagramas.
|
|
- Una página con componentes personalizados o widgets incrustados.
|
|
- Dos o tres guías típicas.
|
|
|
|
Mantén la muestra por debajo de 50 páginas para poder concentrarte en la calidad de la migración.
|
|
|
|
<div id="move-the-content">
|
|
### Mueve el contenido
|
|
</div>
|
|
|
|
<Tabs>
|
|
<Tab title="Usa los servicios de migración de Mintlify">
|
|
Pregunta a tu AE o SE si la migración está incluida en tu POC. Si lo está, envía:
|
|
|
|
- La URL o exportación de tu documentación actual.
|
|
- Tu lista de páginas de muestra.
|
|
- Tu archivo o URL de OpenAPI, si aplica.
|
|
- Tus recursos de marca.
|
|
|
|
Consulta [Migraciones empresariales](/es/migration-services/enterprise) para ver el proceso de migración completo.
|
|
</Tab>
|
|
|
|
<Tab title="Haz la migración por tu cuenta">
|
|
Usa uno de estos métodos:
|
|
|
|
1. Exporta Markdown desde tu plataforma actual. Sigue la guía de migración para [Docusaurus](/es/migration/docusaurus), [ReadMe](/es/migration/readme), [GitBook](/es/migration/gitbook), [Fern](/es/migration/fern) o [Document360](/es/migration/document360).
|
|
2. Pega un número reducido de páginas en el editor web y limpia el formato.
|
|
3. Convierte el contenido con una herramienta de IA usando la [skill](/es/ai/skillmd) y el [servidor MCP de administración](/es/ai/mintlify-mcp) de Mintlify.
|
|
|
|
Consulta [Migrar a Mintlify](/es/migration) para otras plataformas.
|
|
</Tab>
|
|
|
|
<Tab title="Conecta una fuente de contenido existente">
|
|
Si tu contenido de origen está en Notion, Confluence, Jira o una herramienta similar, conéctalo al agente de Mintlify. Consulta [Integraciones para el agente y las automatizaciones](/es/automations/integrations).
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
<div id="review-the-migration">
|
|
### Revisa la migración
|
|
</div>
|
|
|
|
Compara cada página de muestra con su fuente. Verifica:
|
|
|
|
- Imágenes, tablas y ejemplos de código.
|
|
- Enlaces internos y externos.
|
|
- Componentes personalizados y contenido incrustado.
|
|
- Las etiquetas de navegación y la ubicación de las páginas.
|
|
|
|
Confirma que un usuario nuevo puede llegar a una página útil en dos clics y que las etiquetas de navegación usan términos que los lectores probablemente buscarán. Envía los problemas de migración a tu AE o SE en una sola lista con la URL de la página y el resultado esperado.
|
|
|
|
<div id="step-4-publish-a-change">
|
|
## Paso 4: Publica un cambio
|
|
</div>
|
|
|
|
Pide a un redactor que no use Git que complete este paso.
|
|
|
|
<Steps>
|
|
<Step title="Crea una rama">
|
|
Abre el [editor web](https://app.mintlify.com/editor). Haz clic en el nombre de la rama en la barra de herramientas del editor, selecciona **Create new branch**, escribe un nombre y luego haz clic en **Create branch**.
|
|
|
|
Una rama mantiene el borrador separado de tu sitio desplegado.
|
|
</Step>
|
|
|
|
<Step title="Edita una página">
|
|
Edita la página en el editor visual. Escribe `/` para insertar un componente o arrastra una imagen a la página para subirla.
|
|
|
|
Presiona <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>S</kbd> (macOS) o <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>S</kbd> (Windows) para alternar entre el modo visual renderizado y el código fuente MDX.
|
|
</Step>
|
|
|
|
<Step title="Comparte la vista previa">
|
|
Selecciona **Create pull request**. Mintlify compila un [despliegue de vista previa](/es/editor/review#preview-deployments): una URL temporal donde tus cambios se renderizan exactamente como se verán al publicarse. Copia la URL y envíala a un revisor. Haz los cambios solicitados en la misma rama. La vista previa se recompila cada vez que guardas.
|
|
</Step>
|
|
|
|
<Step title="Publica">
|
|
Haz merge del pull request para desplegar el cambio en tu sitio en vivo. Publicar desde tu rama de despliegue despliega el cambio de inmediato sin un pull request. Consulta [Publicar cambios](/es/editor/publish).
|
|
|
|
Confirma que la confirmación (commit) aparece en la página **Overview** del dashboard y que el cambio aprobado aparece en tu sitio.
|
|
</Step>
|
|
</Steps>
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Conserva tus controles de revisión existentes">
|
|
Los cambios del editor crean confirmaciones (commits) de Git, por lo que CODEOWNERS, las revisiones obligatorias y la protección de ramas siguen aplicándose.
|
|
</Accordion>
|
|
|
|
<Accordion title="Trabaja en Markdown o localmente">
|
|
Los redactores pueden quedarse en la vista de Markdown del editor. Los ingenieros pueden instalar la [CLI](/es/cli/install), clonar el repositorio y ejecutar [`mint dev`](/es/cli/preview) localmente.
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
También puedes probar los [despliegues de vista previa](/es/deploy/preview-deployments) para pull requests o [agregar el agente a Slack](/es/agent/slack#connect-your-slack-workspace) para proponer cambios de documentación desde Slack.
|
|
|
|
<div id="step-5-apply-branding">
|
|
## Paso 5: Aplica tu marca
|
|
</div>
|
|
|
|
Actualiza la configuración de tu marca en `docs.json`:
|
|
|
|
```json docs.json
|
|
{
|
|
"theme": "luma",
|
|
"colors": {
|
|
"primary": "#16A34A",
|
|
"light": "#07C983",
|
|
"dark": "#15803D"
|
|
},
|
|
"logo": {
|
|
"light": "/logo/light-logo.svg",
|
|
"dark": "/logo/dark-logo.svg"
|
|
},
|
|
"favicon": "/favicon.svg"
|
|
}
|
|
```
|
|
|
|
Después:
|
|
|
|
1. Verifica que los enlaces y botones sigan siendo legibles en modo claro y oscuro.
|
|
2. Agrega tus fuentes usando la [configuración de fuentes](/es/customize/fonts).
|
|
3. Agrega una imagen de Open Graph predeterminada y prueba un enlace compartido en Slack.
|
|
|
|
Consulta [Ajustes de apariencia](/es/organize/settings-appearance), [Temas](/es/customize/themes) y [SEO](/es/optimize/seo) para ver otras opciones. Si no quieres editar `docs.json`, envía tus recursos a tu AE o SE.
|
|
|
|
<div id="step-6-test-ai-features">
|
|
## Paso 6: Prueba las funciones de IA
|
|
</div>
|
|
|
|
<div id="configure-the-assistant">
|
|
### Configura el asistente
|
|
</div>
|
|
|
|
Abre la página del [Asistente](https://app.mintlify.com/products/assistant):
|
|
|
|
1. Activa el asistente.
|
|
2. Agrega [correos de desvío](/es/assistant/configure#set-deflection-emails) para las preguntas que necesiten ayuda humana.
|
|
3. Agrega hasta tres [preguntas iniciales](/es/assistant/configure#add-sample-questions).
|
|
4. Agrega [dominios de búsqueda](/es/assistant/configure#search-domains) si el contenido relevante abarca varios sitios.
|
|
5. Deja habilitada la [protección contra bots](/es/assistant/configure#bot-protection).
|
|
|
|
Consulta [Personalizar el asistente](/es/assistant/customize) y [Habilidades del asistente](/es/assistant/skills) para instrucciones y tono específicos de tu producto.
|
|
|
|
<div id="test-real-questions">
|
|
### Prueba preguntas reales
|
|
</div>
|
|
|
|
1. Recopila 20 a 30 preguntas recientes de tickets de soporte o canales de la comunidad.
|
|
2. Haz cada pregunta a través de **Ask Assistant** en tu sitio.
|
|
3. Registra si la respuesta es correcta y cita la página adecuada.
|
|
4. Usa las respuestas erróneas o faltantes para identificar páginas que actualizar o crear.
|
|
|
|
Revisa las preguntas sin respuesta y con voto negativo en las [analíticas del asistente](/es/analytics/assistant). Si una página relevante no se cita, haz que la `description` de su frontmatter sea específica y única.
|
|
|
|
<div id="test-one-additional-ai-workflow">
|
|
### Prueba un flujo de trabajo de IA adicional
|
|
</div>
|
|
|
|
Elige el flujo de trabajo más relevante para tu evaluación:
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Inserta el asistente">
|
|
Agrega el [widget del asistente](/es/assistant/widget) a tu producto, sitio de marketing o portal de soporte.
|
|
</Accordion>
|
|
|
|
<Accordion title="Conecta herramientas de IA">
|
|
Usa el [servidor MCP de búsqueda](/es/ai/model-context-protocol) para que el contenido publicado esté disponible en las herramientas de IA compatibles. Usa el [servidor MCP de administración](/es/ai/mintlify-mcp) para redactar y editar documentación.
|
|
|
|
También puedes probar el [menú contextual](/es/ai/contextual-menu), [`llms.txt`](/es/ai/llmstxt), [`skill.md`](/es/ai/skillmd) y la [exportación de páginas en Markdown](/es/ai/markdown-export).
|
|
</Accordion>
|
|
|
|
<Accordion title="Automatiza una tarea de mantenimiento">
|
|
Habilita una [automatización](/es/automations), como redactar un changelog o actualizar la documentación después de un cambio en el código. Comienza con **Require review** y luego inspecciona su pull request propuesto y el historial de ejecuciones. Consulta [Administrar automatizaciones](/es/automations/manage).
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
<div id="step-7-review-results">
|
|
## Paso 7: Revisa los resultados
|
|
</div>
|
|
|
|
Reserva una hora con tu responsable de la decisión. Comienza con el objetivo y la línea base que definiste antes de la POC y luego revisa:
|
|
|
|
| Criterio | Evidencia |
|
|
|---|---|
|
|
| Una persona sin perfil de desarrollo puede publicar | El resultado del paso 4 y el tiempo requerido. |
|
|
| Los ingenieros conservan el control de revisión | El pull request y sus comprobaciones. |
|
|
| El contenido complejo se migra correctamente | Páginas de muestra comparadas lado a lado. |
|
|
| El asistente responde con precisión | Tus preguntas puntuadas y las páginas citadas. |
|
|
| Las brechas de contenido son identificables | Preguntas sin respuesta y con voto negativo en las [analíticas del asistente](/es/analytics/assistant). |
|
|
| Los lectores encuentran contenido útil | Datos de [tráfico](/es/analytics/traffic), [búsqueda](/es/analytics/search) e [interacción](/es/analytics/user-engagements). |
|
|
| Las actualizaciones automatizadas son útiles | El historial de ejecuciones de la automatización y el cambio propuesto. |
|
|
|
|
Resuelve las preguntas pendientes con tu AE o SE antes de esta reunión.
|
|
|
|
<div id="suggested-timeline">
|
|
## Cronograma sugerido
|
|
</div>
|
|
|
|
La mayoría de las POC toman dos a tres semanas:
|
|
|
|
| Semana | Enfoque |
|
|
|---|---|
|
|
| Semana 1 | Conecta el repositorio, invita a tu equipo, define el éxito y comienza la migración del contenido. Inicia la [configuración de la autenticación](/es/deploy/authentication-setup) si planeas probarla. |
|
|
| Semana 2 | Revisa el contenido, publica un cambio, aplica tu marca, prueba el asistente y evalúa un flujo de trabajo de IA. |
|
|
| Semana 3 | Revisa los resultados con tu responsable de la decisión. |
|
|
|
|
<div id="getting-help">
|
|
## Obtener ayuda
|
|
</div>
|
|
|
|
- Contacta a tu AE o SE para preguntas urgentes sobre la POC.
|
|
- Escribe a [support@mintlify.com](mailto:support@mintlify.com) para otras preguntas.
|
|
- Consulta [Soporte avanzado](/es/advanced-support) para ver las opciones de soporte después de la POC.
|
|
|
|
<div id="after-the-poc">
|
|
## Después de la POC
|
|
</div>
|
|
|
|
<Card title="Lista de verificación previa al lanzamiento" icon="file-check" horizontal href="/es/migration-services/go-live-checklist">
|
|
Revisa todo lo que debes configurar y verificar antes del lanzamiento.
|
|
</Card>
|