La forma correcta de usar CLAUDE.md

CLAUDE.md es un archivo especial ubicado en el directorio raíz del proyecto, utilizado para informar a los asistentes de IA (como Claude) sobre la información clave de tu proyecto. Escribir bien este archivo permite que la IA comprenda y te ayude mejor.

¿Por qué necesitas CLAUDE.md?

Imagina que tienes un nuevo colega, ¿cuánto tiempo te tomaría hacerle entender tu proyecto? CLAUDE.md es ese "manual del proyecto" que permite a la IA comenzar rápidamente.

Los cinco contenidos centrales de CLAUDE.md

1. Resumen del proyecto

Describe brevemente qué hace este proyecto, qué problema resuelve y a qué usuarios está dirigido.

# Resumen del proyecto Este es un sistema de gestión de backend de comercio electrónico, utilizado para gestionar productos, pedidos y usuarios.

2. Pila tecnológica (Tech Stack)

Enumera las principales tecnologías y frameworks utilizados en el proyecto.

`# Pila tecnológica

Frontend: React + TypeScript
Backend: Node.js + Express
Base de datos: PostgreSQL
Despliegue: Docker + Kubernetes`

3. Estructura de archivos

Explica la función de los directorios principales.

# Estructura de archivos /src /components - Componentes de la interfaz de usuario /pages - Páginas /utils - Funciones de utilidad /api - Llamadas a la API

4. Comandos comunes

Enumera los comandos de uso común durante el desarrollo.

# Comandos comunes npm run dev - Inicia el servidor de desarrollo npm run build - Construye la versión de producción npm run test - Ejecuta las pruebas

5. Reglas

Define las reglas que la IA debe seguir al ayudarte a escribir código.

`# Reglas de codificación

Usar componentes funcionales
Seguir la configuración de ESLint
Usar PascalCase para nombrar los componentes
Usar camelCase para nombrar las variables`

Un ejemplo completo

`# Nombre del proyecto: Task Manager

Resumen del proyecto

Una aplicación sencilla de gestión de tareas que admite la creación, edición, eliminación y clasificación de tareas.

Pila tecnológica

React 18
TypeScript
Tailwind CSS
Vite

Estructura de archivos

/src /components - Componentes de la interfaz de usuario /hooks - Custom Hooks /types - Definiciones de tipos de TypeScript /utils - Funciones de utilidad

Comandos comunes

npm run dev: Inicia el servidor de desarrollo
npm run build: Construye la versión de producción
npm run lint: Comprobación de código

Normas de codificación

Usar escritura funcional para los componentes
Usar Tailwind CSS para los estilos
Colocar cada componente en una carpeta separada`

Consejos

Mantén la brevedad: No escribas demasiado, la IA también se "cansará"
Actualiza periódicamente: Recuerda actualizar CLAUDE.md cuando el proyecto cambie
Prioriza los ejemplos: Dar ejemplos de código concretos es más eficaz que las descripciones abstractas
Céntrate en los puntos débiles: Explica en detalle las áreas propensas a errores

¡Escribe bien CLAUDE.md y convierte a la IA en tu valioso asistente!