Capítulo 4. Narrativa
Este trabajo se ha traducido utilizando IA. Agradecemos tus opiniones y comentarios: translation-feedback@oreilly.com
Después del alimento, el cobijo y la compañía, las historias son lo que más necesitamos en el mundo.
Philip Pullman
Puede que el término narrativa te recuerde a una clase de literatura inglesa, pero las historias sirven para mucho más, como la vinculación social, la resolución de problemas y el entretenimiento, entre otras cosas. Como humanos, prosperamos con las historias.
Los otros capítulos de esta parte tratan más sobre qué mostrar a tu público para comunicarte con éxito; éste trata más sobre el cómo. Este capítulo te ayudará a contar a tu público una historia para transmitir tu mensaje.
Lo primero es la visión de conjunto
Cuando miras la portada de una caja de LEGO no ves una foto de cada ladrillo individual que hay dentro. En su lugar, ves la imagen de un emocionante modelo totalmente montado... colocado en una bahía pirata realista con acantilados y tiburones.
Gregor Hohpe, El ascensor de los arquitectos de software
Diagramas no existen de forma aislada; forman parte de una narración, y el esquema general es lo primero que ayuda a ordenar esa narración. La mayoría de los diagramas no son el principio de la historia, y muchos están muy metidos en los detalles del diseño.
Aunque a tu público le interesen los detalles, no es eso lo que debes mostrarle primero. Necesitan el contexto de y estar comprometidos y enganchados a tu narración. Los detalles finos son aburridos y confusos cuando no se conoce el panorama general. Los niveles de abstracción comentados en "Mezcla de niveles de abstracción" deben ordenarse para que tengan sentido. Cuando has estado profundizando en los detalles de un proyecto, es fácil olvidar que primero debes dar a tu audiencia el contexto y explicar el gran por qué.
Imagina que creas una presentación o un documento sobre un cliente que ve medios en un sistema online. ¿Empezarías por la Figura 4-1 o por la 4-2?
La Figura 4-1 muestra el proceso detallado de visualización de los medios. Ahí es donde quieres llegar finalmente, pero no es donde debe empezar el documento o la presentación. Antes de pasar a un diagrama de flujo de datos de nivel 2, tienes que dar contexto y mostrar el diagrama de flujo de datos de nivel 1, como la Figura 4-2.1
Empezar por el nivel 1 es un paso en la dirección correcta, pero sigue sin proporcionar contexto. Un diagrama de arquitectura o contexto de alto nivel de , como el de la Figura 4-3, es por donde hay que empezar. También deberías incluir otros materiales de apoyo, como el contexto empresarial y los beneficios (o al menos un resumen y enlaces a las versiones completas en el documento o apéndice de la presentación).
Consejo
Puede que no necesites dedicar mucho tiempo al contexto y a la construcción del tema o diagrama principal que debes tratar. La cantidad de tiempo y detalle dependerá de tu audiencia y de lo que ya sepan.
A continuación, puedes pasar en la narración a un diagrama como un diagrama contenedor C4, si es necesario, para explicar a la audiencia el siguiente enlace conceptual, antes de pasar a los diagramas de flujo de datos. Les estás guiando a través de una historia mediante los diagramas, y cada nivel añade más comprensión.
Cuando no das ningún contexto, pierdes a tu audiencia y es poco probable que obtengas la respuesta deseada. Tus diagramas y materiales de apoyo (como los requisitos, el contexto empresarial y los beneficios empresariales) deben estar ordenados de tal forma que creen una narración, empezando por el panorama general (como la bahía pirata de LEGO de Gregor con los tiburones de ).
Haz coincidir el flujo del diagrama con las expectativas
El patrón hace coincidir el flujo del diagrama con las expectativas y te permite crear un diagrama que sea fácil de leer para tu audiencia de principio a fin. Mucha gente crea diagramas sin pensar en cómo los leerá el público. Todos los diagramas tienen un flujo de información, ya comuniquen estructura o comportamiento, que querrás ajustar lo más posible a las expectativas de la audiencia. Mientras que otros patrones han tratado de lo que hay que incluir o excluir de un diagrama, este patrón trata de utilizar esos componentes para ordenar una historia de forma que tenga sentido para tu público.
Cuando coges un libro, esperas que el texto empiece arriba a la izquierda y acabe abajo a la derecha (o arriba a la derecha y abajo a la izquierda, si lees una lengua de derecha a izquierda). ¿Por qué no iba a ser así con un diagrama? Una comunicación eficaz rompe tantas barreras como sea posible entre tú y tu audiencia.
El flujo no es tan sencillo con un diagrama como con un libro, pero tener un foco o el inicio de tu diagrama en o cerca de la parte superior izquierda, o en el centro izquierda, tiene mucho más sentido que empezar en otro lugar del lienzo para quienes utilizan lenguajes escritos de izquierda a derecha. Sigue esto con un flujo general de arriba abajo y de izquierda a derecha para ayudar a tu audiencia a consumir el mensaje del diagrama.
Consejo
Para evitar confusiones, especialmente en un diagrama que no puedes editar y reordenar, puedes añadir una etiqueta o un símbolo para indicar dónde debe empezar a leer el público. Empezar aquí, o un símbolo como una flecha , un dedo señalador o un botón Reproducir son todas opciones. También puedes utilizar etiquetas numeradas para guiar al público por el diagrama en el orden correcto.
La Figura 4-4 ilustra cómo podría acabar un diagrama de flujo de datos si no tienes en cuenta cómo lo leerá el público. ¿Dónde deberían empezar? La parte superior izquierda de es el lugar natural, pero en realidad el comienzo está más cerca de la parte inferior derecha, en el cuadro Cliente. El flujo es entonces de derecha a izquierda y de abajo arriba, en contra de lo que espera el público.
Consejo
Como una historia, tu diagrama debe tener un principio (por donde debe empezar a leer el público), un medio (el resto del contenido en un orden adecuado) y un final (las conclusiones que quieres que saque el público).
La Figura 4-5 reordena la Figura 4-4 para indicar mejor la dirección del flujo. Léela para ver que es mucho más fácil de seguir. El inicio del diagrama está a la izquierda (Cliente), con las peticiones fluyendo de izquierda a derecha y las respuestas fluyendo de derecha a izquierda. Los eventos numerados que actúan sobre los datos fluyen de arriba abajo y de izquierda a derecha, junto con los identificadores de letras (A-C) de las bases de datos.
Otro aspecto del flujo de un visual que hay que tener en cuenta son las interacciones que representa (por ejemplo, las flechas de relación etiquetadas). Una petición debe seguir la misma dirección que el texto (de izquierda a derecha en inglés), y una respuesta debe fluir en sentido contrario.
Consejo
Asegúrate de que la respuesta de un componente fluya siempre en sentido contrario a las peticiones. Diferenciar visualmente los tipos de interacciones ayuda a tu audiencia a comprender tu diagrama con mayor facilidad.
Conseguir que el flujo sea correcto es fácil en los diagramas de secuencia. El flujo comienza en la parte superior izquierda y las peticiones fluyen de izquierda a derecha y las respuestas de derecha a izquierda. La Figura 4-6 ilustra un diagrama de secuencia con un flujo que cumple las expectativas del público. El orden de los componentes en la parte superior es fundamental para permitir el flujo de izquierda a derecha y luego de derecha a izquierda.
Consejo
Explica tu diagrama a alguien (o incluso a un patito de goma) para comprobar si tu explicación fluye a través del diagrama o salta de un lado a otro.
Los diagramas estructurales deben tener un flujo de información similar, pero requieren consideraciones adicionales. Al crear un diagrama que incluya infraestructura, como bases de datos, la expectativa general es que los elementos de infraestructura se coloquen en la parte inferior del diagrama, con elementos como sistemas y contenedores por encima, y luego elementos como actores o usuarios en la parte superior. No se trata de una regla rígida, pero debe seguirse a menos que hacerlo suponga caer en antipatrones.
Los diagramas lógicos que muestren, por ejemplo, una arquitectura en capas deben seguir el flujo de izquierda a derecha y de arriba abajo, pero también deben tener en cuenta las capas. Al igual que en otros diagramas estructurales, las capas deben disponerse lógicamente de arriba abajo, con la capa orientada al usuario en la parte superior (como la interfaz de usuario o la capa API). Dentro de las capas, considera la forma más lógica de disponer los elementos de izquierda a derecha.
Nota
Las expectativas de disposición difieren un poco para un diagrama de arquitectura hexagonal . Piensa en el diagrama más como la esfera de un reloj. La parte superior izquierda sigue siendo un buen lugar para empezar, porque es donde los ojos de la gente pueden posarse de forma natural, pero también puedes atraer su atención hacia el centro. Utiliza colores, texto en negrita o más grande, o líneas más gruesas para atraer su atención hacia donde quieres que empiecen, y dispón los elementos del diagrama de forma lógica, en el sentido de las agujas del reloj .
Relaciones claras
Un diagrama tiene dos elementos principales: los componentes (contenedores, procesos, etc.) y las relaciones entre ellos (flechas, agrupaciones, etc.). Ambos son fundamentales para el mensaje de un diagrama, pero las relaciones conducen al público a través de una historia, y por eso es importante el patrón de relaciones claras.
Sin relaciones claras, tu mensaje se pierde o se confunde, lo que puede tener consecuencias como:
-
El diseño que das a los desarrolladores no se implementa como tú querías.
-
No consigues la aprobación presupuestaria para los cambios que quieres hacer en el sistema porque las partes interesadas clave no entendieron cómo esos cambios añadirían valor.
Lo mejor es tener relaciones unidireccionales (en una sola dirección), y la etiqueta de cualquier flecha entre dos componentes debe describir la relación en la dirección mostrada. Una línea con puntas de flecha en ambos extremos sólo debe utilizarse cuando el mismo proceso ocurra realmente en ambas direcciones. Esto es bastante raro.
Las relaciones también pueden hacerse más claras utilizando un patrón y un color; por ejemplo, una línea de puntos o para una flecha o un recuadro.2 A continuación, deberás incluir una leyenda .3
Los diagramas de secuencia , como la Figura 4-7, son un buen ejemplo de relaciones y flujos unidireccionales. No crees un diagrama de secuencia como el de la Figura 4-8, que combina cada par de relaciones unidireccionales en una relación bidireccional. Compara las etiquetas de las Figuras 4-7 y 4-8 para ver cuánta información se pierde. El mensaje del diagrama no queda claro cuando se utilizan relaciones bidireccionales , y añadir más información a las etiquetas reduciría el espacio en blanco y la claridad.
ArchiMate, un lenguaje de modelado abierto para la arquitectura empresarial, define muchos tipos de relaciones mediante diversas combinaciones de patrones y formas. Esta notación es buena para comunicar una gran cantidad de información en poco espacio, pero requiere una leyenda porque el público puede no estar familiarizado con la notación o no recordar todos los detalles.
La Figura 4-9 muestra una clave de los tipos de relaciones de ArchiMate. Incluir una clave (que muestre al menos los tipos utilizados en el diagrama mostrado) es necesario siempre que crees un diagrama de ArchiMate, para asegurarte de que tu audiencia comprende los numerosos tipos.
ArchiMate es una notación perfectamente válida, pero ten en cuenta las necesidades de tu público. Otra notación, como C4, podría comunicar tu mensaje de una forma mucho más sencilla sin una clave (aunque incluir una clave es casi siempre una buena idea). Discutiré más a fondo las ventajas y desventajas de la notación en el Capítulo 5. Haz que la historia que cuentan tus relaciones sea clara y fácil de entender para tu audiencia .
Resumen
A lo largo de este capítulo, has aprendido técnicas para crear flujo y narrativa en tus diagramas para mejorar la comprensión del público y mantener su atención. Junto con los patrones y antipatrones de los capítulos anteriores, ahora dispones de una gran caja de herramientas a la que recurrir a la hora de crear diagramas, pero aún hay más que añadir.
En este capítulo, he introducido en la notación, que es el sistema de símbolos utilizado para crear tu diagrama y transmitir tu mensaje. El capítulo siguiente se sumerge en algunos antipatrones para ayudarte a detectar cuándo, y cuándo no, aplicar algunas de las notaciones más comunes que se utilizan hoy en día.
1 Consulta las figuras 1-10, 1-11 y 1-12 en "Mezcla de niveles de abst racción " para saber más sobre niveles de abstracción como éstos.
2 Asegúrate de evitar el antipatrón depender del color para comunicar(consulta "Depender del color para comunicar").
3 Para más información, consulta "Incluir una leyenda".
Get Patrones de comunicación now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.