No tienes acceso a esta clase

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

Solución tres: documentar todo

5/9
Recursos

Aportes 15

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?

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.

Pienso que un gran lugar para hacer la documentación del Design System es https://zeroheight.com/, y además un espacio propicio hacer esa integración diseño-desarrollo

¿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.

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

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