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 al día.

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 afinándolo con el tiempo.

​

Primeros pasos

Requisitos previos:

• Suscripción activa a Claude (Pro, Max o acceso mediante API)

Configuración:

1. Instala Claude Code:

npm install -g @anthropic-ai/claude-code

2. Ve al directorio de tus docs.
3. (Opcional) Añade el archivo CLAUDE.md que aparece a continuación a tu proyecto.
4. Ejecuta claude para empezar.

​

Plantilla de 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 ajústala 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 ni inventes información

## Contexto del proyecto
- Formato: archivos MDX con frontmatter YAML
- Configuración: docs.json para navegación, tema y ajustes
- Componentes: componentes de Mintlify

## Estrategia de contenido
- Documenta lo suficiente para el éxito del usuario: ni demasiado ni demasiado poco
- Prioriza la precisión y la utilidad de la información
- Haz el contenido perenne cuando sea posible
- Busca información existente antes de añadir contenido nuevo. Evita la duplicación salvo por un motivo estratégico
- Revisa los patrones existentes para mantener la coherencia
- Empieza realizando los cambios razonables más pequeños

## docs.json

- Consulta el [esquema de docs.json](https://mintlify.com/docs.json) al crear el archivo docs.json y la navegación del sitio

## Requisitos de frontmatter para páginas
- title: Título claro y descriptivo de la página
- description: Resumen conciso para SEO/navegación

## Estándares de redacción
- Voz en segunda persona ("tú")
- Prerrequisitos al inicio del contenido procedimental
- Prueba todos los ejemplos de código antes de publicar
- Adapta el estilo y formato al de las páginas existentes
- Incluye casos de uso básicos y avanzados
- Etiquetas de idioma en todos los bloques de código
- Texto alternativo en todas las imágenes
- Rutas relativas para los enlaces internos

## Flujo de trabajo con Git
- NUNCA uses --no-verify al hacer commits
- Pregunta cómo manejar los cambios no confirmados antes de empezar
- Crea una nueva rama cuando no exista una rama clara para los cambios
- Haz commits con frecuencia durante el desarrollo
- NUNCA omitas ni desactives los hooks de pre-commit

## No hacer
- Omitir el frontmatter en cualquier archivo MDX
- Usar URL absolutas para enlaces internos
- Incluir ejemplos de código no probados
- Hacer suposiciones: siempre pide aclaraciones

​

Prompts de ejemplo

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

​

Convertir notas en documentación de calidad

Convierte borradores en páginas Markdown bien estructuradas, con componentes y frontmatter.

Prompt de ejemplo:

ajustar

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

​

Revisar la documentación en busca de coherencia

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

Ejemplo de indicación:

ajustar

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

​

Actualiza la documentación cuando cambien las funcionalidades

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

Ejemplo de prompt:

ajustar

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

ajustar

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

​

Extender Claude Code

Además de interactuar manualmente con 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 al día. Puedes activar revisiones de documentación en pull requests 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 redactar contenido nuevo y otra para revisión y aseguramiento de la 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 tu archivo CLAUDE.md refinado con tu equipo para garantizar estándares de documentación consistentes entre todos los colaboradores. Los equipos suelen desarrollar prompts y flujos de trabajo específicos del proyecto que pasan a formar parte de su proceso de documentación.

​

Comandos personalizados

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