No tienes acceso a esta clase

¡Continúa aprendiendo! Únete y comienza a potenciar tu carrera

Documentación Efectiva en Sistemas de Diseño Digital

5/9
Recursos

¿Por qué es fundamental la documentación en el diseño de productos digitales?

La documentación es una herramienta esencial en el diseño de productos digitales. Sirve no solo para narrar la historia del producto, sino también como guía para futuros proyectos. Permite a los equipos comprender mejor el diseño y facilita la colaboración al reducir malentendidos y discrepancias. La documentación exhaustiva asegura que todos los integrantes del equipo puedan acceder a la información necesaria para defender las decisiones de diseño y resolver problemas rápidamente cuando surjan.

¿Cómo ayuda la documentación en la resolución de conflictos dentro del equipo?

Los conflictos en el equipo pueden surgir cuando hay desacuerdo sobre el enfoque de diseño. Aquí es donde entra en juego la documentación, brindando un sistema de diseño que actúa como punto de referencia. Incluye registros de todo el proceso, investigación previa, componentes y estilos documentados, dejando poco espacio para el debate. De esta forma, la lógica detrás de las decisiones de diseño es clara y defendible.

¿Qué hace especial la documentación del sistema de diseño?

La documentación del sistema de diseño es única porque se estructura teniendo en cuenta a sus usuarios. Sabemos quiénes accederán a ella y para qué lo harán, lo que nos ayuda a organizar la información de manera eficiente. Esta organización incluye secciones sobre cómo trabajar con el sistema, patrones de uso y componentes.

¿Qué elementos deben documentarse en un sistema de diseño?

Para documentar eficazmente, es crucial enfocarse en el "qué", "dónde" y "cómo" de cada componente, patrón o principio:

  • Qué: Debe incluir la descripción del elemento o proceso, explicando su necesidad y los problemas que resuelve.
  • Dónde: Determina en qué circunstancias se usará un proceso o dónde debe ubicarse un componente.
  • Cómo: Detalla la estructura para llevar a cabo un componente o patrón, sus características visuales y funcionales, y las herramientas o estrategias a utilizar.

¿Por qué dedicar tiempo a la documentación no es un desperdicio?

Documentar puede parecer una pérdida de tiempo valioso que podría dedicarse al diseño y desarrollo, pero su importancia se magnifica cuando un miembro del equipo se ausenta o deja el proyecto. La documentación previene la pérdida de información crucial, asegurando la continuidad del trabajo sin interrupciones significativas.

¿Cómo la documentación refleja los valores y cultura del producto?

Más allá de los aspectos técnicos, la documentación del sistema de diseño transmite los valores y la cultura del producto. Estos se ven reflejados en los principios de diseño y en la guía de estilo. Este tipo de documentación no sólo asegura una coherencia visual y funcional, sino que también alinea al equipo con una visión compartida del producto.

Finalmente, te invitamos a explorar más sobre cómo mejorar tus habilidades de documentación en nuestros cursos recomendados. Continuar aprendiendo y desarrollando estas destrezas te permitirá maximizar el impacto de tus proyectos de diseño y contribuir de manera más efectiva en equipos colaborativos.

Aportes 16

Preguntas 3

Ordenar por:

¿Quieres ver más aportes, preguntas y respuestas de la comunidad?

Qué: descripcion del elemento o el proceso

  • ¿Por qué se necesita y qué problema resuelve?

Dónde:

  • Hablando de procesos ¿En qué circunstancias lo vamos a utilizar?

  • Si es componente o funcionalidad ¿Donde debe ubicarse y su caso de uso?

  • Sí es un principio ¿Dónde debe verse reflejado en nuestros proyectos?

Cómo: forma en la que se lleva a cabo, y debería responder a ciertas preguntas

  • ¿Hay una estructura para implementarlo?

  • En caso de ser un componente o patrón, ¿Cuáles son sus características visuales y funcionales?

  • ¿Qué herramientas o estrategias utilizaremos?

Una buena documentación, ahorra tiempo y deja claro el porqué de un patrón, componente o proceso. Un sistema de diseño es un sistema vivo que debe ir evolucionando con el tiempo y ese sistema vivo debe comunicarse con diseñadores, desarrolladores y otros equipos interesados. Recordemos que un Design System es la fuente de la verdad.

Una buena documentación ayuda la consistencia a lo largo de un proyecto y permite que todo el equipo hable un mismo lenguaje.

¿Por qué documentar?

Imagina que alguien del equipo se enferma, se va a otro proyecto o de vacaciones. Qué pasará si tu trabajo no está documentado? Pérdida de información para el resto del equipo.

El qué resuelve:

  • Descripción de qué es el elemento /proceso de sí mismo.

  • Por qué motivo lo necesitamos o usamos.

  • Qué problemas resuelve.

El dónde resuelve:

  • Si es un proceso, en qué casos lo vamos a utilizar.

  • Si es un componente o funcionalidad, ¿dónde se debe ubicar?

  • Si es un principio, dónde debe verse reflejado.

El cómo resuelve:

  • ¿Hay una estructura básica para hacerlo?

  • En caso de ser un componente o patrón, ¿Cuáles son sus características visuales y funcionales?

  • ¿Qué herramientas o estrategias utilizaremos?

¿Para qué sirve?

  • Plasmar la historia del producto
  • Guía para otros proyectos
  • Entender la forma de trabajar y los procesos.

En caso de duda, revisa el Sistema de Diseño y la documentación del proyecto.
Conocer a los usuarios y usuarias, y las necesidades que tienen.

Establecer:

  • Arquitectura de Información
  • Nomenclatura de secciones
  • Contenidos

¿Qué documentar? De cada uno de los patrones, componentes y procesos, dejar claro:

  • Qué: Descripción. Por qué lo tenemos y que problema resuelve.
  • Dónde: En qué circunstancias se va a utilizar. Caso de uso.
  • Cómo: forma en la que se lleva a cabo. ¿Tenemos una estructura para hacerlo? ¿Cuáles son sus características funcionales y estéticas? ¿Qué herramientas o estrategias vamos a utilizar.

¿Qué pasara si alguien se va del equipo y no tiene su trabajo documentado? -> sino está documentado, no existe.

Dios bendiga la documentación.

Una de las cosas para lo que es útil tener un SSDD es para reducir el tiempo de la curva de aprendizaje de nuevos integrantes.

Parece que no, pero la documentación ayuda tremendamente a los desarrolladores cuando necesitan saber algo en específico, especialmente si es documentación basada en componentes.

El documentar pude llegar a ser tan importante que puede convertirse en un guion de tal forma que podamos contar una historia con ello y poder interpretar cual era el reto y ver cual fue el resultado.

Documentar:
Que: El motivo
Dónde: relacionado a un caso de uso
Cómo: la forma en como lo vamos a llevar a cabo

Me parece que este approach es incorrecto, ya que en equipos de software nosotros valoramos más Software funcionando a Documentación exhaustiva. La razón es sencilla. Con base en que tenemos iteraciones muy cortas y cambios muy rapidos, no tiene caso documentar exhaustivamente algo que puede que quede deprecated o inutil en un mes. Entonces, como lo solucionamos? Simple, usando el design system como nuestra documentacion viviente. Por ejemplo, con herramientas como Storybook, nosotros podemos acceder al sistema de diseño que tiene detalle acerca de como y cuando debe usarse tal componente, asi como algun link al figma. De esa manera, tenemos codigo, diseño, casos de uso y basicamente todo centralizado y facilmente accesible. Lo mejor de todo, actualizado. Y es cierto, "Lo que no esta escrito, no existe", aqui el tema es que en caso del software primero se escribe y luego existe
## **Solución** 3️⃣ **: Documentar todo** **¿Para Qué Sirve la Documentación?** • **Plasmar la Historia del Producto**: Guarda el progreso y evolución del proyecto. • **Guía para Otros Proyectos**: Facilita la replicación de mejores prácticas. • **Entender la Forma de Trabajar**: Proporciona un marco claro de procesos y decisiones. En caso de duda, revisa el Sistema de Diseño y su documentación. ¡Evita la pérdida de información valiosa! 🔍 **Documentación en el Sistema de Diseño** • **Conocer a los Usuarios y sus Necesidades**: Asegura que los elementos cumplan expectativas. • **Establecer Elementos Clave**: • **Arquitectura de Información** 📂 • **Nomenclatura de Secciones** 🏷️ • **Contenidos** 📄 **¿Qué Documentar?** Cada **patrón, componente** o **proceso** debe incluir: 1. **El Qué**: • **Descripción**: Explica qué es el elemento o proceso. • **Motivo**: ¿Por qué es necesario? ¿Qué problema resuelve? 1. **El Dónde**: • **Para Procesos**: ¿En qué situaciones se utilizará? • **Para Componentes o Funcionalidades**: Ubicación en el proyecto y casos de uso. • **Para Principios**: ¿Dónde deberían reflejarse en los proyectos? 1. **El Cómo**: • **Estructura de Implementación**: ¿Hay una base que seguir? • **Para Componentes o Patrones**: Describe las características visuales y funcionales. • **Herramientas o Estrategias**: ¿Qué usaremos para su implementación? **¿Por Qué Documentar?** • **Garantiza Continuidad**: Si alguien falta, la documentación evita la pérdida de contexto. • **Evita Retrasos**: Menos tiempo aclarando dudas y más avanzando. • **Alinea al Equipo**: Un recurso común para todos, sin perderse en el camino. Resumen completo: <https://veil-warlock-2dd.notion.site/Colaboraci-n-Dise-o-Desarrollo-1307d5c52e01804bb1d6ddb2f7873828?pvs=4>

Gracias

Recuerda: Si algún elemento o proceso no está documentado en el Design System, no existe.

Lo mas importante a documentar es el

  • Que
  • Como
  • Donde

de todos los patrones componentes y procesos

Una buena documentación evita confusiones a la hora de la implementación