Claude Code

Configura Claude Code para ayudar a escribir, revisar y actualizar tu documentación

Claude Code es una herramienta de línea de comandos con capacidades de agente que puede ayudarte a mantener tu documentación. Puede redactar contenido nuevo, revisar páginas existentes y mantener la documentación actualizada.

Puedes entrenar 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 perfeccioná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:

  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.

​

Plantilla 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:

# 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

​

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:

Convierte este texto en una página MDX con el formato correcto: [pega tu texto aquí]

​

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:

Revisa los archivos en docs/ y sugiere mejoras para mantener la consistencia y claridad

​

Actualiza la documentación cuando cambian las funcionalidades

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

Ejemplo:

Nuestra API ahora requiere un parámetro de versión. Actualiza nuestra documentación para incluir version=2024-01 en todos los ejemplos

​

Genera ejemplos de código completos

Crea ejemplos en varios lenguajes con manejo de errores.

Ejemplo de indicación:

Crea ejemplos de código para [tu endpoint de API] en JavaScript, Python y cURL con manejo de errores

​

Ampliar Claude Code

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

​

Automatización 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 se detecten cambios en la 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.