Files
mintlify__docs/es/guides/claude-code.mdx
locadex-agent[bot] bbb1a08ed3 docs(locadex): update translations (#1778)
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
2025-11-14 14:44:09 -08:00

180 lines
6.6 KiB
Plaintext

---
title: "Claude Code"
description: "Configura Claude Code para redactar, revisar y actualizar tu documentación."
keywords: ["Claude Code", "CLAUDE.md", "Anthropic", "Claude"]
---
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.
<div id="getting-started">
## Introducción
</div>
**Requisitos previos:**
* Suscripción activa a Claude (Pro, Max o acceso a la API)
**Configuración:**
1. Instala Claude Code:
```bash
npm install -g @anthropic-ai/claude-code
```
2. Ve a tu directorio de docs.
3. (Opcional) Añade el archivo `CLAUDE.md` a tu proyecto.
4. Ejecuta `claude` para empezar.
<div id="claudemd-template">
## Plantilla CLAUDE.md
</div>
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&#39;s memory](https://docs.anthropic.com/en/docs/claude-code/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:
```mdx
# Documentación de Mintlify
## Relación de trabajo
- Puedes cuestionar ideas: esto puede llevar a una mejor documentación. Cita fuentes y explica tu razonamiento cuando lo hagas
- SIEMPRE pide aclaraciones en lugar de hacer suposiciones
- NUNCA mientas, adivines o inventes nada
## Contexto del proyecto
- Formato: archivos MDX con frontmatter YAML
- Configuración: docs.json para navigation, tema, configuraciones
- Componentes: componentes de Mintlify
## Estrategia de contenido
- Documenta lo justo para el éxito del usuario: ni demasiado, ni muy poco
- Prioriza la precisión y usabilidad
- Haz el contenido duradero cuando sea posible
- Busca contenido existente antes de agregar algo nuevo. Evita la duplicación a menos que se haga por una razón estratégica
- Verifica patrones existentes para mantener consistencia
- Comienza haciendo los cambios más pequeños y razonables
## docs.json
- Consulta el [esquema de docs.json](https://mintlify.com/docs.json) al construir el archivo docs.json y la navigation del sitio
## Requisitos de frontmatter para páginas
- title: Título de página claro y descriptivo
- description: Resumen conciso para SEO/navigation
## Estándares de escritura
- Voz en segunda persona ("tú")
- Prerrequisitos al inicio del contenido procedimental
- Prueba todos los ejemplos de código antes de publicar
- Coincide con el estilo y formato de páginas existentes
- Incluye casos de uso básicos y avanzados
- Etiquetas de lenguaje en todos los bloques de código
- Texto alternativo en todas las imágenes
- Rutas relativas para enlaces internos
## Flujo de trabajo de Git
- NUNCA uses --no-verify al hacer confirmaciones
- Pregunta cómo manejar cambios no confirmados antes de comenzar
- Crea un nuevo branch cuando no exista un branch claro para los cambios
- Haz confirmaciones frecuentemente durante el desarrollo
- NUNCA omitas o deshabilites los hooks de pre-commit
## No hagas
- Omitir frontmatter en ningún archivo MDX
- Usar URLs absolutas para enlaces internos
- Incluir ejemplos de código no probados
- Hacer suposiciones: siempre pide aclaraciones
```
<div id="sample-prompts">
## Ejemplos de indicaciones
</div>
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.
<div id="convert-notes-to-polished-docs">
### Convierte notas en documentación de calidad
</div>
Transforma borradores en páginas Markdown completas con componentes y frontmatter.
**Ejemplo de solicitud:**
```text wrap
Convierte este texto en una página MDX con el formato correcto: [pega tu texto aquí]
```
<div id="review-docs-for-consistency">
### Revisa la documentación para mantener la coherencia
</div>
Obtén sugerencias para mejorar el estilo, el formato y el uso de componentes.
**Ejemplo de solicitud:**
```text wrap
Revisa los archivos en docs/ y sugiere mejoras para mantener la consistencia y claridad
```
<div id="update-docs-when-features-change">
### Actualiza la documentación cuando cambian las funcionalidades
</div>
Mantén la documentación al día a medida que tu producto evoluciona.
**Ejemplo:**
```text wrap
Nuestra API ahora requiere un parámetro de versión. Actualiza nuestra documentación para incluir version=2024-01 en todos los ejemplos
```
<div id="generate-comprehensive-code-examples">
### Genera ejemplos de código completos
</div>
Crea ejemplos en varios lenguajes con manejo de errores.
**Ejemplo de indicación:**
```text wrap
Crea ejemplos de código para [tu endpoint de API] en JavaScript, Python y cURL con manejo de errores
```
<div id="extending-claude-code">
## Ampliar Claude Code
</div>
Además de indicarle manualmente a Claude Code, puedes integrarlo en tus flujos de trabajo existentes.
<div id="automation-with-github-actions">
### Automatización con GitHub Actions
</div>
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 se detecten cambios en la API.
<div id="multi-instance-workflows">
### Flujos de trabajo con múltiples instancias
</div>
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.
<div id="team-collaboration">
### Colaboración en equipo
</div>
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.
<div id="custom-commands">
### Comandos personalizados
</div>
Crea comandos de barra diagonal reutilizables en `.claude/commands/` para tareas de documentación frecuentes específicas de tu proyecto o equipo.