Preparación de la revisión · Guía 02
Cómo prepararse para una revisión de arquitectura o de código
La respuesta corta
Traiga una decisión, un límite claro del sistema y el conjunto de evidencia más pequeño que pueda responder la pregunta. Una revisión útil empieza por lo que el sistema debe hacer y por dónde tiene usted incertidumbre, y luego examina la arquitectura o el código relevantes. Una invitación a un repositorio por sí sola no es un brief de revisión.
Convierta la inquietud en una pregunta de revisión
“¿Es buena nuestra arquitectura?” deja al revisor adivinando sus prioridades. Haga una pregunta que pueda cambiar una decisión: ¿puede esta integración cumplir con el próximo requisito de un cliente?, ¿en qué estado queda el pedido cuando falla un pago?, o ¿qué debe resolverse antes de una migración? Indique la versión del sistema y la fecha límite de la decisión.
Enumere lo que la revisión no cubrirá. Una conversación enfocada no puede establecer que todos los componentes sean seguros, que todas las fallas se hayan probado ni que todo el producto esté listo para lanzarse. Una garantía más amplia requiere un alcance y una evidencia acordados por separado.
Reúna un paquete de evidencia pequeño
- Un mapa del sistema: usuarios, servicios, almacenes de datos e integraciones externas relevantes para la pregunta.
- Un flujo representativo: el camino normal, el camino de falla y quién se encarga de la recuperación.
- Restricciones: carga de trabajo esperada, objetivos de respuesta, presupuesto, sensibilidad de los datos y capacidad del equipo; identifique las estimaciones como estimaciones.
- Evidencia seleccionada: rutas de código, pruebas, errores depurados o diagramas relevantes, con fechas y versiones.
- Historial de decisiones: alternativas consideradas, supuestos y la razón del enfoque actual.
arc42 separa un sistema de sus usuarios externos y de los sistemas vecinos, y luego describe las interfaces entre ellos. Es una estructura útil para un diagrama de revisión, aunque no use la plantilla de documentación completa. arc42: contexto y alcance.
Para una revisión de código, seleccione el cambio o la ruta que respalda la pregunta. La guía de revisión de Google va más allá del estilo y abarca el diseño, el comportamiento previsto, la complejidad innecesaria y las pruebas. Incluya suficiente contexto alrededor para que esos aspectos puedan evaluarse. Google: qué buscar en una revisión de código.
Una incógnita también es evidencia útil. Si nadie conoce la carga máxima actual ni sabe si un respaldo se puede restaurar, dígalo. Un revisor puede distinguir una medición que falta de un defecto demostrado del sistema; llenar el vacío en silencio con una estimación segura lo hace más difícil.
Acuerde el acceso y la lectura previa antes de compartir
Inicie una solicitud con una descripción no confidencial. No pegue contraseñas, tokens, datos de clientes ni contenido de repositorios privados en un formulario de contacto público. Si el proyecto necesita material privado, acuerde primero el alcance, el método de acceso y el uso permitido. Prefiera el conjunto de evidencia relevante más pequeño y depurado, y acceso de solo lectura cuando corresponda.
Pregunte qué se puede leer de forma realista dentro del proyecto. Enviar un repositorio grande justo antes de una sesión no crea un acuerdo para una auditoría completa. Confirme explícitamente cualquier lectura previa, configuración de acceso y entregable escrito; no suponga que están incluidos porque se agendó una reunión.
Haga que los hallazgos le sirvan al equipo
Pida al revisor que separe los hechos observados, las explicaciones probables y las preguntas sin respuesta. Para cada problema importante, el equipo necesita entender el comportamiento afectado, la evidencia que lo respalda y la siguiente acción. La prioridad debe reflejar la consecuencia para el negocio y la confianza en el hallazgo, no qué tan de moda está una tecnología de reemplazo.
- Confirme a qué versión del sistema y a qué evidencia se refiere el hallazgo.
- Designe a la persona que lo investigará, lo aceptará o lo resolverá.
- Defina cómo comprobará el equipo que un cambio resolvió el problema correspondiente.
- Mantenga visibles en la entrega las áreas no revisadas y la incertidumbre restante.
La Revisión de arquitectura y código de Robles Consulting es una sesión enfocada de 120 minutos. Una evaluación más amplia, con evidencia acordada y un entregable escrito, corresponde a la Auditoría de arquitectura. Use los detalles de la oferta para elegir el alcance adecuado antes de solicitar disponibilidad.
Siguiente paso
Encuentre el alcance adecuado.
Describa primero la decisión y el límite del sistema. La oferta de revisión explica la preparación y los límites; las evaluaciones más grandes se definen por separado.