Saltar al contenido principal
Claude Code es una herramienta de línea de comandos con capacidades agentivas que te ayuda a mantener tu documentación. Puede redactar contenido nuevo, revisar páginas existentes y mantener la documentación actualizada. Puedes entrenar a Claude Code para que comprenda tus estándares y flujos de trabajo de documentación añadiendo un archivo CLAUDE.md a tu proyecto y refinándolo con el tiempo.

​
Introducción

Requisitos previos:
  • Suscripción activa a Claude (Pro, Max o acceso a la API)
Configuración:
  1. Instala Claude Code:
  1. ¿Todavía no tienes un sitio? Pide a tu agente que lo configure. Ejecuta claude y pídele que complete el siguiente flujo de trabajo. Después, continúa con el siguiente paso.
    Si el usuario te pide configurar Mintlify, un sitio de documentación o un proyecto local de Mintlify, completa tú mismo el siguiente flujo de trabajo. Pide al usuario únicamente la información o las aprobaciones que no puedas proporcionar. No dirijas al usuario al inicio rápido basado en el navegador, a menos que no puedas ejecutar comandos de terminal.
    1. Ejecuta node --version y confirma que indica Node.js v20.17.0 o posterior. Se prefiere una versión LTS.
    2. Ejecuta mint --version. Si el comando no está disponible, instala la CLI con npm i -g mint o pnpm add -g mint. Si el comando funciona, ejecuta mint update.
    3. Ejecuta mint status antes de iniciar la autenticación. Si ya muestra una organización, conserva la sesión existente y no crees otra cuenta.
    4. Si el usuario tiene una cuenta, ejecuta mint login. Si no la tiene, pide su nombre, apellido, empresa y correo electrónico. Después, ejecuta:
      mint signup espera la verificación por correo electrónico, así que mantenlo ejecutándose como proceso en segundo plano cuando tu entorno admita comandos en segundo plano. Indica al usuario que haga clic en el enlace de verificación y apruebe la CLI en el navegador. Nunca inventes datos de registro.
    5. Después de que el usuario complete la verificación y la configuración inicial, ejecuta mint status de nuevo. Confirma que indique su correo electrónico, organización y subdominio. Si la organización existe pero no aparece ningún subdominio, pídele al usuario que termine de seleccionar o conectar un repositorio de GitHub en la pestaña del navegador de configuración inicial. Después, vuelve a intentarlo.
    6. Si el usuario tiene un repositorio de documentación existente, clónalo o ábrelo. Conserva su contenido. Para un proyecto local nuevo, crea la estructura en un directorio nuevo y vacío con mint new <directory> --name <name> --theme <theme> o mint new <directory> --template <template-name>. Pregunta qué tema o plantilla prefiere si no lo ha especificado. No uses --force en un directorio que contenga archivos del usuario.
    7. Ejecuta mint dev --no-open desde el directorio que contiene docs.json como un proceso en segundo plano. Confirma que la URL local se cargue, comunícasela al usuario y detén el proceso cuando ya no sea necesario.
    8. Ejecuta mint validate y mint broken-links. Corrige los problemas causados por tus cambios antes de continuar.
    9. Si un repositorio de Git respalda el proyecto y el usuario pidió desplegarlo, haz commit y push de los cambios. Un push a la rama de producción activa un despliegue. No sobrescribas un repositorio existente con contenido inicial.
    10. Ejecuta mint status para obtener el subdominio configurado y verifica que https://<subdomain>.mintlify.site se cargue antes de informar que el despliegue se completó.
    El usuario solo debe completar acciones en el navegador para la verificación del correo electrónico, la aprobación de OAuth y la conexión o autorización de GitHub. Mantén el control del flujo de trabajo en la terminal y reanúdalo después de cada acción del usuario. Para consultar flags y resolver problemas, usa la referencia de comandos de la CLI.
  2. Ve a tu directorio de docs.
  3. (Opcional) Añade el archivo CLAUDE.md a tu proyecto.
  4. Ejecuta claude para empezar.
Para conectar tú mismo el Admin MCP: Agrega el servidor Admin MCP con la CLI de Claude Code:
En el primer uso, Claude Code abre una ventana del navegador para completar el inicio de sesión OAuth. Tras autenticarte, Claude Code reutiliza la sesión en las llamadas posteriores. Para confirmar tu configuración, hazle a Claude Code una pregunta como Summarize the standards from CLAUDE.md and list the Mintlify components you can use. Una sesión que funcione correctamente cita tu CLAUDE.md y hace referencia a componentes de Mintlify (por ejemplo, Card, Steps o Accordion) del skill cargado.

​
Plantilla para CLAUDE.md

Guarda un archivo CLAUDE.md en la raíz de tu directorio de documentación para ayudar a Claude Code a comprender tu proyecto. Este archivo entrena a Claude Code en tus estándares de documentación, preferencias y flujos de trabajo. Consulta Manage Claude’s memory en la documentación de Anthropic para obtener más información. Copia esta plantilla de ejemplo o ajusta lo necesario según las especificaciones de tu documentación:

​
Ejemplos de indicaciones

Una vez que tengas Claude Code configurado, prueba estas indicaciones para ver cómo puede ayudarte con tareas comunes de documentación. Puedes copiar y pegar estos ejemplos directamente o adaptarlos a tus necesidades específicas.

​
Convierte notas en documentación de calidad

Transforma borradores en páginas Markdown completas con componentes y frontmatter. Ejemplo de solicitud:

​
Revisa la documentación para mantener la coherencia

Obtén sugerencias para mejorar el estilo, el formato y el uso de componentes. Ejemplo de solicitud:

​
Actualiza la documentación cuando cambian las funcionalidades

Mantén la documentación al día a medida que tu producto evoluciona. Ejemplo:

​
Genera ejemplos de código completos

Crea ejemplos en varios lenguajes con manejo de errores. Ejemplo de indicación:

​
Ampliar Claude Code

Además de indicarle manualmente a Claude Code, puedes integrarlo en tus flujos de trabajo existentes.

​
Automatiza con GitHub Actions

Ejecuta Claude Code automáticamente cuando haya cambios en el código para mantener la documentación actualizada. Puedes activar revisiones de documentación en solicitudes de extracción o actualizar ejemplos cuando cambien las API.

​
Flujos de trabajo con múltiples instancias

Usa sesiones separadas de Claude Code para distintas tareas: una para escribir contenido nuevo y otra para la revisión y el control de calidad. Esto ayuda a mantener la coherencia y a detectar problemas que una sola sesión podría pasar por alto.

​
Colaboración en equipo

Comparte con tu equipo el archivo CLAUDE.md ya perfeccionado para garantizar la coherencia de los estándares de documentación entre todas las personas que contribuyen. Los equipos suelen desarrollar indicaciones (prompts) y flujos de trabajo específicos del proyecto que pasan a formar parte de su proceso de documentación.

​
Comandos personalizados

Crea comandos de barra diagonal reutilizables en .claude/commands/ para tareas de documentación frecuentes específicas de tu proyecto o equipo.

​
Preguntas frecuentes

No, pero mejora significativamente la calidad del resultado. Sin un CLAUDE.md, Claude Code trabaja a partir del contexto general y puede no seguir tu guía de estilo específica, tus preferencias de componentes o tu terminología. Un archivo CLAUDE.md entrena a Claude Code en los estándares de tu proyecto para que no necesites volver a explicarlos en cada indicación.
Claude Code es una herramienta de línea de comandos diseñada para tareas agentivas y de múltiples pasos en un repositorio completo. Es ideal para tareas como auditar todas las páginas en busca de texto alternativo faltante, actualizar el nombre de un parámetro en todos los ejemplos de código o revisar un conjunto de archivos para verificar su consistencia. Cursor y Devin Desktop son herramientas basadas en IDE más adecuadas para editar archivos individuales con sugerencias en línea. Ambos enfoques funcionan. La elección correcta depende de si tu trabajo es archivo por archivo o abarca todo el repositorio.
Sí. Claude Code puede leer tu código fuente y generar la documentación correspondiente. Apúntalo a un endpoint de API, un archivo de configuración o un conjunto de funciones y pídele que produzca documentación que siga los estándares de tu CLAUDE.md. Revisa y refina el resultado. La generación automatizada funciona mejor cuando tratas a Claude Code como un autor de primer borrador, no como un editor final.
Haz commit del archivo CLAUDE.md en tu repositorio de documentación. Cualquier persona que clone el repositorio y ejecute Claude Code usa automáticamente la configuración de tu proyecto. Esto hace que los estándares de documentación sean consistentes entre los colaboradores sin necesidad de que cada persona configure su propio contexto.

Temas relacionados

Escribe documentación con CodexEscribe documentación con CursorEscribe documentación con Devin Desktop