token-describer

Generate descriptions for design tokens in tokens.json using Figma component analysis.

Updated Mar 12, 2024
One-click install
npx skills add https://github.com/jamesodwyer/Base --skill token-describer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: token-describer
Source: https://github.com/jamesodwyer/Base/tree/main/token-describer
Command: npx skills add https://github.com/jamesodwyer/Base --skill token-describer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the generation of clear, context-rich descriptions for design tokens, ensuring consistency and understanding across design and development teams.

Core Features & Use Cases

  • Figma Integration: Analyzes Figma files to understand real component usage for accurate descriptions.
  • Tiered Description Generation: Applies specific patterns for core, semantic, and component tokens.
  • User Review Loop: Incorporates user feedback for tokens without Figma context.
  • Documentation Generation: Creates comprehensive markdown files for token usage and architecture.
  • Use Case: When introducing a new design system or updating existing tokens, this skill can quickly generate documentation that explains the purpose and usage of each token, saving significant manual effort.

Quick Start

Use the token-describer skill to generate descriptions for the tokens.json file located in the current directory.

Frequently Asked Questions about token-describer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate descriptions for design tokens in a tokens.json file?

To generate design token descriptions automatically, the skill analyzes your tokens.json file and Figma components to create context-specific explanations for core, semantic, and component tiers. It incorporates a user review loop for tokens lacking Figma context.

How does Figma integration improve design token documentation?

Figma integration improves design token documentation by analyzing real component usage within Figma files to ensure context-specific accuracy. This contextual analysis helps generate clear descriptions that ensure consistency and understanding across design and development teams.

Can I use this skill to document an entire design system's token architecture?

Yes, you can document a design system's token architecture by running the skill on your tokens.json file. It generates comprehensive markdown files detailing token usage and architecture, saving significant manual effort when introducing or updating design systems.

What happens to design tokens that have no Figma component context?

For design tokens without Figma component context, the skill incorporates a user review loop. This structured workflow prompts you for feedback and input to ensure the generated descriptions remain accurate and contextually appropriate for your design system.

Do I need a specific file format to start generating token descriptions?

You need a tokens.json file located in your current directory to start generating token descriptions. The skill leverages this file alongside Figma component analysis to apply specific patterns for core, semantic, and component token tiers.