IIC2233 / Syllabus-2023-1

75 stars 44 forks source link

Readme y Diagrama de Clases #190

Closed TriniAguilera closed 1 year ago

TriniAguilera commented 1 year ago

Prerrequisitos

(Marcar colocando una X entre los corchetes los ítems que ya hiciste, así: "[X]")

Hola! Quería saber si el detalle de los atributos, métodos, clases abstractas, properties y todo eso puedo detallarlo en el archivo de Markdown del diagrama de clases y no en el Readme principal. En este último detallo sobre el flujo del programa, modularización, bonus y esas cosas. Pregunto esto porque sino siento que va a quedar muy denso y desordenado el Readme principal.

También quiero saber si hay algún problema con crear una carpeta dentro de la carpeta T1 que contenga la imagen del Diagrama de Clases y su respectivo documento explicativo.

matiasmasjuan commented 1 year ago

Hola @TriniAguilera :

Si, todo lo relacionado al detalle de las clases puede ir especificado en el diagrama de clases y no es necesario que lo especifiques en el Readme.md. Tal como dices, el objetivo del Readme es especificar temas de flujo, modularización, aspectos implementados y no implementados, además de cualquier supuesto realizado y citas de código externo. Sobre lo segundo, , puedes crear una carpeta dentro de la T1 que contenga tanto la imagen como la explicación del diagrama. Recuerda especificar en el Readme su ubicación y el nombre de la carpeta.

Saludos!