Objetivo de la checklist
Proporcionar una guía estructurada y detallada para evaluar y garantizar la calidad y coherencia en el proceso de diseño
Checklist
Mapa de dependencias
- [ ] Verificar que el mapa incluye los componentes y recursos relacionados con el frontend de la aplicación.
- [ ] Asegurarse de que se representen adecuadamente los archivos de código, como componentes, plantillas y utilidades del frontend.
- [ ] Asegurarse de que se representen adecuadamente los archivos de código, como modelos, controladores, rutas y utilidades del backend.
- [ ] Verificar que se incluya una representación de los recursos de la base de datos utilizados en la aplicación, como colecciones de MongoDB u otros sistemas de almacenamiento de datos
- [ ] Asegurarse de que las dependencias entre el backend y la base de datos estén claramente indicadas en el mapa.
- [ ] Asegurar que la declaración de las relaciones entre componentes se declara al final del archivo.
- [ ] Los elementos son distribuidos en el espacio del diagrama y las conexiones son legibles.
- [ ] Confirmar que el mapa de dependencias refleje adecuadamente la arquitectura y la estructura de la aplicación de acuerdo con los requisitos y objetivos del proyecto.
Diseño de la API
- [ ] Verificar que las rutas y métodos HTTP estén definidos claramente para cada endpoint de la API.
- [ ] Asegurarse de que las rutas sean descriptivas y sigan las convenciones de nomenclatura, como el uso de sustantivos en plural.
- [ ] Comprobar que los parámetros de solicitud (en el ejemplo, el cuerpo del POST) están definidos de manera precisa y con ejemplos.
- [ ] Comprobar que las respuestas de la API estén definidas claramente, incluyendo ejemplos de respuesta.
- [ ] Asegurarse de que las respuestas estén en un formato adecuado (por ejemplo, JSON) y sigan un estándar consistente.
Modelo relacional
- [ ] Confirmar que el modelo de datos esté documentado en inglés, a menos que se acuerde lo contrario con el equipo o los stakeholders.