Skip to content

16. Reunión documentación

MoiGL edited this page May 11, 2022 · 8 revisions

Reunión con Hugo para mejorar nuestra documentación

  1. Requisitos funcionales -> mucha paja (1.1) Requisitos no funcionales -> sobra docker,ts... (1.1)
  • Títulos en inglés y en español.
  1. Restricciones de arquitectura (2) -> Tienen que ser las OBLIGACIONES del enunciado.
  • Poner números bien (no se lo q significa) (2.2)
  • Cambio de lenguaje ts a ES, mirar target de versiones (2.3)
  • Idioma (2.3)
  • Gitflow (2.3)
  1. Cambiar los iconos para que quede claro para alguien que no sabe. Eliminar Dede y explicar un poco en el siguiente párrafo. Quitar redundancias en las entradas y salidas. (SOLID POD - POD) Quitar "elemento de comunicación" de la tabla. (3.1)

Diagrama del despliegue de la aplicación (No es estrictamente necesario si no aporta) (3.2)

  1. 4.2 no es necesario)

  2. Diagramas

  • Frontend y backend (5.2)
  • Nombre de ficheros, relacionandose entre si (imports) y con componentes (PODs, API Shippo) (5.4) Si hay un import, alguien apunta al fichero.
  1. Pod cilindro y quitar BD. Database y DB (unificar nombres)

  2. Poner protocolos, quitar DeDe

    • Modelo de dominio: poner precio en pedido, quitar talla en producto. (8.1)
  • Quitar internacionalizacion (8.3)
  • Quitar seguridad y privacidad (8.4)
  1. Sobran las que son restricciones. Problemas, ventajas y desventajas.

    • Otro diagrama más chulo (10.1)
  • Cuantificar la calidad de los objetivos (10.2)
  1. Añadir arc42
Clone this wiki locally