Ir al contenido
wannacode

Revisar una especificación

En resumen: Una especificación se lee dos veces: una entera, y después línea por línea con una lista de comprobación. Los hallazgos están en el texto (palabras sin medida, ambigüedades, contradicciones) y fuera de él (casos de los que el texto no dice nada). Cada uno se registra con su lugar, tipo, gravedad y una sugerencia. Al final cada uno recibe una decisión: corregir, pregunta para el dueño o no es un problema.

Problema

Dos semanas antes del lanzamiento

Los códigos promocionales salen en dos semanas. La analista ha escrito la especificación y os la manda a ti y a otros dos para revisarla. El plazo es mañana a las 14:00, la discusión es el viernes.

Eres un revisor. Tienes la lista de comprobación de la lección anterior, la especificación y una hora. El objetivo está claro: encontrar tantos problemas como puedas ahora, mientras cada uno cuesta una palabra.

La idea

Cómo leerla

La especificación se lee dos veces.

Primero entera, sin detenerte. La pregunta es «¿qué falta?». Una regla de la que ninguna frase habla es invisible cuando lees línea por línea.

Después línea por línea, con la lista de comprobación. En cada frase: quién; si hay una medida; qué pasa en el límite y en el caso negativo; si dice qué y no cómo; si contradice algo.

Anota las cosas enseguida, con el lugar. «P-3, “una vez”: ¿por cliente o por pedido?» En una hora no recordarás en qué línea era.

Pruébalo

La especificación: las reglas

La primera parte de la especificación. Marca los problemas y elige el tipo de cada uno.

Pulsa las palabras que son un problema; otra vez para quitar la marca. Con las flechas se pasa de palabra en palabra.

Pruébalo

La especificación: los descuentos

La segunda parte, y un requisito de la especificación de fidelidad. Marca los problemas y elige el tipo de cada uno.

Pulsa las palabras que son un problema; otra vez para quitar la marca. Con las flechas se pasa de palabra en palabra.

La idea

Lo que no está

La segunda lectura encuentra las palabras. La primera encuentra los huecos, y a menudo son más graves. En la especificación del código promocional:

  • El segundo intento. P-3 dice que el código se usa una vez, pero ¿qué ve el cliente cuando lo intenta de nuevo? La regla es «El código ya se ha usado». No está en el texto.
  • El pedido cancelado. El pedido con el código se cancela antes de enviarse. ¿Se ha usado el código? La regla dice «en un pedido pagado». Si sigue usado después de una cancelación, nadie lo ha dicho. Es una pregunta para el dueño.
  • La devolución. El cliente devuelve un producto comprado con descuento. ¿Se le reembolsa con el descuento o sin él? Otra pregunta.
  • Quién crea los códigos. Quién los crea y quién fija el plazo. ¿Quiere contabilidad saber cuánto descuento se ha dado?

Ninguno de estos hallazgos se puede marcar como una palabra. Se registran aparte, con el lugar «falta».

La idea

El registro de la revisión

Un hallazgo que no se anota no existe. El registro de la revisión es una tabla a partir de la cual el autor corrige sin preguntarte.

# Lugar Hallazgo Tipo Gravedad Sugerencia
1 P-6, F-2 «se suman» frente a «se aplica el mayor» contradice alta P-6: «se aplica el mayor»
2 P-1 10 % ¿de qué?: ¿los productos, o también el envío? ambiguo alta pregunta para el dueño
3 P-3 «una vez»: ¿por cliente o por pedido? ambiguo alta «en un pedido pagado»
4 falta qué ve el cliente en un segundo intento incompleto media «El código ya se ha usado»
5 falta si el código se considera usado tras un pedido cancelado incompleto media pregunta para el dueño
6 P-5 «en una ventana emergente» solución en lugar de necesidad baja quitarlo
  • El lugar dice dónde. El número del requisito es mejor que «cerca del principio».
  • El tipo dice qué falla, con las palabras de la lección «El buen requisito».
  • La gravedad dice cuánto duele si el defecto llega al cliente. «Los descuentos se suman» duele con dinero en cada pedido. «Ventana emergente» apenas duele.
  • La sugerencia no es una orden. Muestra que entendiste el problema y da al autor un punto de partida.

El registro no lleva el nombre del autor. Se revisa el documento.

Más precisamente, para curiosos

La gravedad en una revisión es la misma idea que la gravedad de un defecto, que encontrarás en el módulo sobre el proceso: lo serias que son las consecuencias. La prioridad (cuándo se corregirá) es una decisión aparte. Los equipos suelen usar unos pocos niveles: bloqueante, alta, media, baja.

Las inspecciones recogen también métricas del registro: cuántos hallazgos por página, de qué tipo, cuánto tiempo se empleó. Así el equipo ve, por ejemplo, que «falta el caso negativo» es el hallazgo más frecuente, y añade una pregunta sobre ello a la lista de comprobación.

Pruébalo

El buen registro

1. ¿Qué registro de un hallazgo es útil?
2. ¿Qué gravedad tiene el hallazgo sobre P-6 («los descuentos se suman»)?
3. ¿Qué gravedad tiene el hallazgo «en una ventana emergente»?
4. ¿Por qué el registro tiene una sugerencia, y no solo el problema?

La idea

La discusión y la decisión

El viernes se juntan los hallazgos de los tres revisores. El moderador los repasa uno a uno. Cada uno recibe una decisión:

  • corregir: el problema está claro, la regla está clara, el autor lo corrige;
  • pregunta para el dueño: la regla no existe, y nadie en la sala puede inventarla;
  • no es un defecto: la discusión muestra que el texto está bien; se registra el motivo para que no se vuelva a plantear.

Al final el documento recibe también una decisión: aceptado, aceptado tras las correcciones o necesita una revisión nueva. Con una pregunta abierta sobre el precio, no se puede empezar a trabajar en la historia. Así que la especificación del código promocional vuelve atrás hasta que el dueño diga sobre qué se calcula el diez por ciento.

Ejercicio

Qué pasa con el hallazgo

1. La decisión. Para cada hallazgo de la discusión, elige qué pasa con él.

1. El hallazgo: «Descuento del 10 %: ¿sobre los precios de los productos o sobre todo el importe con el envío?» ¿Qué pasa con él?
2. El hallazgo: «P-6 y F-2 se contradicen.» La regla de la tienda está clara: se aplica el mayor. ¿Qué pasa?
3. Un revisor escribe: «Sugiero que el código se introduzca en mayúsculas.» La discusión muestra que nadie lo pidió. ¿Qué pasa?
4. Después de la discusión hay dos hallazgos de gravedad alta y una pregunta abierta. ¿Cuál es la decisión sobre el documento?

Test

Ponte a prueba

1. ¿Por qué la especificación se lee dos veces?
2. ¿Qué no se puede marcar como una palabra del texto?
3. ¿Qué debe tener cada registro de un hallazgo?
4. ¿Quién decide qué pasa con una pregunta abierta sobre una regla?

Creado por Ivo Gergov como parte de la campaña de Evo Tech por una educación accesible en programación ·