Orion Protocol

¿Qué son los design docs?

Son documentos que se usan durante el diseño y desarrollo de software. Lo importante de estos documentos es que permiten comunicar al equipo y solicitar sugerencias sobre la nueva característica que se desarrollará y las implicaciones que tendrá dentro del desarrollo. Sirven como una guía para el equipo de desarrollo, proporcionando una referencia sobre cómo el software debería funcionar y cómo debe construirse.

Entre las partes que los componen se encuentran:

• Especificaciones
• Diagramas
• Prototipos UX/UI
• Infraestructura
• CI/CD
• Casos de uso
• Decisiones y patrones

Estos documentos suelen ir más allá de la arquitectura del software, ya que nos permiten comunicar procesos de implementación y casos de uso. Todas estas nuevas características nos ayudan a entender por qué se está desarrollando algo dentro del software (ya sea módulos, peticiones, etc.). Su principal meta es expresar lo que se piensa hacer, por qué se va a hacer y cómo se planea llevar a cabo.

Cuando escribir un Design Document

Es útil en los siguientes casos:

• Proyectos grandes: cuando el proyecto tiene múltiples componentes o equipos involucrados.
• Sistemas complejos: cuando se tiene un sistema lo suficientemente complejo como para requerir una planificación detallada.
• Innovaciones técnicas: cuando se va a introducir una nueva tecnología, arquitectura o enfoque.

Por ello, es una parte clave de la ingeniería de software, ya que proporciona una planificación clara y concisa antes de cualquier implementación. Esto nos ayuda a reducir errores y a asegurar que todos los participantes del proyecto tengan la misma comprensión del software y sus características.