jlr2
commented
3 years ago CORRECCIÓN FINALZADA Corrección del manual técnico
- Portada: con imagen representativa del proyecto., título del proyecto, datos de los alumnos participantes, datos del centro, datos del profesor curso académico, datos del módulo. Bien en general. Corrige: Luis NO lleva tilde. El módulo es "Proyecto". Añade ciclo pero aparte: "Grado Superior de Desarrollo de Aplicaciones Multiplataforma".
- Licencia. Bien.
- Índice, Bien, a falta de que incluyas el resto de apartados pedidos.
- Introducción. Mejora la redacción, tu primera frase "Global-Chat será ..." no suena bien.
- Objetivo general. Pasable.
- Objetivos específicos. Corregiría "Conocer qué tipo de seguridad ..." por "implementar de medidas de seguridad como NOMBRAR LAS TECNOLOGÍAS". Aparte te falta la integración continua/despliegue continuo dockerizando la app.
- Tecnologías usadas en el proyecto. Añade un índice al principio presentando las diferentes tecnologías. Imágenes de las tecnologías: reducir tamaño, las veo algo grandes. Usas la primera persona en algunas partes; cambia al modo impersonal (ejeplo dices: Para crearla utilicé el comando "docker run -p 27017:27017 bitnami/mongodb" en el CMD de Windows). Por otra parte, todos los contenedores que crees deberían ir en docker-compose. Docker: falta explicar cómo haz usado esta tecnología en el proyecto, al igual que comentas con otras tecnologías. Jenkins: mismo comentario que Docker. Microservicios: faltarían añadir los 3 de infraestructura (cloud config, service discovery, gateway). Token JWT: enumera los pasos que se siguenen el ciclo de vidad de un token JWT (quedará más claro poniendo los pasos como una lista ordenada). Web Sockets: muestras una imagen comparativa entre HTTP y web sockets, pero no veo clara la explicación adicional; mejorar.
- Entorno de desarrollo usado explicando la configuración del mismo para el desarrollo de la aplicación (parámetros configurados como SDK, ruta a ficheros compilados …), utilidades adicionales usadas (por ejemplo Spring Initializr) gestor de dependencias y dependencias agregadas (por ejemplo Maven), estructura de paquetes (MVC) indicando la funcionalidad y componentes de cada uno (clases, interfaces…). Explicas la arquitectura y Spring Initializr. No explicas el resto: configuración usada del IDE para el desarrollo del proyecto.
- Análisis del proyecto. Casos de usos (Diagramas y Descripción de los mismos). Los detalles están descritos en el issue [Profe] Especificaciones de fase de análisis #2 Deberías explicar qué es cada apartado, realizando una breve introducción. Gestión de usuario: te falta ConsultarDatosUsuario.. Diagrama de GestiónChat: cambia EnviarCorreo. Falta incluir CU CrearAlbum (diagrama y descripción). En gestión de seguridad: deberíasindicar que son funcionalidades implícitas a los CU (podrías haber refinado tu análisis incluyéndolo en los diagramas, pero puedes dejarlo así.
- Diseño del proyecto. Modelo de objetos del negocio. Los requerimientos están descritos en el issue [Profe] Especificaciones de la fase de diseño #3
- Diagrama de clases: deben mostrarse los atributos así como una descripción de cada clase y la relación entre ellas. Cambia 'logar' por 'loguear'. Hay ciertas interfaces que describes como clase; por ejemplo UserService dices que es "clase que se ..."; corregir ésta y el resto. Por otro lado debes matizar que las interfaces sirven para realizar la inyección de dependencias que realiza Spring.
- Base de datos: si el modelado ha sido de base de datos NoSQL deben mostrarse los documentos usados con una explicación de los atributos que lo forman.
- Codificación del proyecto. Explicación de cada funcionalidad (caso de uso) y el código que lo implementa.
- Escribe algún titulo en cada apartado (controladores, MongoDB, User, Service ...) de forma que quede más visible y estructurado todo el apartado.
- Controladores: muestras código con las anotaciones @RequestMapping,@GetMapping y @PostMapping; debes explicar más.
- Clase UserService: explicar -
- Interface UserRepository: hay un método de nomber existsByEmail ¿No lo has cambiado a Chat?.
- Frontend: no explicas el código del frontend donde se vincula con el backend; has indicado la anotación @PostMapping (muestras todo el código en la misma línea; no es visible) pero no se explica el código del frontend. Mismo comentario para registrarse, inicio de sesión, consultar datos de usuario, gestión de chat.
- Firebase: no explicas el registro con Firebase.
- Web Socket: pon el código en varias líneas; en una sola línea no es legible.
- Pruebas. Documenta las pruebas realizadas.
- Crea un índice al principio del apartado indicando los tipos de pruebas documentadas.
- Pones que hay un enlace de un videotutorial pero no está actdivo, no?
- Log: ok
- Firebase: creación de album Ok
- SQL Injection: Ok
- Usuarios: OK
- Pruebas propias de la app, es decir, envío de chats: No las veo. Imagino que es el videotutorial que indicabas.
- Despliegue de la aplicación. Pasos a realizar para poner en producción la aplicación. En este apartado se incluirá el uso de integración y despliegue continuo haciendo uso de Jenkins. Falta por realizar
- Detalles técnicos interesantes encontrados en el desarrollo del proyecto: explicación de aspectos técnicos de interés usados en el desarrollo del proyecto no explicados en los puntos anteriores. Seguridad: nombras la seguridad sin más; estaría bien que añadas una lista de los items de seguridad que has incluido en tu proyecto (sin entrar ya en detalle porque lo hicistes en otro apartado. Pon en negrita (destaca) los 3 detalles que has incluido (seguridad, ci/cd, cloud computing).
- Problemas surgidos durante su desarrollo. Soluciones analizadas.
- Recuperación de contraseña: incluye el código que finalmente no te funcionó, pero lo suyo es dejarlo como evidencia del trabajo realizado.
- Jenkins y AWS: no estaría mal una figura explicativa del proceso.
- Mejoras posibles a realizar en el proyecto. Explicar líneas de actuación futura para una posible continuación del proyecto. OK
- Conclusiones OK. Muy emotivo
- Bibliografía/Webgrafía.
- Numera la lista; cada entrada debe tener un número que la identifique.
- Formato: corrígelo de forma que te quede del siguiente modo --> Título (la URL que no sea visible sino como hiperenlace del propio título) + Breve descripción. Ejemplo: 1.- Curso React Youtube - Videotutorial explicativo de la tecnología React.
La documentación estará compuesta de los siguientes documentos:
En este issue se detallan los requisitos de los manuales técnico y de usuario.
Manual técnico La documentación del manual técnico será realizada en Github y debe contener:
Hay que estructurar los apartados en diferentes páginas debiendo existir una página índice que contenga: portada, licencia, índice, introducción, conclusiones, biografía/webgrafía. El resto de apartados serán accesibles desde el propio índice y serán ubicados en páginas diferentes.
La documentación debe contener suficiente imágenes, capturas de pantalla., figuras que ayuden a la comprensión del manual.
Manual de usuario Realiza un manual explicando cómo un usuario puede acceder al producto desarrollado en el proyecto. Debe realizarse un vídeo demostrativo (vídeo-tutorial) donde se expliquen todas las funcionalidades del proyecto acorde con los casos de uso planteados en el manual técnico.
Usa la plantilla de presentación de vídeotutoriales.