Introducción del sistema de diseño a aplicaciones web multinacionales

Rate this content
Bookmark

Explicaré el proceso de introducción del sistema de diseño a las aplicaciones web de nuestra empresa que se construyen de forma separada en diferentes países: Reino Unido, Estados Unidos, Alemania, España y Japón. Después, agregaré una guía práctica para configurar un sistema de diseño para un proyecto.

18 min
21 Jun, 2022

Video Summary and Transcription

Octopus Energy introdujo sistemas de diseño para abordar los desafíos en el mantenimiento de la identidad de marca, la accesibilidad y la experiencia del desarrollador. Construyeron una biblioteca de componentes utilizando pautas de diseño y las mejores prácticas de accesibilidad, siguiendo la metodología de diseño atómico de Bradfrost. Utilizaron TypeScript, Jest, Versal y Storybook para construir y probar la biblioteca. El sistema de diseño es un proyecto en curso que evoluciona con el producto y el negocio a lo largo del tiempo.

Available in English

1. Introducción al viaje de Octopus Energy

Short description:

Hola, soy Allison. Soy una desarrolladora front-end de Octopus Energy en Londres. Hoy quiero hablar sobre el viaje de Octopus Energy en la introducción de sistemas de diseño a aplicaciones web multinacionales. Octopus Energy fue fundada hace casi siete años, y en este tiempo hemos pasado de cero clientes a más de 3 millones. A medida que crecíamos, y con esto me refiero a escala global, naturalmente enfrentamos algunos desafíos. Así que comenzamos a trabajar en la solución.

Soy una desarrolladora front-end de Octopus Energy en Londres. Hoy quiero hablar sobre el viaje de Octopus Energy en la introducción de sistemas de diseño a aplicaciones web multinacionales. Octopus Energy fue fundada hace casi siete años, y en este tiempo hemos pasado de cero clientes a más de 3 millones. A medida que crecíamos, y con esto me refiero a escala global, naturalmente enfrentamos algunos desafíos. Así que comenzamos a trabajar en la solución. Quiero compartir nuestro viaje en la implementación de la solución y los puntos de aprendizaje de ella. Y si tienen alguna pregunta en el camino, por favor tomen nota o algo así, tendremos tiempo al final para las preguntas y respuestas.

2. Desafíos y solución de Octopus Energy

Short description:

En Octopus Energy, enfrentamos desafíos para mantener una identidad de marca consistente, accesibilidad y experiencia de desarrollo en diferentes países. Para abordar esto, decidimos construir una biblioteca de componentes utilizando bloques de LEGO, siguiendo pautas de diseño y mejores prácticas de accesibilidad. Esta biblioteca será compartida con nuestros equipos de desarrollo globales como parte de nuestro sistema de diseño, que contiene los principios de diseño y pautas de nuestra marca para los patrones.

En Octopus, tenemos una reunión semanal para actualizaciones de la empresa y bebidas los viernes por la tarde, a la que llamamos Cena Familiar. Cada mes escuchábamos noticias emocionantes. Octopus Energy se está expandiendo a nuevas regiones del mundo, lo que trajo consigo algunos desafíos interesantes.

Nos hacemos estas preguntas. ¿Cómo podemos mantener nuestra identidad de marca consistente en diferentes países? ¿Cómo podemos mantener la accesibilidad al más alto nivel? ¿Cómo podemos apoyar a nuestros equipos de ingenieros brindando una mejor experiencia de desarrollo? Bueno, nada mejor que algunos ejemplos visuales.

Así es como se ve el área de aterrizaje de la página principal de Octopus Energy en diferentes países. Este es el Reino Unido, Francia, Italia, España, Japón, Estados Unidos, Alemania y Nueva Zelanda. Puedo mostrarles cómo se ve nuestro logotipo de navegación principal detrás de escena en diferentes países. Algunos países usaban el logotipo con nuestra mascota Constantine, el lindo pulpo rosa que ven allí, y otros usaban el logotipo sin él. Este tiene una etiqueta A simple envolviendo una imagen. Otro tiene una etiqueta A envolvente que tiene un span, una imagen y pueden ver aquí algunas prácticas de accesibilidad con área de etiqueta y texto oculto visualmente para lectores de pantalla. Este tiene una etiqueta A envolvente que tiene un div que contiene otro div con una imagen adentro y una etiqueta de imagen. Y pueden ver que esto no usa ningún nombre de clase, mientras que los anteriores usaban algunos nombres de clase según la elección de cada equipo de ingenieros. Estos son solo algunos ejemplos del código detrás de la interfaz de usuario, pero pueden tener una idea de lo que está sucediendo aquí. Si el logotipo principal viene con tantos estilos de código detrás, pueden imaginar fácilmente cómo se verá para diferentes componentes y páginas.

Establecimos algunos objetivos para abordar los desafíos. Queremos una identidad de marca consistente en todos los países. Queremos proporcionar una gran práctica de accesibilidad. Queremos brindar a nuestro equipo de ingeniería global una buena experiencia de desarrollo. ¿Qué hemos decidido para lograr esto? Decidimos construir bloques de LEGO para los desarrolladores. Para que puedan construir fácilmente lo que quieran con estos LEGOs, sin tener que preocuparse por la identidad de marca ni nada. En otras palabras, decidimos construir una biblioteca de componentes para nuestros desarrolladores. Este bloque de logotipo se creará siguiendo nuestras pautas de diseño. Cada bloque de LEGO vendrá con las mejores prácticas de accesibilidad. Además, todo estará tipado, ya que TypeScript es nuestro lenguaje de elección sobre React. En estos bloques de LEGO, la biblioteca de componentes será compartida con nuestros equipos de desarrollo en todo el mundo, como parte de nuestro sistema de diseño. Comenzamos a crear nuestro sistema de diseño junto con la construcción de la biblioteca de componentes. Contiene los principios de diseño de nuestra marca. Proporciona pautas para los patrones. Es la fuente de verdad sobre cómo definir lo que es nuestra

3. Building the Component Library

Short description:

Comenzamos con principios básicos de diseño como paletas de colores, tipografía y espaciado. Estos tokens de diseño nos permitieron crear patrones en nuestra biblioteca de componentes, como botones, cajas de alerta, deslizadores y campos de texto. Al definir estos patrones, eliminamos la necesidad de que los diseñadores y desarrolladores tomen decisiones de diseño repetidamente. Seguimos la metodología de diseño atómico de Bradfrost, donde los componentes más pequeños son átomos, los componentes más grandes son moléculas y las interfaces de usuario son organismos. Nuestra biblioteca de componentes, que contiene bloques de LEGO listos para usar, garantiza una experiencia de usuario consistente. Si bien una biblioteca de componentes puede existir sin un sistema de diseño, un sistema de diseño abarca más que una biblioteca de componentes.

Las aplicaciones React deben tener un aspecto determinado. Comenzamos desde principios básicos de diseño. Paletas de colores, para que puedas asegurarte de seguir las pautas de uso de colores. Además, si alguno de estos colores cambia en el futuro, solo necesitas hacer un cambio en un solo lugar. Tipografía, para que no tengas que preocuparte por el tamaño y el peso de la fuente para cada encabezado y el texto del cuerpo. Espaciado, para que puedas pasar el menor tiempo posible decidiendo cuál debería ser el relleno y el margen. Con estos tokens de diseño listos, ahora puedes agregar patrones a la biblioteca. Agrega componentes de interfaz de usuario como botones aquí, y cómo se ven y se comportan los botones. Por ejemplo, como puedes ver, tenemos botones estándar, contorneados, de texto o un botón con un ícono en él. También definimos el estado de hover, el estado de clic, el estado deshabilitado, y así sucesivamente. La caja de alerta, el deslizador y el campo de texto. Todos estos componentes se pueden usar para formar un patrón en la biblioteca, como este formulario, o un botón de llamada a la acción con un campo de entrada. Un componente de tarjeta con campos de texto y un botón adentro, y puedes ver cuántas decisiones de diseño hay en este pequeño componente. Relleno, márgenes, tamaño y peso de la fuente. Sin el patrón definido, esto es algo que debe decidirse cada vez tanto para diseñadores como para desarrolladores. Siempre podremos consultar este sistema de diseño cuando tengamos que construir cualquier página o producto que necesitemos construir. Así como miramos las instrucciones cuando construimos un modelo de LEGO.

Con nuestra biblioteca de componentes, decidimos seguir la metodología de diseño atómico de Bradfrost. Los componentes más pequeños, o bloques de LEGO, se llaman átomos. Los componentes más grandes, creados combinando átomos, se llaman moléculas. La interfaz de usuario, creada con átomos y moléculas, como una barra de navegación, tarjetas con texto o campos de entrada dentro, se llama organismo. Algo como una página de error 404 se puede agregar como una plantilla porque es un diseño completo y se puede compartir en diferentes países. Proyecto Corel. Comenzamos a construir una biblioteca de componentes para resolver los nuevos desafíos que mencioné al principio. Pero espera, ¿sistema de diseño? ¿Biblioteca de componentes? ¿Son lo mismo? La biblioteca de componentes te permite usar bloques de LEGO listos para usar. Dado que todos los LEGOs en su interior se crean siguiendo las pautas de los sistemas de diseño, puedes estar seguro de que proporcionará una experiencia de usuario consistente. El sistema de diseño es la instrucción para construir modelos de LEGO. Y la biblioteca de componentes es la caja de bloques de LEGO. Ten en cuenta que el sistema de diseño es un concepto más amplio que incluye la biblioteca de componentes. El sistema de diseño seguirá siendo un sistema de diseño incluso si no tienes una biblioteca de componentes. Pero la biblioteca de componentes puede existir sin un sistema de diseño.

4. Construyendo la Biblioteca de Componentes (Continuación)

Short description:

Utilizamos TypeScript y Jest para construir nuestros bloques de LEGO y escribir pruebas. Versal y Storybook son excelentes herramientas para implementación rápida, colaboración y documentación. Inicialmente, utilizamos Material UI como una biblioteca de componentes externa, pero luego cambiamos a styled components para tomar mejores decisiones de diseño e integración con nuestro propio sistema de diseño.

Esto es lo que utilizamos para construir nuestros bloques de LEGO. Utilizamos TypeScript, por lo que nuestro tema está completamente tipado. Escribimos pruebas para nuestros componentes utilizando Jest. Utilizamos Versal para implementar rápidamente los cambios en Storybook. Es muy fácil para nosotros construir algo e implementarlo rápidamente para obtener comentarios. Versal es una excelente herramienta para implementación rápida y colaboración entre desarrolladores. Es muy sencillo integrarlo con GitHub, por lo que cuando realizas un cambio y lo envías, se implementará al instante. Con la URL de vista previa y todo. Hay una más de la que hablaré más adelante.

Utilizamos Storybook para documentar las propiedades disponibles en la tabla de propiedades. Storybook también puede mostrar si tu componente cumple con el estándar de accessibility. Además, esto se puede utilizar como la documentación así como la fuente de verdad para los desarrolladores para verificar la interfaz de usuario en los ejemplos de uso con la funcionalidad de ver el código. Y esto es a lo que se refería el signo de interrogación.

Decidimos utilizar una biblioteca de componentes externa existente que tiene un estilo de diseño similar al nuestro. Esta es Material UI. ¿Y por qué hicimos esto? Porque al principio de este proyecto, había recursos limitados. Básicamente, el número de diseñadores y desarrolladores que podían trabajar a tiempo completo en esto era pequeño. Y queríamos crear algo rápidamente aprovechando el soporte de react y TypeScript en las mejores prácticas de accessibility. Y como se alinea con el estilo básico de diseño de Octopus, no necesitaríamos hacer muchas personalizaciones. Lo importante es que nuestro sistema de diseño es independiente de esta biblioteca de componentes externa. Por lo tanto, en caso de que decidamos no utilizar esta biblioteca más o cambiar a diferentes bibliotecas, aún podemos mantener nuestro propio sistema de diseño sin muchos problemas. Por lo tanto, hubo muchas buenas razones por las que esta fue una buena elección para nosotros al principio, pero a medida que crecíamos, nos alejamos de ella ya que limitaba nuestra capacidad de seguir las decisiones de diseño. Decidimos utilizar styled components, que nos permiten utilizar componentes de React con una fácil integración de nuestro propio sistema de diseño. Está bien utilizar una biblioteca de componentes existente para comenzar a construir la tuya propia. Solo asegúrate de que tu sistema de diseño no dependa completamente de ella. Recuerda que la biblioteca de componentes externa de tu elección es una herramienta para tu sistema de diseño. Es posible que desees construir la tuya propia desde cero o tal vez quieras usar otra biblioteca. Pero en cualquier caso, aún tienes tu sistema de diseño como fuente de verdad para guiarte. Además, puedo recordarte una vez más que la biblioteca de componentes de tu elección es parte de tu sistema de diseño. Así es como quedó.

5. Sistema de Diseño y Proyecto en Curso

Short description:

El sistema de diseño no tiene que ser una documentación masiva que contenga todas las reglas y pautas. Puede comenzar con tokens de diseño simples como colores, reglas de tipografía y espaciado. Coral es un proyecto en curso en Octopus Energy, con un canal de retroalimentación para que los usuarios compartan sus comentarios y contribuyan al proyecto de código abierto. Los sistemas de diseño son entidades vivas que evolucionan con el producto y el negocio a lo largo del tiempo.

¿Ves la mejora de esto a esto? También puede ser utilizado por cualquiera de nuestros desarrolladores en todo el mundo. Ahora, cada territorio puede usar el logotipo tan simple como esto. Puedes pasar una constante de ancho como prop si deseas incluir la mascota en el logotipo. También puedes establecer el ancho específico en la prop de ancho para el tamaño. Y, por supuesto, tienes la opción de agregar un hipervínculo y usarlo sin la mascota.

¿Recuerdas dónde comenzamos? El sistema de diseño no tiene que ser esta documentación masiva que contiene todas las reglas y pautas. Al principio, puedes comenzar creando algunos tokens de diseño como una lista de colores que se utilizan en tu aplicación. Tienes una lista de reglas de tipografía como el tipo de letra y el tamaño de fuente para el encabezado uno y el encabezado dos, y cosas así. O la lista de espaciado como el tamaño del espaciado que deseas utilizar para el relleno o el margen o el espacio entre las secciones. No hay nada intimidante en definir estas cosas desde el principio. Porque cuando escuchas sistema de diseño, suena como un gran trabajo. Pero no dejes que eso te desanime.

Coral es un proyecto en curso en Octopus Energy. Tenemos un canal de retroalimentación en nuestro Slack donde todos los que utilizan la biblioteca de componentes están invitados a compartir sus comentarios incluyendo solicitudes, errores o preguntas. Con el canal de retroalimentación, la puerta a la discusión siempre está abierta y así es como sabemos qué debemos hacer para nuestro próximo paso. Además, aunque tenemos el equipo que está en el centro de la toma de decisiones en el Proyecto Coral, es un proyecto de código abierto dentro de la organización donde damos la bienvenida a la contribución de todos. De esta manera, podemos mejorar las cosas más rápido al tener una dirección clara de hacia dónde nos dirigimos. Considera el sistema de diseño como algo vivo, que cambiará y evolucionará al igual que tu producto y negocio, y no necesitas tener todo perfecto desde el primer día. Es algo que crecerá con el tiempo siempre y cuando lo mantengas. Muchas gracias. Puedes encontrarme en Twitter, ellieandcreative.

Check out more articles and videos

We constantly think of articles and videos that might spark Git people interest / skill us up or help building a stellar career

React Advanced Conference 2021React Advanced Conference 2021
47 min
Design Systems: Walking the Line Between Flexibility and Consistency
Top Content
Design systems aim to bring consistency to a brand's design and make the UI development productive. Component libraries with well-thought API can make this a breeze. But, sometimes an API choice can accidentally overstep and slow the team down! There's a balance there... somewhere. Let's explore some of the problems and possible creative solutions.
TechLead Conference 2023TechLead Conference 2023
35 min
A Framework for Managing Technical Debt
Let’s face it: technical debt is inevitable and rewriting your code every 6 months is not an option. Refactoring is a complex topic that doesn't have a one-size-fits-all solution. Frontend applications are particularly sensitive because of frequent requirements and user flows changes. New abstractions, updated patterns and cleaning up those old functions - it all sounds great on paper, but it often fails in practice: todos accumulate, tickets end up rotting in the backlog and legacy code crops up in every corner of your codebase. So a process of continuous refactoring is the only weapon you have against tech debt.In the past three years, I’ve been exploring different strategies and processes for refactoring code. In this talk I will describe the key components of a framework for tackling refactoring and I will share some of the learnings accumulated along the way. Hopefully, this will help you in your quest of improving the code quality of your codebases.

React Summit 2023React Summit 2023
24 min
Debugging JS
As developers, we spend much of our time debugging apps - often code we didn't even write. Sadly, few developers have ever been taught how to approach debugging - it's something most of us learn through painful experience.  The good news is you _can_ learn how to debug effectively, and there's several key techniques and tools you can use for debugging JS and React apps.
React Advanced Conference 2022React Advanced Conference 2022
22 min
Monolith to Micro-Frontends
Top Content
Many companies worldwide are considering adopting Micro-Frontends to improve business agility and scale, however, there are many unknowns when it comes to what the migration path looks like in practice. In this talk, I will discuss the steps required to successfully migrate a monolithic React Application into a more modular decoupled frontend architecture.
React Advanced Conference 2023React Advanced Conference 2023
22 min
Power Fixing React Performance Woes
Next.js and other wrapping React frameworks provide great power in building larger applications. But with great power comes great performance responsibility - and if you don’t pay attention, it’s easy to add multiple seconds of loading penalty on all of your pages. Eek! Let’s walk through a case study of how a few hours of performance debugging improved both load and parse times for the Centered app by several hundred percent each. We’ll learn not just why those performance problems happen, but how to diagnose and fix them. Hooray, performance! ⚡️

Workshops on related topic

React Summit Remote Edition 2021React Summit Remote Edition 2021
87 min
Building a Shopify App with React & Node
Top Content
WorkshopFree
Shopify merchants have a diverse set of needs, and developers have a unique opportunity to meet those needs building apps. Building an app can be tough work but Shopify has created a set of tools and resources to help you build out a seamless app experience as quickly as possible. Get hands on experience building an embedded Shopify app using the Shopify App CLI, Polaris and Shopify App Bridge.We’ll show you how to create an app that accesses information from a development store and can run in your local environment.
JSNation 2022JSNation 2022
41 min
Build a chat room with Appwrite and React
WorkshopFree
API's/Backends are difficult and we need websockets. You will be using VS Code as your editor, Parcel.js, Chakra-ui, React, React Icons, and Appwrite. By the end of this workshop, you will have the knowledge to build a real-time app using Appwrite and zero API development. Follow along and you'll have an awesome chat app to show off!
GraphQL Galaxy 2021GraphQL Galaxy 2021
164 min
Hard GraphQL Problems at Shopify
WorkshopFree
At Shopify scale, we solve some pretty hard problems. In this workshop, five different speakers will outline some of the challenges we’ve faced, and how we’ve overcome them.

Table of contents:
1 - The infamous "N+1" problem: Jonathan Baker - Let's talk about what it is, why it is a problem, and how Shopify handles it at scale across several GraphQL APIs.
2 - Contextualizing GraphQL APIs: Alex Ackerman - How and why we decided to use directives. I’ll share what directives are, which directives are available out of the box, and how to create custom directives.
3 - Faster GraphQL queries for mobile clients: Theo Ben Hassen - As your mobile app grows, so will your GraphQL queries. In this talk, I will go over diverse strategies to make your queries faster and more effective.
4 - Building tomorrow’s product today: Greg MacWilliam - How Shopify adopts future features in today’s code.
5 - Managing large APIs effectively: Rebecca Friedman - We have thousands of developers at Shopify. Let’s take a look at how we’re ensuring the quality and consistency of our GraphQL APIs with so many contributors.
JSNation 2023JSNation 2023
57 min
0 To Auth In An Hour For Your JavaScript App
WorkshopFree
Passwordless authentication may seem complex, but it is simple to add it to any app using the right tool.
We will enhance a full-stack JS application (Node.js backend + Vanilla JS frontend) to authenticate users with One Time Passwords (email) and OAuth, including:
- User authentication – Managing user interactions, returning session / refresh JWTs- Session management and validation – Storing the session securely for subsequent client requests, validating / refreshing sessions
At the end of the workshop, we will also touch on another approach to code authentication using frontend Descope Flows (drag-and-drop workflows), while keeping only session validation in the backend. With this, we will also show how easy it is to enable biometrics and other passwordless authentication methods.
JSNation 2023JSNation 2023
87 min
Build a Collaborative Notion-Like Product in 2H
WorkshopFree
You have been tasked with creating a collaborative text editing feature within your company’s product. Something along the lines of Notion or Google Docs.
CK 5 is a feature-rich framework and ecosystem of ready-to-use features targeting a wide range of use cases. It offers a cloud infrastructure to support the real-time collaboration system needs. During this workshop, you will learn how to set up and integrate CK 5. We will go over the very basics of embedding the editor on a page, through configuration, to enabling real-time collaboration features. Key learnings: How to embed, set up, and configure CK 5 to best fit a document editing system supporting real-time collaboration.
Table of contents:- Introduction to the CK 5 ecosystem.- Introduction to a “Notion-like” project template.- Embedding CK 5 on a page.- Basic CK 5 configuration.- Tuning up CK 5 for a specific use case.- Enabling real-time editing features.