¿Qué es un archivo ReadMe?
Un archivo de lectura es un archivo de texto que a menudo se incluye con el software que contiene información general o instrucciones sobre el software. La naturaleza específica de esta información varía significativamente de un archivo a otro; Un archivo ReadMe puede contener instrucciones de instalación, información general de uso del software, términos de servicio y otra información legal, o cualquier otra información relevante para el software. Casi todos los archivos ReadMe al menos incluyen el nombre y la versión del software, el nombre de la empresa o individuo que desarrolló el software y la fecha de publicación. Sin embargo, no existe una fórmula general para escribir un ReadMe, y al final el contenido depende de los caprichos del desarrollador.
El nombre "ReadMe" tiene la intención de atraer la atención del usuario al archivo, ya que a menudo incluye la información necesaria para operar correctamente el software. En muchos casos, el nombre del archivo de un archivo ReadMe se capitalizará y se llamará "ReadMe.txt" o algo similar. Algún director de programaS Mueva los nombres de los archivos capitalizados en la parte superior de cualquier lista de archivos, por lo que la capitalización le da a la prominencia de archivo ReadMe y nuevamente alienta al usuario del software a leer el archivo antes de usar el programa. Algunos archivos ReadMe en realidad se titulan "Leer primero" o algo similar para alentar a los lectores a mirar a través de la documentación antes de ejecutar el software.
Un archivo README puede contener muchos tipos diferentes de información de importancia variable. Además de los nombres y las versiones de archivos, que generalmente se incluyen, los archivos ReadMe también a menudo incluyen un historial de versiones o ChangeLog que enumera los cambios realizados en el software a lo largo del tiempo. Un readme también puede incluir una lista de problemas o errores conocidos que afectan el uso del software. Algunos incluyen información menos esencial, como reconocimientos o mensajes personales del equipo de desarrollo. Para programas particularmente simples, el archivo ReadMe puede actuary sirve como un manual de usuario que instruye a uno en el uso general del software.
Los archivos de lectura elaborados son muy raros, ya que los desarrolladores generalmente prefieren establecer la información necesaria de una manera simple, clara y concisa. Un archivo ReadMe generalmente se presenta en un formato de texto sin formato con una fuente estándar y sin imágenes a menos que el desarrollador sienta que es necesario algo más elaborado. Esta simplicidad elimina las distracciones innecesarias y mantiene al lector enfocado en la información. A veces, un archivo README se presenta en un formato de "preguntas frecuentes" o frecuentes. En tal formato, el desarrollador predice las preguntas más comunes que las personas pueden tener sobre el software y proporciona respuestas claras y simples en lugar de exponer toda la información técnica en un bloque de texto que las personas no pueden ver a leer.