Uso de del fichero README.md para la documentación de los proyectos de aula del programa de Ingeniería de Sistemas sede Villavicencio

Los proyectos de aula son una de las buenas prácticas que tiene el programa de Ingeniería de Sistemas de la sede Villavicencio; la finalidad de estos es que los estudiantes presenten el trabajo realizado durante todo el semestre en forma de proyectos en los cursos específicos del programa y algunos de los transversales. A nivel profesional, los proyectos se están realizando con la ayuda de herramientas de control de versiones y almacenando los mismos en repositorios tipo Git como GitHub, GitLab o Bitbucket entre otros, para tener una trazabilidad como indica [1]. La falta de un sistema de seguimiento adecuado, que permita la identificación de distintos documentos o elementos en el proceso de desarrollo de software, podría generar complicaciones y, en consecuencia, afectar negativamente la calidad del producto. Una parte fundamental en la ejecución de proyectos consiste en la creación de una documentación de calidad [2]. En este sentido, los estudiantes suelen llevar a cabo este proceso mediante la elaboración de un trabajo escrito, comúnmente en Word. Sin embargo, con el propósito de mejorar este enfoque, esta guía busca fomentar la creación de documentación en un formato de archivo de texto plano enriquecido con Markdown. Este formato está ganando popularidad como un estándar para los archivos readme en diversos repositorios de proyectos. Esta guía propone que se utilice el fichero readme.md, para llevar la documentación del proyecto y que se puedan aprovechar todas las características de los repositorios y del formato Markdown, para realizar una documentación adecuada. Esta herramienta permite, además, llevar un control de la evolución del documento escrito en el repositorio y generar una cultura de documentación adecuada a los estándares de la industria de la programación.

• Autores: Torres-Londoño, Carlos Ignacio; Patiño Martínez, Francy Yaneth; Chica Sosa, Piedad
• Tipo de recurso: Informe
• Fecha de publicación: 2023
• Institución: Universidad Cooperativa de Colombia
• Repositorio: Repositorio UCC
• OAI Identifier: oai:repository.ucc.edu.co:20.500.12494/52833
• Acceso en línea: http://dx.doi.org/10.16925/gcgp.87; https://hdl.handle.net/20.500.12494/52833
• Palabra clave: Documentación; Markdown; README; Repositorio
• Rights: openAccess
• License: Atribución – No comercial – Sin Derivar