- Razón de existir del archivo README
- El README es un contenido importante que define la primera impresión de un proyecto de código
- Es la cara del proyecto y también su manual de uso
- Ayuda a entender por qué existe el código, qué problema resuelve y por qué es importante
- Explica el propósito del proyecto, cómo instalarlo y cómo usarlo
- Proporciona información importante para todas las personas que participan en el proyecto y aumenta el valor del código
- Un README excelente puede tener un gran impacto incluso en el éxito del proyecto
- El código existe para resolver problemas, y el README debe comunicar con claridad la importancia de ese problema y cómo se resuelve
- Un proyecto sin README
- Es un laberinto sin señalización
- Puede hacer que disminuya el interés en el proyecto y que un proyecto útil no llegue a ser ampliamente conocido
- Dificulta que los desarrolladores mantengan y mejoren el proyecto
- Lleva mucho tiempo entender la estructura del código existente o la forma de uso
- Requisitos para escribir un README
- Siempre debe contener información actualizada
- Si hay cambios en el proyecto, el README también debe actualizarse
- El README debe ser conciso, pero proporcionar toda la información necesaria
- Si el contenido se alarga, se deben crear nuevos archivos según el propósito, guardarlos por rutas separadas y agregar hipervínculos
- Contenido que debe incluir el README
- Funciones principales y objetivo del proyecto
- Método de instalación: guía de instalación paso a paso, herramientas y bibliotecas necesarias para la instalación, e instrucciones de configuración del entorno
- Cómo resolver problemas: problemas frecuentes y sus soluciones
- Canales de soporte: responsables principales del mantenimiento del proyecto o cómo comunicarse con quienes están a cargo de la comunicación
- Información de licencia: la licencia especifica los derechos y restricciones relacionados con el uso, modificación y distribución del código
- Registro de cambios: historial de actualizaciones importantes del proyecto
- Ejemplos de uso
- Recursos adicionales de aprendizaje y enlaces a documentación
- Requisitos previos: para ayudar a que el usuario pueda preparar fácilmente el entorno donde instalará y ejecutará el proyecto
Aún no hay comentarios.