Saltar al contenido

Ejercicio final

Documentar el sistema

Qué se documenta en un sistema de tokens y dónde: la función de cada token en su descripción y las decisiones en un registro. Qué lleva una buena descripción y cómo se escribe un registro de todo el sistema.

Última revisión:

Un sistema de tokens sin documentar obliga a adivinar. Quien lo usa no sabe qué token elegir, y quien lo mantiene no sabe por qué un valor es el que es. En los módulos anteriores has tomado muchas decisiones; en esta lección verás dónde se guarda cada una para que no se pierdan.

En esta página

Dos cosas distintas que documentar

Un sistema de tokens responde a dos preguntas, y cada una tiene su sitio:

PreguntaQuién la haceDónde se respondeEjemplo de DesignToken101
¿Para qué sirve este token?Quien diseña o programa con el sistemaEn la descripción del tokencolor/text/neutral/default: "Texto principal"
¿Por qué el sistema es así?Quien mantiene o cambia el sistemaEn el registro de decisionesPor qué el interlineado vive en código y no en Figma

La descripción viaja con el token: se ve en Figma y llega al código con la exportación. El registro guarda lo que no cabe en un token: las alternativas que descartaste y el motivo.

La descripción de un token

Lo que dice la fuente:

  • DTCG define $description, una descripción en texto plano del propósito del token. Lo tienen también los grupos. Las herramientas pueden mostrarla junto a una muestra del token, como ayuda en un editor o como comentario en el código generado (Format Module: Description).
  • Figma tiene un campo de descripción en la ventana de edición de cada variable, para explicar cómo se usa (Figma: Create and manage variables and collections).

Lo que comprobamos: la exportación de Figma escribe esa descripción como $description del token, al lado de su valor (exportación de Semantic color de DesignToken101, 6 de octubre de 2026):

tokens/figma/semantic-color/Light.tokens.json (abreviado)

"focus": {
  "$type": "color",
  "$value": { "colorSpace": "srgb", "hex": "#0EA075" },
  "$description": "Anillo de foco (2 px, border-width/200)"
}

Una descripción escrita una vez en Figma viaja con el token, así que cualquier herramienta que lea el archivo puede usarla: DTCG prevé, por ejemplo, que se convierta en un comentario del código generado.

Qué lleva

Una buena descripción dice para qué sirve el token, y dónde se usa si eso ayuda a elegir. No repite el valor, que ya está en el token, ni cuenta la historia de cómo llegó ahí.

Tipo de tokenQué dice la descripciónEjemplo de DesignToken101
Un semántico normalSu funcióncolor/text/neutral/subtle: "Texto secundario"
Uno que se confunde con otroCuándo usarlo y cuándo nocolor/border/neutral/strong: "Bordes que identifican un control (≥ 3:1)"
Uno sin uso todavíaQue no se usa, y por qué existecolor/background/danger/subtle: "Fondo de los mensajes de error. Sin uso todavía (S31)"
Una excepciónSu función y el motivo de la excepcióncolor/background/overlay: "…Valor directo: un alias de Figma no puede cambiar la opacidad."

Los dos últimos tipos son los más importantes. Un token sin uso o un valor directo parecen un error a quien no conoce el motivo. La descripción evita que alguien los "arregle" sin saberlo (Cuando un semántico no es alias).

Qué tokens llevan descripción

Lo que hacen los sistemas de referencia:

Recomendación

En DesignToken101, todos los semánticos llevan descripción y los primitivos no la necesitan (S37). Los semánticos son lo que se usa al diseñar y al programar: su nombre dice la función, pero no siempre basta para elegir entre dos parecidos. Los primitivos están ocultos al publicar (La colección completa) y su nombre ya es su valor: space/400 no necesita explicar que mide 16 px. Si en tu sistema algún primitivo se usa directamente al diseñar, descríbelo.

El registro de decisiones

El registro guarda lo que una descripción no puede contar: qué alternativas había, por qué elegiste una y cuándo. Sin él, la siguiente persona que mire el sistema repetirá la discusión, o cambiará algo que se decidió por un buen motivo.

En el ejercicio del módulo 7 escribiste un registro de decisiones de accesibilidad. El de todo el sistema tiene la misma forma, con una columna más para saber de dónde viene cada decisión:

DecisiónMotivoAlternativas descartadasMóduloFecha
Espaciado negativo únicamente en códigoEn Figma, el scope del gap cubre también el padding, y un padding negativo no es válido en CSSVariables en Figma limitadas al gap22026-09-30
Interlineado únicamente en códigoFigma lee una variable de interlineado como píxelesVariable en Figma como multiplicador22026-09-30
translucent al 96 % en LightEl anillo de foco no llegaba a 3:1 sobre la cabeceraCabecera opaca; anillo de dos colores72026-10-05

Las tres filas son decisiones reales de DesignToken101 (D02, D01 y S35). El registro completo de esta web está en su repositorio, con todas las decisiones del curso y del sistema (docs/decisiones.md).

Tres reglas para que el registro siga siendo útil:

  1. Una decisión por fila, con fecha. Si la cambias, no borres la fila: añade la nueva y anota en la vieja qué la sustituye. Así se ve la historia.
  2. El motivo, no la descripción. "Interlineado únicamente en código" es la decisión; "Figma lo lee como píxeles" es el motivo.
  3. Las alternativas descartadas, aunque sea una. Es lo primero que preguntará quien quiera cambiarla.

Dónde vive la documentación

Lo que dice la fuente: el curso de sistemas de diseño de Figma propone, para un equipo pequeño, documentar en el mismo sitio que el sistema o en herramientas como Storybook o Notion; una web propia permite más, pero cuesta construirla y mantenerla. El mismo curso documenta las decisiones del sistema con ejemplos visuales de los valores, como referencia para quien lo usa (Figma: Lesson 4, Document and manage your system).

Recomendación

Guarda la documentación en una página de tu archivo de Figma, al lado de las variables que describe: la convención de nombres que escribiste en el ejercicio del módulo 4, el registro de decisiones y el registro de cambios (Versionar el sistema). Quien abra el archivo para usar el sistema la encontrará sin buscar.

En Figma

Para escribir o revisar las descripciones, abre la vista Variables. En cada fila, el icono de editar abre la ventana de la variable, donde está el campo de descripción (Figma: Create and manage variables and collections).

Recorre una colección entera de una vez, grupo a grupo. Así ves los tokens parecidos uno al lado del otro, y puedes escribir en qué se diferencian mientras los comparas.

Lo que te llevas

  • La descripción de cada token dice para qué sirve; el registro de decisiones dice por qué el sistema es así.
  • Todos los semánticos llevan descripción, y las excepciones y los tokens sin uso, también su motivo.
  • La documentación vive al lado del sistema, en una página del archivo de Figma o junto a los tokens en el repositorio.

Fuentes