Armar documentación

[susanrosito]

Como armar bien la documentación:

• La estructura de ejemplo que les puedo dejar es esta:

  • Home (pagina inicial) - README :)
  • Diagrama de arquitectura
    • se encuentra en el README pero estaría bueno en lo posible un gráfico.
  • Prueba de concepto
  • Entrega 1
  • Entrega 2
  • Entrega 3
  • Entrega 4
  • [disponible] acá puedes agregar otro titulo/sección para mostrar más info que sea relevante para la documentación. Ej: modelo de MER.

• La estructura de los titulos/secciones de los hitos (POC, Entregas) es que en cada una muestre:

  • 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 quieres ver ejemplos adicionales de los que se encuentran en el modulo 2, acá los tienes: https://github.com/CamilaSosa96/e-fix-doc/wiki https://github.com/fautalan1/TTip-Unquivalencia-Documentacion/wiki

[susanrosito]

• Labels: Documentation
• Assignees: guido
• Milestone: Prueba de concepto