Por Qué Tu Proyecto Necesita un Documento de Diseño Antes de Empezar a Construir

Un documento de diseño es un plan escrito que describe qué estás construyendo, por qué lo estás construyendo y cómo funcionará. No es un manual de usuario. No es una lista de tareas. Es el pensamiento que ocurre antes de que empiece la construcción. En su esencia, un documento de diseño responde tres preguntas. ¿Qué problema estamos resolviendo? ¿Cuál es la solución propuesta? ¿Y cuáles son las concesiones y alternativas que consideramos? Todo lo demás, los detalles técnicos, los límites del alcance, las estimaciones de tiempo, se cuelga de esas tres preguntas. Los documentos de diseño reciben diferentes nombres según la industria. Los equipos de software los llaman documentos de diseño técnico o RFCs. Los desarrolladores de juegos escriben documentos de diseño de juego. Los equipos de producto escriben documentos de requisitos de producto. El formato varía, pero el propósito siempre es el mismo: sacar el plan de tu cabeza y ponerlo en un documento que otras personas, o tu yo del futuro, puedan leer y entender.

Se siente contraintuitivo. Estás emocionado por empezar a construir. La idea está clara en tu cabeza. Escribir un documento se siente como trabajo innecesario que te ralentiza. Así que lo saltas y te lanzas directo a la implementación. Dos semanas después, te das cuenta de que la arquitectura no soporta una funcionalidad que asumiste sería fácil. O un compañero de equipo construyó algo que contradice tu enfoque porque nunca escribiste cuál era el enfoque. O llegas a una decisión de diseño que no pensaste bien y ahora tienes que refactorizar. Un documento de diseño detecta estos problemas antes de que te cuesten tiempo real. Cuando escribes cómo algo debería funcionar, te ves obligado a pensar en los detalles. Descubres casos extremos. Notas dependencias. Te das cuenta de que la funcionalidad "simple" en realidad requiere cambios en tres sistemas diferentes. El tiempo que dedicas a escribir un documento de diseño siempre es menor que el tiempo que dedicarías a arreglar problemas que el documento habría detectado. Ni se acerca. Unas pocas horas de escritura pueden ahorrar semanas de retrabajo.

No necesitas una plantilla rígida, pero un buen documento de diseño generalmente cubre estas áreas. Empieza con la visión general. Uno o dos párrafos que expliquen qué cubre este documento y por qué importa. Cualquiera debería poder leer esta sección y entender el alcance. Luego, define el problema. ¿Qué está roto, falta o se necesita? Sé específico. "Los usuarios necesitan mejor búsqueda" es vago. "Los usuarios no pueden encontrar proyectos anteriores porque la vista de lista actual no soporta filtrado ni ordenamiento" es útil. Después describe la solución propuesta. Esta es la parte principal del documento. Explica qué planeas construir, cómo funcionará y cómo será la experiencia del usuario. Incluye suficiente detalle para que alguien más del equipo pueda implementarlo solo con esta descripción. Añade una sección sobre alternativas consideradas. ¿Qué otros enfoques evaluaste? ¿Por qué elegiste este? Esto muestra tu razonamiento y ayuda a los lectores futuros a entender la decisión. Finalmente, lista las preguntas abiertas y los elementos fuera del alcance. ¿Qué has decidido deliberadamente no hacer? ¿Qué aún necesita discusión? Esto previene la expansión del alcance y mantiene al documento honesto sobre lo que cubre y lo que no.

Un documento de diseño no es algo que escribes una vez y te olvidas. Los mejores documentos de diseño evolucionan con el proyecto. A medida que construyes, aprenderás cosas. Algunas suposiciones resultarán estar equivocadas. Algunas partes del plan cambiarán. Eso es completamente normal. El documento debería reflejar esos cambios. Añade notas sobre qué cambió y por qué. Actualiza las secciones que ya no coinciden con la realidad. Marca las decisiones que fueron revisadas. Esto convierte tu documento de diseño en un historial del proyecto. Seis meses después, cuando alguien pregunte "¿por qué lo construimos así?" la respuesta está en el documento. No tienes que depender de que alguien recuerde una conversación de hace meses. La clave es hacer que el documento sea fácil de actualizar. Si vive en una herramienta desconectada de tu proyecto real, nadie se molestará en actualizarlo. Si está justo al lado de tus tareas y líneas de tiempo, actualizarlo se convierte en una parte natural del flujo de trabajo. IndieDevBoard incluye una función de documentos de diseño con secciones estructuradas que viven dentro de tu proyecto, para que la especificación se mantenga cerca del trabajo que describe.

Si estás en desarrollo de juegos, puede que te preguntes cómo esto se relaciona con un documento de diseño de juego, comúnmente llamado GDD. Están relacionados pero son diferentes. Un GDD es específico para juegos. Típicamente cubre el concepto del juego, mecánicas, historia, diseño de niveles, dirección artística, audio, interfaz y más. Es la biblia del juego. Todo sobre el juego debería poder describirse a partir del GDD. Un documento de diseño en el sentido más amplio es sobre cualquier proyecto o funcionalidad. Podría describir una sola funcionalidad dentro de un juego, un diseño de API, un rediseño de sitio web o un nuevo proceso. Es más enfocado y generalmente más corto que un GDD. En la práctica, muchos equipos de juegos usan ambos. El GDD es el documento de visión de alto nivel. Los documentos de diseño individuales cubren sistemas o funcionalidades específicas dentro del juego, como el sistema de combate, el inventario o la capa de networking multijugador. El GDD dice "el juego tiene un sistema de inventario." El documento de diseño explica exactamente cómo funciona el sistema de inventario, cómo se ve el modelo de datos y cómo interactúa con otros sistemas.

No necesitas escribir un documento de diseño perfecto en tu primer intento. Empieza con lo básico. Escribe qué estás construyendo y por qué. Describe la solución con suficiente detalle para que sea útil. Añade preguntas abiertas para cualquier cosa de la que no estés seguro. A medida que te sientas más cómodo, naturalmente empezarás a añadir más estructura. Desarrollarás un sentido de cuánto detalle es suficiente. Aprenderás qué secciones importan más para tu tipo de proyecto. Lo importante es empezar. Un documento de diseño aproximado que toma una hora en escribir es infinitamente más útil que uno perfecto que nunca llegas a escribir. Tu yo del futuro y tus compañeros de equipo te lo agradecerán.