Saltar al contenido
Ejemplos de entregables

Los documentos que recibes, no solo el software.

La mitad de lo que produce un encargo se escribe en lugar de compilarse. Estos son los formatos: qué es cada documento, cuándo llega, el riesgo que elimina y las decisiones que deja por escrito. Son ejemplos y no trabajo de clientes, y a diferencia de un caso de estudio, puedes contrastarlos con el encargo que estás valorando.

01: Por qué formatos y no casos de estudio

Un ejemplo verificable vale más que una historia que no puedes comprobar.

Un caso de estudio es una afirmación sobre el pasado, escrita por la empresa a la que pagaron por el trabajo, con las partes difíciles resumidas. Incluso uno veraz es difícil de verificar para quien compra y fácil de imitar para la competencia.

Un ejemplo de entregable hace otra promesa: este es el documento que recibirás, con esta forma, en este punto del encargo. Se puede comprobar en cuanto empieza el trabajo y es mucho más difícil de falsificar, porque escribir un buen documento de alcance exige saber cómo se tuercen los alcances.

Por eso publicamos esto: para quien decide si encargar el desarrollo de un producto, es el más útil de los dos. Puedes leer el formato con el que trabajarás antes de firmar nada y exigir después que el encargo lo cumpla.

02: El conjunto

Ocho documentos que produce un encargo.

No aparecen los ocho en todos los encargos. El alcance, la memoria de arquitectura y el paquete de entrega siempre están; el resto sigue la forma del trabajo.

Cada uno es un formato real que se usa aquí, mostrado con un proyecto ilustrativo y no con el sistema de nadie. Nada de lo que sigue es un documento de cliente, y los tres que siempre aparecen se reproducen completos más abajo en la página.

  • / 01

    Brief del producto

    El formulario breve del que parte una consulta seria: qué existe, quién lo opera, qué está bloqueado y qué se consideraría terminado. Una página basta.

    Llega
    Antes de la primera llamada, escrito por ti
    Riesgo que elimina
    Una primera llamada dedicada a reunir contexto en lugar de tomar decisiones, y un alcance construido sobre un problema mal entendido.
    Qué deja por escrito
    El problema con las palabras de quien compra, antes de que un ingeniero lo reformule.
  • / 02

    Notas de descubrimiento

    Lo que establecieron las sesiones: las restricciones reales, las que resultaron negociables, lo que ya funciona y los riesgos que conviene tener en cuenta primero en el diseño.

    Llega
    Después de las sesiones de trabajo, antes del alcance
    Riesgo que elimina
    Que las dos partes salgan de una llamada con recuerdos distintos de lo acordado.
    Qué deja por escrito
    Las restricciones, y cuáles se daban por supuestas en lugar de confirmadas.
  • / 03

    Documento de alcance

    El problema tal como se entiende, lo que se construirá y lo que no, las etapas, los supuestos de los que depende y los criterios de aceptación de cada etapa.

    Llega
    Después del descubrimiento, antes de cualquier precio
    Riesgo que elimina
    Acordar una cifra antes de que nadie haya acordado en qué consiste el trabajo, que es donde suelen fracasar los encargos a precio fijo.
    Qué deja por escrito
    El límite del trabajo y cada supuesto que lo cambiaría.
  • / 04

    Memoria de arquitectura

    La forma del sistema y por qué tiene esa forma: la decisión, las alternativas consideradas, la contrapartida aceptada y las condiciones que harían que valiera la pena revisarla.

    Llega
    Al principio del desarrollo, actualizada a medida que cambia
    Riesgo que elimina
    Heredar un sistema que nadie sabe explicar, donde cada cambio futuro empieza siendo arqueología.
    Qué deja por escrito
    Las decisiones y las alternativas descartadas, que es la parte que suele perderse.
  • / 05

    Plan de evaluación de IA

    Lo que el sistema puede hacer, lo que nunca debe hacer, los casos con los que se mide y el procedimiento para comprobar un cambio de prompt o de modelo antes de publicarlo.

    Llega
    Antes de que cualquier superficie de IA llegue a usuarios reales
    Riesgo que elimina
    Publicar un cambio en una superficie de IA porque en una demostración se veía mejor.
    Qué deja por escrito
    El comportamiento acordado como aceptable y cómo se comprueba.
  • / 06

    Lista de verificación de accesos y seguridad

    Qué sistemas hacen falta, con qué privilegio, durante cuánto tiempo, dónde viven los secretos y qué se devuelve al final. Se rellena en cada encargo.

    Llega
    Antes de emitir la primera credencial
    Riesgo que elimina
    Un acceso amplio y permanente concedido al arrancar porque era más fácil que acotarlo.
    Qué deja por escrito
    Quién recibió qué y cuándo se devolvió.
  • / 07

    Lista de verificación de despliegue y reversión

    El camino desde un commit hasta un servicio en marcha, qué se verifica en cada punto de control y los pasos exactos para deshacer la versión si se comporta mal.

    Llega
    Antes de la primera versión en producción
    Riesgo que elimina
    Descubrir durante un incidente que el camino de reversión era solo teórico.
    Qué deja por escrito
    El procedimiento de publicación y las condiciones que obligan a revertirla.
  • / 08

    Runbook y paquete de entrega

    Cómo operar el sistema: tareas rutinarias, modos de fallo y sus respuestas, dónde están los registros, qué es manual a propósito y las limitaciones conocidas.

    Llega
    Al final, y actualizado durante todo el desarrollo
    Riesgo que elimina
    Un sistema terminado que solo funciona mientras las personas que lo construyeron están disponibles.
    Qué deja por escrito
    El conocimiento operativo, para que sobreviva al final del encargo.

EjemplosSon formatos, rellenados con un proyecto ilustrativo. Ninguno es un documento de cliente.

03: Un ejemplo de cada uno

Tres de ellos, completos.

Los tres que aparecen en todos los encargos. Abre uno y lee el formato en sí: los títulos, los campos y los lugares donde un documento real lleva un dato que un ejemplo no puede llevar.

Los tres están escritos sobre un mismo proyecto ilustrativo: un servicio interno que concilia dos sistemas de registro. Es una forma de problema elegida para que los formatos se lean bien, no un encargo, ni un cliente, ni un sistema que alguien opere. Cada campo que un documento real rellena con un nombre, una fecha o una cifra se deja aquí visiblemente vacío.

Documento de alcance

EjemploDespués del descubrimiento, antes de cualquier precioLeer el ejemplo

Cómo es un documento de alcance cuando cumple su función: el límite trazado por escrito, etapas ligadas a criterios que alguien ajeno al proyecto puede comprobar y supuestos con nombre, para que el cambio de uno de ellos se vea en lugar de quedar absorbido.

Asunto
Ilustrativo, no un encargo
Llega
Después del descubrimiento, antes del precio
Se lee con
Notas de descubrimiento
Campos vacíos
Cada nombre, fecha y cifra
Estado
Ejemplo
01

Problema tal como se entiende

Dos sistemas guardan registros que deberían coincidir. Se comparan a mano, con una cadencia que depende de que alguien se acuerde, y una discrepancia suele notarla la persona a la que perjudica en lugar del proceso que la produjo. El trabajo lo sustituye por un servicio que compara ambos lados con un calendario fijo, cierra las diferencias para las que tiene una regla e informa de las demás.

Esta sección se devuelve a quien compra con sus propias palabras, y el alcance no se acuerda hasta que reconoce en ella su problema. Un alcance construido sobre un enunciado que el cliente habría formulado de otra manera ya es erróneo, y la mayoría de los desacuerdos que surgen después se remontan a este párrafo.

02

Dentro del alcance

  • Ejecución de conciliación: Una comparación programada de ambos registros, que produce un conjunto que coincide, un conjunto de diferencias que una regla puede cerrar y un conjunto que necesita a una persona.
  • Reglas de resolución: Las reglas que cierran una diferencia sin intervención humana, escritas y versionadas con el servicio en lugar de vivir solo en el código que las aplica.
  • Cola de excepciones: El lugar adonde va a revisarse una diferencia que ninguna regla cierra, con los dos registros de origen adjuntos para poder actuar sin una segunda investigación.
  • Superficie operativa: Lo que necesitan los operadores para ejecutar, pausar e inspeccionar una conciliación sin pedírselo a un ingeniero.
  • Entrega: El runbook, la devolución de los accesos y una sesión de trabajo con las personas que operarán después el servicio.
03

Explícitamente fuera del alcance

  • Modificar cualquiera de los dos sistemas de registro. Ambos se leen tal como están, y el servicio no opina sobre cuál tiene razón más allá de las reglas acordadas aquí.
  • La corrección automática de una diferencia que ninguna regla cubre. El servicio la comunica. Una persona decide.
  • La carga retroactiva del histórico más allá de la ventana indicada en los supuestos de abajo.
  • Cualquier cosa que se encuentre después de acordado este documento, salvo que llegue por el cauce de cambios con el que termina.

La lista de lo que queda fuera es la mitad de un documento de alcance que hace el trabajo. Lo que está dentro es lo que ambas partes ya acuerdan. Lo que está fuera es lo que cada una supuso de manera distinta sin haberse dado cuenta todavía.

04

Etapas, y con qué se acepta cada una

  • Primera etapa, leer ambos lados: Se acepta cuando una ejecución lee ambos registros de punta a punta desde un arranque en frío y produce un conjunto de diferencias reproducible: las mismas entradas dan la misma salida, y la ejecución puede repetirse sin efectos secundarios.
  • Segunda etapa, cerrar lo que tiene regla: Se acepta cuando cada regla del conjunto acordado se ejercita con una prueba que nombra el caso que cubre, y cuando cambiar una regla es un cambio revisado del conjunto de reglas y no del servicio.
  • Tercera etapa, pasar el resto a una persona: Se acepta cuando una diferencia sin regla correspondiente llega a la cola de excepciones con los dos registros de origen adjuntos, y alguien que no participó en el desarrollo puede resolverla.
  • Cuarta etapa, operarlo: Se acepta cuando los operadores ejecutan por sí mismos un ciclo completo, a partir del runbook, mientras el equipo de desarrollo observa sin conducir.

Un criterio de aceptación es una frase a la que se puede exigir cumplimiento. Si una línea no puede comprobarla alguien ajeno al proyecto, es una esperanza y no un criterio, y no tiene sitio en esta sección.

05

Supuestos de los que depende este alcance

Cada línea siguiente se da por cierta para ordenar y presupuestar el trabajo. Si una resulta falsa, el alcance cambia, y el cambio se ve en lugar de quedar absorbido.

  • Ambos registros son legibles sin cambiar los sistemas que los guardan, y puede concederse acceso de lectura durante todo el encargo.
  • Las reglas que cierran una diferencia se pueden escribir. Cuando una regla resulta ser un juicio que alguien emite caso por caso, sigue siendo un juicio y la diferencia va a la cola.
  • Una persona del lado del cliente puede decidir qué cuenta como coincidencia. Un trabajo de conciliación se atasca antes por una definición sin responder que por una línea de código sin escribir.
  • Los volúmenes y los tiempos se mantienen dentro del rango registrado al arrancar, que es el único lugar de este documento donde aparece una cifra.

Cifras que lleva la sección de supuestos

  • [ registros por ejecución ]
  • [ cadencia de ejecución ]
  • [ ventana de conservación ]
  • [ retraso aceptable antes de que una ejecución se considere tardía ]
06

Qué cambia este alcance

  • Un supuesto falso: Se nombra el supuesto contradicho, y el cambio se presupuesta según la diferencia en lugar de reabrir todo el documento.
  • Un requisito nuevo: Llega como una adenda con su propia etapa y su propio criterio de aceptación, o espera.
  • Una etapa que no supera la aceptación dos veces: El segundo fallo dice algo del criterio y no solo del trabajo, así que se revisan ambos antes del tercer intento.
  • Nada más: Un alcance que deriva sin una adenda escrita no es un alcance, y al final nadie puede decir qué se acordó.
07

Acuerdo

El alcance lo acuerdan por escrito ambas partes, y la versión acordada es la versión a la que se ciñe el encargo.

Campos que lleva un alcance firmado

  • [ firmante del cliente, nombre y cargo ]
  • [ firmante de TDACorp ]
  • [ fecha de acuerdo ]
  • [ versión del alcance ]
  • [ precio y calendario de pagos ]
  • [ fechas de las etapas ]

Memoria de arquitectura

EjemploAl principio del desarrollo, actualizada a medida que cambiaLeer el ejemplo

Una decisión por memoria. Esta deja constancia de por qué el servicio mantiene un registro de diferencias solo de adición en lugar de una tabla que sobrescribe, qué cuesta eso y qué haría que valiera la pena cambiarlo.

Asunto
Ilustrativo, no un encargo
Decisión
Registro de diferencias en lugar de estado mutable
Llega
Al principio del desarrollo, revisada a medida que cambia
Campos vacíos
Autor, fecha y revisión
Estado
Ejemplo
01

Decisión

Cada ejecución añade sus diferencias a un registro en lugar de actualizar una tabla de discrepancias abiertas en este momento. Una diferencia es una fila con una marca de primera vez, una marca de última vez y una resolución, y nunca se edita en el sitio: cerrarla añade una resolución, y volver a verla añade una observación.

El estado actual, que es lo que un operador mira de verdad, se deriva del registro en lugar de almacenarse a su lado.

02

Alternativas consideradas, y por qué no

  • Una tabla mutable de diferencias abiertas: La forma obvia y la más barata de escribir. No elegida, porque solo responde a qué discrepa ahora mismo. La pregunta que este servicio existe para responder es cuándo empezaron a discrepar los dos lados y qué lo cerró, y una tabla sobrescrita en cada ejecución no puede responderla en absoluto.
  • Un registro sin vista derivada: Conserva todo el histórico y cuesta casi nada de escribir, pero traslada la reconstrucción a cada lector, incluido el operador que resuelve una excepción con prisa. No elegido, porque aquí la superficie operativa es un entregable y no un efecto secundario.
  • Conciliación dentro de uno de los dos sistemas: Elimina una pieza móvil y una integración. No elegida, porque convierte a un sistema en árbitro de una discrepancia de la que es parte, y porque el alcance excluye cambiar cualquiera de los dos.

Las alternativas descartadas son la parte de una memoria de arquitectura que suele perderse, y la más cara de reconstruir después. Una memoria que solo registra la decisión deja al siguiente ingeniero redescubrir las tres formas que no funcionan.

03

Contrapartida aceptada

  • El registro crece sin límite hasta que se acuerde una regla de conservación, y esa regla es una pregunta abierta más abajo y no una decisión tomada aquí.
  • Cada lectura del estado actual cuesta una derivación. La vista derivada es una caché, y una caché es una segunda cosa que puede estar equivocada.
  • Corregir un error significa añadir una corrección, lo cual es más lento de escribir y más difícil de explicar a quien espera una fila que pueda editar. El runbook lleva esa explicación precisamente por este motivo.
04

Qué haría que valiera la pena revisarla

  • Una regla de conservación que descarte el histórico más rápido de lo que el registro compensa. Si una diferencia cerrada puede olvidarse tras una ventana corta, la tabla mutable pasa a ser la opción honesta.
  • Un requisito de editar una resolución en lugar de añadir una corrección, que venga de un auditor y no de la comodidad.
  • Un coste de derivación que deje de caber en la cadencia de ejecución que acordó el alcance. Eso es una medición, y solo tiene sitio en esta sección cuando alguien la ha tomado.
05

Preguntas abiertas

  • Conservación: Cuánto tiempo conviene guardar una diferencia cerrada no está decidido, y es una cuestión de negocio y no de ingeniería.
  • Reconstruir o mantener: Si la vista derivada se reconstruye en cada ejecución o se mantiene de forma incremental. Ambas son viables, y la elección depende de los volúmenes del documento de alcance, que un ejemplo no rellena.
  • Quién es dueño de un cambio de regla: Las reglas se versionan con el servicio, lo que convierte cambiar una en un evento de ingeniería, salvo que alguien del lado del cliente reciba la autoridad para cambiarla sin pasar por él.

Una pregunta abierta se queda en la memoria, con un nombre al lado, hasta que se responde. Borrarla porque incomoda es como un sistema adquiere una decisión que nadie recuerda haber tomado.

06

Revisión

Una memoria de arquitectura se enmienda, nunca se reescribe. Una decisión sustituida conserva su sección y gana una nota que dice qué la reemplazó y por qué, porque el razonamiento que resultó equivocado suele ser lo más útil del archivo.

Campos que lleva una memoria real

  • [ autor ]
  • [ fecha de redacción ]
  • [ revisión ]
  • [ sustituida por ]
  • [ revisada con ]

Runbook y paquete de entrega

EjemploAl final, y actualizado durante todo el desarrolloLeer el ejemplo

Un runbook se escribe para la persona de guardia a una hora incómoda que no ha leído nada más. Dice qué hacer, en orden, y dice qué no hacer. Este cubre la operación del servicio de conciliación.

Asunto
Ilustrativo, no un encargo
Llega
Al final, revisado durante el desarrollo
Escrito para
El operador de guardia
Campos vacíos
Cada dirección, nombre y umbral
Estado
Ejemplo
01

Operaciones rutinarias

  • Iniciar una ejecución: Las ejecuciones están programadas, e iniciar una a mano es una acción admitida. Se puede repetir sin riesgo: una ejecución es idempotente por diseño, así que una segunda ejecución sobre la misma ventana produce el mismo conjunto de diferencias.
  • Pausar el calendario: Pausar detiene las nuevas ejecuciones y deja terminar la que está en curso. Es el primer movimiento correcto siempre que uno de los sistemas de origen esté en mantenimiento.
  • Cerrar una excepción: Ábrela, lee los dos registros de origen adjuntos y luego aplica una regla existente o registra la resolución como caso puntual con un motivo. Un caso puntual que se repite es una regla que falta, y se plantea como tal.
  • Añadir una regla de resolución: Las reglas se versionan con el servicio, y añadir una es un cambio revisado. La revisión existe porque una regla equivocada cierra diferencias en silencio, que es peor que no cerrarlas.
02

Modos de fallo, y la primera respuesta a cada uno

  • Un sistema de origen no responde: La ejecución falla entera en lugar de parcialmente, no se escribe nada y el calendario sigue intentándolo. No hace falta actuar salvo que la caída supere el retraso aceptable registrado más abajo. No fuerces una ejecución parcial: un conjunto de diferencias construido desde un solo lado no es un conjunto de diferencias.
  • Una ejecución termina con un número inverosímil de diferencias: Supón que un origen cambió de forma antes de suponer que los dos lados divergieron. Pausa primero el calendario, porque una ejecución contra un origen mal leído llena la cola de excepciones de ruido que luego hay que limpiar a mano.
  • La vista derivada discrepa del registro: El registro es la fuente de verdad. Reconstruye la vista a partir de él. La reconstrucción es segura en cualquier momento y no exige pausar el calendario.
  • Una excepción que nadie disponible puede resolver: Déjala abierta. Una diferencia sin resolver es una incógnita conocida, y conservarlas es justo para lo que sirve este servicio. Una resolución adivinada es un registro erróneo que luego parece correcto para siempre.
03

Dónde mirar

Un runbook que dice que se revisen los logs todavía no está escrito. Las direcciones de abajo pertenecen al documento real, que se rellena en la entrega y se mantiene al día cuando cambian.

Direcciones que rellena un runbook real

  • [ destino de los logs y conservación ]
  • [ panel del historial de ejecuciones ]
  • [ cola de excepciones ]
  • [ configuración del calendario ]
  • [ turnos de guardia ]
  • [ contacto de escalado ]
04

Manual a propósito

Algunas cosas no se automatizan a propósito. Un runbook que no dice cuáles deja al siguiente ingeniero automatizarlas y averiguar el motivo después.

  • Cerrar una diferencia que ninguna regla cubre. Decide una persona, porque la alternativa es un servicio que inventa acuerdo.
  • Añadir una regla. Con revisión y no de autoservicio, por el motivo dado en las operaciones rutinarias.
  • Restaurar desde una copia de seguridad. Ensayado y documentado, pero iniciado por una persona, porque una restauración automática disparada por una falsa alarma es un incidente en sí misma.
05

Limitaciones conocidas

  • El servicio comunica la discrepancia. No decide qué lado tiene razón, salvo donde una regla lo dice.
  • El histórico crece hasta que se acuerde una regla de conservación. La memoria de arquitectura lo recoge como pregunta abierta, y se repite aquí porque el operador es quien lo nota primero.
  • Un cambio de regla se aplica a las ejecuciones posteriores y no a las diferencias ya cerradas. Reabrir una diferencia cerrada es una acción deliberada con su propio procedimiento, nunca un efecto secundario de editar una regla.

Una sección de limitaciones vacía significa que no se escribió. Todo sistema tiene un comportamiento que sorprenderá a alguien, y nombrarlo aquí sale más barato que descubrirlo durante un incidente.

06

Accesos devueltos

La entrega no está completa mientras el equipo de desarrollo pueda seguir llegando al sistema. Cada credencial emitida durante el encargo se revoca o se rota, y la devolución se registra en la lista de verificación de accesos que la emitió.

El registro de devolución que lleva un paquete real

  • [ credencial ]
  • [ sistema y privilegio ]
  • [ fecha de emisión ]
  • [ fecha de revocación ]
  • [ confirmado por ]

EjemplosNada de lo anterior está tomado del encargo de nadie. Los campos vacíos son intencionados: un ejemplo puede mostrar el formato, y el formato es lo único que puede mostrar con honestidad.

04: Lo que no son

Los límites de un ejemplo.

Se indica para que la página no pueda leerse como más de lo que es.

  • No son documentos de clientes. Son formatos, escritos para esta página y no tomados del encargo de nadie.
  • No son trabajo real expurgado. Expurgar un documento de un cliente y publicarlo sería una infracción disfrazada de transparencia.
  • No son un paquete de plantillas a la venta, ni una descarga. Se muestran para que la forma del trabajo sea legible antes de comprometerte.
  • No son fijos. Un formato que no encaja con el encargo se cambia, y el documento de alcance indica cuáles se aplican.
05: Siguiente paso

Conoce el proceso del que salen.

Los entregables se entienden mejor junto a la secuencia que los produce: descubrimiento, alcance, hitos, aceptación y entrega.