#280 Programacion Básico Público v1 ChatGPT, Claude, GitHub Copilot #readme #markdown #repositorio #documentacion

Crear README

Documentar proyectos para equipos técnicos o repositorios públicos.

Volver a biblioteca
🤖
Modelo probado
ChatGPT, Claude, GitHub Copilot
📊
Dificultad
Básico
🔖
Versión
v1
📅
Creado
20/05/2026
Revisado
20/05/2026
⏱️
Tiempo estimado
10 min
🔑
Acceso
Público
Recomendación
🎯

Para qué sirve

Documentar proyectos para equipos técnicos o repositorios públicos.

📌

Cuándo usarlo

Cuando se necesita una primera documentación de uso e instalación.

📥

Datos de entrada necesarios

Descripción del proyecto, stack y comandos disponibles.

📤

Resultado esperado

README estructurado en Markdown.

💡

Ejemplo de uso

Proyecto: librería Python de validación de datos.

🔧

Consejos para mejorarlo

Ajustar placeholders, tono, extensión y formato al caso real antes de ejecutar el prompt.

📝

Nota del curador

Prompt normalizado para hacerlo más claro, reutilizable y seguro sin cambiar su intención funcional.

⚠️

Restricciones

No inventar datos; indicar los supuestos; adaptar el resultado al contexto real; revisar la salida antes de usarla. No ejecutar ni desplegar código sin pruebas; revisar seguridad, dependencias y compatibilidad.

Prompt completo

Actúa como technical writer para proyectos de software. Crea un README completo para este proyecto: {PROYECTO} Incluye: 1. Nombre y descripción del proyecto. 2. Requisitos previos. 3. Instalación. 4. Configuración. 5. Uso básico con ejemplos. 6. Estructura del proyecto, si se conoce. 7. Contribución. 8. Licencia o nota pendiente si no se aporta. No inventes comandos ni dependencias; marca como pendiente lo que no esté informado.

Personalizar prompt

Completa los valores de las variables para generar un prompt personalizado.

Prompt personalizado

Actúa como technical writer para proyectos de software. Crea un README completo para este proyecto: {PROYECTO} Incluye: 1. Nombre y descripción del proyecto. 2. Requisitos previos. 3. Instalación. 4. Configuración. 5. Uso básico con ejemplos. 6. Estructura del proyecto, si se conoce. 7. Contribución. 8. Licencia o nota pendiente si no se aporta. No inventes comandos ni dependencias; marca como pendiente lo que no esté informado.