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 que la IA se ponga al día 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

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 - Iniciar el servidor de desarrollo npm run build - Construir la versión de producción npm run test - Ejecutar 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 componentes
Usar camelCase para nombrar variables`

Un ejemplo completo

`# Nombre del proyecto: Task Manager

Resumen del proyecto

Una aplicación simple 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 - Hooks personalizados /types - Definiciones de tipo TypeScript /utils - Funciones de utilidad

Comandos comunes

npm run dev: Iniciar el servidor de desarrollo
npm run build: Construir la versión de producción
npm run lint: Revisión de código

Normas de codificación

Usar escritura funcional para componentes
Usar Tailwind CSS para 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 efectivo que descripciones abstractas
Presta atención a los puntos débiles: Explica detalladamente las áreas propensas a errores

¡Escribe un buen CLAUDE.md y haz que la IA se convierta en tu valioso asistente!