mintlify__docs/es/guides/developer-documentation.mdx

---
title: "Crear documentación para desarrolladores"
sidebarTitle: "Documentación para desarrolladores"
description: "Crea documentación para desarrolladores que ayude a integrar tus APIs, SDKs y herramientas, con guías de inicio rápido, referencias y tutoriales."
keywords: ["developer documentation", "API documentation", "SDK docs", "technical documentation", "developer portal"]
---

La documentación para desarrolladores ayuda a las personas a entender e integrarse con tu producto. Una buena documentación permite que las personas hagan más con tu producto, reduce la carga de soporte, acelera la adopción y mejora la experiencia del desarrollador.

Mintlify proporciona infraestructura diseñada para la documentación para desarrolladores.

* **Generación de referencias de API**: Genera [referencias de API](/es/api-playground/overview) interactivas a partir de especificaciones OpenAPI que permiten a los desarrolladores probar endpoints en tu documentación.
* **Bloques de código con explicaciones**: El [assistant](/es/assistant/index) explica ejemplos de código en contexto, ayudando a los desarrolladores a entender los detalles de implementación.
* **Sincronización con Git**: Mantén la documentación sincronizada con tu base de código usando [GitHub](/es/deploy/github) o [GitLab](/es/deploy/gitlab).
* **Control de versiones**: Mantén la documentación para múltiples [versiones](/es/organize/navigation#versions), de modo que los desarrolladores en versiones anteriores aún puedan encontrar información precisa.

<div id="prerequisites">
  ## Requisitos previos
</div>

Si aún no has creado un proyecto de Mintlify, consulta la [Guía de inicio rápido](/es/quickstart) para desplegar tu sitio.

* La especificación de tu API en formato OpenAPI (si estás documentando una API)
* Un repositorio Git para tu documentación
* Acceso de administrador a tu organización de Mintlify

<div id="migrate-existing-documentation">
  ## Migra la documentación existente
</div>

Si estás creando la documentación desde cero, pasa a [Planifica la estructura de la documentación](#plan-your-documentation-structure).

<div id="audit-existing-content">
  ### Audita el contenido existente
</div>

Revisa tu documentación actual para entender qué tienes y qué necesitas migrar.

* **Referencia de API**: ¿Se genera a partir de una especificación o está escrita a mano? ¿Qué endpoints documentas?
* **Guías y tutoriales**: ¿Qué guías de integración tienes? ¿Están actualizadas?
* **Ejemplos de código**: ¿Qué lenguajes y frameworks utilizas?
* **Documentación de SDK**: ¿Tienes documentación independiente para cada SDK?
* **Cambios**: ¿Mantienes un registro de cambios o notas de lanzamiento?
* **Metadata**: ¿Tienes metadata para tu contenido, como fechas, autores y etiquetas?

<div id="export-your-existing-content">
  ### Exporta tu contenido existente
</div>

* Exporta a **Markdown** para la migración más sencilla a Mintlify.
* Exporta las **especificaciones OpenAPI** para el contenido de referencia de API.
* Exporta a **HTML** si Markdown no está disponible y luego conviértelo a Markdown.

<div id="plan-your-documentation-structure">
  ## Planifica la estructura de tu documentación
</div>

La documentación para desarrolladores suele incluir varios tipos de contenido. Estructura la navegación en función de cómo tus usuarios entienden tu producto.

```json docs.json example
{
  "navigation": {
    "groups": [
      {
        "group": "Get Started",
        "pages": [
          "introduction",
          "quickstart",
          "authentication"
        ]
      },
      {
        "group": "Guides",
        "pages": [
          "guides/webhooks",
          "guides/error-handling",
          "guides/rate-limits",
          "guides/pagination"
        ]
      },
      {
        "group": "Referencia de API",
        "pages": [
          "api-reference/overview",
          "api-reference/users",
          "api-reference/orders",
          "api-reference/products"
        ]
      },
      {
        "group": "SDKs",
        "pages": [
          "sdks/javascript",
          "sdks/python",
          "sdks/go"
        ]
      }
    ]
  }
}
```

Consulta [Navigation](/es/organize/navigation) para obtener más opciones de configuración.

<div id="set-up-your-api-reference">
  ## Configura tu referencia de API
</div>

Si tienes una API, genera una referencia interactiva a partir de tu especificación OpenAPI.

<Steps>
  <Step title="Agrega tu especificación OpenAPI">
    Agrega el archivo de especificación OpenAPI a tu proyecto. Puedes usar formato YAML o JSON.

    ```text
    your-project/
    ├── docs.json
    ├── openapi.yaml
    └── api-reference/
        └── overview.mdx
    ```
  </Step>

  <Step title="Configura la especificación en docs.json">
    Haz referencia a tu archivo OpenAPI en la configuración de `docs.json`.

    ```json Ejemplo de configuración
    {
      "openapi": "openapi.yaml"
    }
    ```
  </Step>

  <Step title="Agrega endpoints a la navigation">
    Agrega los endpoints a `navigation` en tu `docs.json`. Consulta [Configuración de OpenAPI](/es/api-playground/openapi-setup) para ver las opciones de configuración.

    ```json Ejemplo de navegación
    {
      "group": "API Reference",
      "pages": [
        "api-reference/overview",
        "api-reference/users/list-users",
        "api-reference/users/get-user",
        "api-reference/users/create-user"
      ]
    }
    ```
  </Step>
</Steps>

<div id="set-up-the-assistant">
  ## Configura el assistant
</div>

El assistant ayuda a los desarrolladores a encontrar respuestas y comprender ejemplos de código. Configúralo desde tu [dashboard](https://dashboard.mintlify.com/products/assistant/settings).

* **Preguntas de ejemplo**: Añade preguntas dirigidas a desarrolladores como &quot;¿Cómo autentico solicitudes a la API?&quot; o &quot;Muéstrame cómo manejar webhooks&quot;.
* **Explicaciones de código**: El assistant puede explicar bloques de código en contexto cuando los desarrolladores hacen preguntas sobre ejemplos específicos.

<div id="set-up-versioning">
  ## Configurar el versionado
</div>

Si mantienes varias versiones de tu API, configura el versionado para que los desarrolladores puedan encontrar la documentación de su versión.

```json Versioning example
{
  "versions": ["v2", "v1"],
  "navigation": {
    "groups": [
      {
        "group": "Referencia de API",
        "version": "v2",
        "pages": ["v2/api-reference/users"]
      },
      {
        "group": "Referencia de API",
        "version": "v1",
        "pages": ["v1/api-reference/users"]
      }
    ]
  }
}
```

Para obtener más información, consulta [Versiones](/es/organize/navigation#versions).

<div id="connect-to-your-repository">
  ## Conecta tu repositorio
</div>

Instala la [Aplicación de GitHub](/es/deploy/github) de Mintlify para mantener la documentación sincronizada con tu base de código y permitir contribuciones.

<Steps>
  <Step title="Connect your repository">
    Vincula tu repositorio de GitHub en el [dashboard](https://dashboard.mintlify.com). Esto habilita implementaciones automáticas cuando haces push de cambios.
  </Step>

  <Step title="Configure branch settings">
    Define tu branch de producción y habilita implementaciones de vista previa para las solicitudes de extracción. Esto te permite revisar los cambios en la documentación antes de que se publiquen.
  </Step>
</Steps>

<Note>
  Si usas GitLab, consulta [GitLab](/es/deploy/gitlab) para obtener instrucciones de configuración.
</Note>

<div id="maintain-your-documentation">
  ## Mantén tu documentación
</div>

La documentación para desarrolladores necesita actualizaciones periódicas para que la información sea precisa y útil.

<Steps>
  <Step title="Mantén actualizada la referencia de la API">
    Actualiza tu especificación de OpenAPI cada vez que publiques cambios. Si generas tu especificación a partir del código, automatiza esto en tu proceso de lanzamiento.
  </Step>

  <Step title="Actualiza los ejemplos de código">
    Revisa los ejemplos de código cuando publiques nuevas versiones del SDK o actualizaciones del producto. Los ejemplos desactualizados provocan errores de integración y solicitudes de soporte.
  </Step>

  <Step title="Mantén un registro de cambios">
    Documenta los cambios incompatibles, las nuevas funcionalidades y las deprecaciones. Los desarrolladores dependen de los registros de cambios para comprender qué cambió entre versiones. Consulta [Cambios](/es/create/changelogs) para obtener más información.
  </Step>

  <Step title="Supervisa los comentarios">
    Revisa las conversaciones del assistant y las métricas de búsqueda para identificar carencias en tu documentación. Si los desarrolladores preguntan repetidamente sobre el mismo tema, mejora esa sección. Consulta [Mantenimiento](/es/guides/maintenance) para obtener más información.
  </Step>
</Steps>

<div id="next-steps">
  ## Próximos pasos
</div>

La documentación para desarrolladores está lista para publicarse. Después de desplegarla:

1. Anuncia la documentación a tu comunidad de desarrolladores.
2. Supervisa los patrones de búsqueda y las conversaciones en el assistant para identificar brechas.
3. Configura un proceso para actualizar la documentación con cada nueva versión de la API.
4. Recopila comentarios de los desarrolladores para mejorar el contenido a lo largo del tiempo.