CHK-DGT-004 Verificación de Frontend
v 4.0
Propósito
Esta checklist tiene como propósito el ser utilizada con el fin de garantizar la integridad en el proceso de desarrollo del proyecto LinkBridge, así como disminuir los defectos inyectados en la fase de desarrollo.
Notas introductorias
En la sección de "Criterios de Aceptación", se identifica con "CM" los criterios que pertenecen a Gestión de la Configuración y con "PPQA" los que pertenecen al Aseguramiento de la Calidad del Proceso y del Producto
Criterios de Aceptación
PPQA
Inconsistencia
- El desarrollo debe ser coherente con la información proporcionada durante el análisis y diseño de requerimientos. Debe mostrar cómo se abordará el problema y cómo se cumplirán los criterios de aceptación.
Portabilidad
- El desarrollo del Frontend se realiza en un navegador derivado de Chromium conforme a la última versión estable, la 102 (28 de abril del 2022). En caso de haber sido desarrollado de esta manera, probar todas las funcionalidades implementadas en un navegador con estas características.
Organización de Archivos
- Los archivos están organizados en las carpetas correctas según su tipo y función dentro del proyecto, y se apegan al
- No existen archivos obsoletos o sin utilizar
- No existen archivos o componentes repetidos
Uso de Funciones y Modularización
- Las implementaciones de interfaces están completas, claras y siguen los principios de diseño limpio
- El código se encuentra correctamente documentado según el EST-DGT-002 Estándar para comentarios de Código con Doxygen
Seguridad y Configuración
- Verificar que no se revela información confidencial en el código, como claves API, URLs de bases de datos, etc
- Asegurarse de que todas las claves secretas y configuraciones sensibles están en variables de entorno y no están codificadas directamente en el código fuente
- Asegurarse de que todos las rutas estén protegidas con autenticación adecuada
Nomenclatura
- Los nombres de los archivos están apegados al EST-DGT-001 Estándar para nombres de Archivos de Código
- Nombres de funciones, variables y archivos están definidos en inglés
Mantenibilidad y Escalabilidad
- Asegurarse que el código sea desarrollado de manera modular y reutilizable para facilitar el mantenimiento y la expansión futura del sistema, haciendo uso de:
- Hooks personalizados
- Funciones auxiliares
- Estados globales
Manejo de errores
- Asegurarse de que los mensajes de error sean informativos y comprensibles para los usuarios
Verificación
- Verificar se cumple con el sistema de diseño creado por el equipo de User Interface/User Experience
- Verificar que cumple con el font elegido
- Verificar que se cumplen los colores seleccionados en el tailwind.config.js y colors.tsx
- Verificar que no existen errores de ortografía
- Verificar que el diseño es responsivo para mobile, tableta y escritorio, con un mínimo de 320px y máximo de 1500 px de pantalla.
- Verificar que se hacen uso de los componentes correctos de MUI Joy UI
- Verificar que se utilicen correctamente las etiquetas semánticas de HTML5 para mejorar la accesibilidad
- Verificar que no se utilicen elementos HTML redundantes o innecesarios que puedan afectar el rendimiento o la accesibilidad del sitio
- Verificar que todos los componentes reciban y utilicen correctamente todos los parámetros (props) que se les pasan
- Verificar que todos los parámetros de los componentes estén tipados correctamente
Control de Cambios
| Versión | Cambio realizado | Análisis | Autor | Revisor(es) | Fecha de cambio |
|---|---|---|---|---|---|
| v 1.0 | Creación de la checklist | N/A | Sebastian Flores | Sergio Garnica | 01/05/2024 |
| v 2.0 | Agregar áreas de proceso CM y PPQA | Se identificó para cada criterio de la checklist si pertenece a PPQA o a CM | Carlos Velasco | Sergio Garnica, Diego Perdomo | 14/05/2024 |
| v 3.0 | Agregar criterio de portabilidad | Agregó el criterio de portabilidad para cumplir con los requisitos no funcionales del sistema | Sergio Garnica | 21/05/2024 | |
| v 4.0 | Criterio de Inconsistencia | Agregar criterio de Inconsistencia para aclarar cuándo existen inconsistencias en un requerimient entre fases | Sergio Garnica | Alejandra Cabrera | 23/05/2024 |