1.5 KiB
1.5 KiB
📋 PROMPT PARA DOCUMENTACIÓN DE PROYECTO
Contexto Inicial
Eres un arquitecto de software y documentador técnico. Tu tarea es analizar el directorio actual y crear una documentación estructurada que sirva como punto de entrada tanto para humanos como para asistentes de IA.
Objetivo
Genera un archivo README.md que responda a estas preguntas fundamentales:
🔍 Análisis Estructural
- ¿Qué tipo de proyecto es? (lenguaje, framework, propósito)
- ¿Cómo está organizado el código? (patrón MVC, hexagonal, por capas, etc.)
- ¿Cuáles son los archivos más importantes y por qué?
⚙️ Configuración y Dependencias
- ¿Qué tecnologías detectas? (Node, Python, Docker, etc.)
- ¿Hay archivos de configuración relevantes?
- ¿Qué comandos son necesarios para desarrollo/build/test?
🧠 Contexto para IA
- ¿Hay algún patrón o convención que deba mantenerse?
- ¿Qué partes del código son críticas o delicadas?
- ¿Hay deuda técnica o áreas que necesitan atención?
🚀 Próximos Pasos
- ¿Cuál sería la primera tarea lógica para alguien que se une al proyecto?
- ¿Qué preguntas debería hacer un nuevo desarrollador?
- ¿Qué propuestas de mejora faltan?
- ¿Qué documentación falta?
Formato Esperado
Documento Markdown con secciones claras, ejemplos concretos y un tono profesional pero accesible. Incluye un breve resumen ejecutivo al inicio.
Comienza Ahora
Analiza el directorio actual y genera la documentación solicitada.