search

IIC2513-2018-2 / syllabus

Material y coordinación del curso
10 stars 4 forks source link

Otra duda del enunciado de la entrega 6... #56

Closed KyuubiNoKitsune closed 5 years ago

KyuubiNoKitsune commented 5 years ago

Hola,

se pide realizar una documentación pero no entiendo si es de la API o de toda la aplicación entera.

Saludos y gracias de antemano

raulmt commented 5 years ago

De la aplicación

KyuubiNoKitsune commented 5 years ago

Me pasa que las documentaciones que siempre he visto son de APIs o de librerías que sirven para realizar algoritmos por mi (y no inventar la rueda de nuevo). Me cuesta imaginarme como podría hacer una documentación de mi app ya que no cae exclusivamente en una de esas dos categorías.

raulmt commented 5 years ago

pero la doc de tu app, como dice el enunciado, no es pensando en alguien que vaya a usarla como API o algo de ese estilo, sino documentación pensada en que alguien quiera seguir desarrollando la misma aplicación. Cosas como un modelo de datos (actualizado, pues probablemente cambió desde la E1), algún esquema o descripción de cómo están organizados los controllers y las rutas, qué librerías relevantes estás usando que haya que considerar, partials relevantes, descripción de layouts si es que tienes más que uno y hay que elegirlo dependiendo de las vistas que quieras crear, etc. En el fondo, piensa si tú te estuvieras uniendo recién al equipo: qué cosas te servirían para poder ponerte a desarrollar en este proyecto antes y con menos errores por desconocimiento? (obviamente, suponiendo que ya sabes usar koa y derivados, que tienen su propia documentación en cualquier caso).

Se entiende mejor la idea?