susanrosito
commented
4 years ago Actualización de este Issue: como armar bien la documentación:
-
La estructura de ejemplo que les puedo dejar es esta:
- Home (pagina inicial) - vi que ya la armaron :)
- Diagrama de arquitectura
- Prueba de concepto
- Entrega 1
- Entrega 2
- Entrega 3
- Entrega 4
- [disponible] acá pueden agregar otra pagina para mostrar más info que sea relevante para la documentación. Ej: modelo de MER.
-
La estructura de las paginas de los hitos (POC, Entregas) es que en cada una muestren:
- funcionalidades (que funcionalidades tiene hasta ahora el proyecto)
- diagrama de casos de uso (mostrar los casos de uso hasta el momento)
- hacer una breve descripción del caso o los casos que mencionaste en el diagrama.
-
si quieren ver ejemplos adicionales de los que se encuentran en el modulo 2 acá los tienen: https://github.com/CamilaSosa96/e-fix-doc/wiki https://github.com/fautalan1/TTip-Unquivalencia-Documentacion/wiki
Creen una wiki de github.
Estaría bueno que armen el README de este proyecto con: _El Logo y el nombre del proyecto. _Una breve descripción o objetivo del proyecto. _Poner los links de los repositorios (Back / Front)
Sigan la guía - "02 - TTIP - Guía para la Prueba de concepto de la Arquitectura", miren la "Parte 3 Documentación", que se encuentra en la pagina de la materia en la sección "Entregables", para poder armar la documentación. Tienen ejemplos más abajo para que puedan guiarse.