Skip to main content

🤓 Document and annotate design token enhancements

Today we have basic documentation features in the plugin by using the annotate feature to create static documentation, or apply documentation tokens for "living" docs. The community would like to see some improvements:

  • The annotation feature access point isn't obvious

    • It's not well documented on how to find it or how to use it

  • The annotation feature places the output far away when the design element selected to annotate lives within a parent frame/group/container.

  • Expand the data available as a documentation token/living docs

    • Theme name

    • Token type

  • Explore ways to bulk document tokens instead of one token property at a time

  • The formatting of documentation token values is hard to read (for humans, not machines) and could use a visual treatment, especially for composite tokens and tokens with values that are complex (math, gradients with references, etc).

😬 The reality

3rd party tools like Eightshapes Specs do a great job at documenting most of our tokens but it is a paid feature and it doesn't capture composite tokens.

  • This is static documentation

The automator script does a great job at bulk creating documentation (living) but it can be complex to use.

💭 How might we...

Reimagine the way we create documentation for design tokens in Figma that reduces the need for manual updates in an automated way?

💬 Feedback that is valuable

  • How does this issue impact your day-to-day workflow?

  • What workarounds do you have?

↔ Related topics

  • TBD → Jump to post

Status: 💡 Requests3 comments

Log in to comment and vote

Comments3

  • Keegan (Tokens Studio)

    •

    Feb 21, 2025

    Expose ALL data in Shared Plugin Data

    OP is using Eightshapes Specs Pro, to speed up annotation and dev hand-off, but it can’t return all the parameters from TS because they’re not ALL exposed.

    This means days or weeks of manual work-arounds so devs can inspect ALL the TS values applied to each component.

    Eightshapes Specs Pro would be super-helpful if it had access to these attributes through the Shared Plugin Data:

    • TS Name (has)

    • TS Raw value (doesn’t have)

    • TS Value (has)

    • TS Description (doesn’t have?)

  • Keegan (Tokens Studio)

    •

    May 6, 2024

    Github Issue:

    • #2064 Format Documentation Token Values #2064

  • Sam - Tokens Studio

    •

    Apr 4, 2024

    Github Issues