Tailwind CSS Academy · درس

توثيق الرموز وحوكمتها

وثّق نظام الرموز، وطبّق اصطلاحات التسمية، وأعدّ عمليات للمراجعة للحفاظ على اتساق الرموز ضمن نظام تصميم آخذ في التوسع.

الدرس 4 من 413 خطوة

توثيق الرموز وحوكمتها درس مجاني في Tailwind CSS Academy على CoddyKit. هذا هو الدرس 4 من أصل 4. يمكنك قراءة الدرس كاملاً أدناه مجاناً — ثم تمرن عليه مباشرة في المتصفح باستخدام محرر أكواد مدمج ومدرس ذكاء اصطناعي متاح 24/7. هذا الدرس جزء من مسار التعلم في Tailwind CSS Academy، وتقدمك يتزامن عبر الويب وتطبيق CoddyKit. تتضمن دورة Tailwind CSS Academy 4 دروس في المجموع.

بعض أجزاء هذا الدرس لم تُترجم بعد وتظهر باللغة الإنجليزية.

Why Token Governance Matters

A design token system without governance quickly becomes chaotic. Without rules, developers add tokens arbitrarily, names become inconsistent, and the system grows unmaintainable. Token governance means establishing clear ownership, naming conventions, change processes, and documentation standards that ensure the token layer remains an asset rather than a liability as the team and codebase grow.

Establishing a Naming Convention

Choose a naming convention and apply it consistently to every token. A widely adopted pattern is category-role-variant — for example color-action-primary, color-action-secondary, color-feedback-error, spacing-layout-section. Document the convention in a dedicated file so every contributor understands what each segment means and where new tokens should be categorized.

/*
  Naming convention: --{category}-{role}-{variant}

  Categories: color, spacing, font, radius, shadow, motion
  Roles: action, surface, text, border, feedback
  Variants: primary, secondary, muted, inverse, hover, active, disabled

  Examples:
  --color-action-primary
  --color-action-primary-hover
  --color-feedback-error
  --color-surface-overlay
  --spacing-layout-section
  --font-heading-weight
*/

Token Categories and Taxonomy

Organize tokens into a clear taxonomy with defined categories. Common categories include color (brand, feedback, neutral), typography (family, size, weight, line-height), spacing (layout, component, inset), radius, shadow, and motion (duration, easing). Having explicit categories makes it easy for designers and developers to find an existing token before creating a new one.

// tokens/taxonomy.js
const TOKEN_CATEGORIES = {
  color: ['brand', 'neutral', 'feedback', 'surface', 'text'],
  typography: ['family', 'size', 'weight', 'lineHeight', 'tracking'],
  spacing: ['layout', 'component', 'inset'],
  shape: ['radius'],
  elevation: ['shadow'],
  motion: ['duration', 'easing']
};

// Validate a new token name
function validateTokenName(name) {
  const [cat] = name.split('-');
  return Object.keys(TOKEN_CATEGORIES).includes(cat);
}

Writing Token Documentation

Each token should have clear documentation covering its purpose, usage examples, and any constraints on where it should or should not be used. Keep this documentation colocated with the token definition — either as comments in the token file or in a dedicated docs site generated from the token files. Automated documentation tools like Style Dictionary can generate HTML references from token JSON files.

// tokens/documented.js
module.exports = {
  'color-action-primary': {
    value: '#3b82f6',
    description: 'Primary interactive action color. Use for buttons, links, and focus rings.',
    usage: ['bg-action-primary', 'text-action-primary', 'border-action-primary'],
    doNot: 'Do not use for decorative elements. Use color-brand-accent instead.'
  },
  'color-feedback-error': {
    value: '#dc2626',
    description: 'Error state color. Use for validation messages and destructive actions.',
    usage: ['text-feedback-error', 'border-feedback-error'],
    doNot: 'Do not use for warnings. Use color-feedback-warning instead.'
  }
};

Change Control Process

Tokens are a shared contract between design and engineering. Changing a token value affects every component that uses it simultaneously. Establish a change control process: proposed changes go through a design review, a developer impact assessment, and a testing phase before merging. Breaking changes — like renaming or deleting a token — require an upgrade guide and a deprecation period to avoid breaking consumer teams.

/* Deprecation example: renaming a token */

/*
  DEPRECATED: --color-primary is deprecated.
  Use --color-action-primary instead.
  Will be removed in v3.0 (target: 2026-09-01)
*/
:root {
  --color-primary: var(--color-action-primary); /* alias */
  --color-action-primary: #3b82f6;              /* canonical */
}

/* Linting rule to warn on deprecated token usage */

Linting Token Usage

Automated linting prevents the accidental introduction of hardcoded values and enforces token usage. Configure eslint-plugin-tailwindcss to warn when arbitrary values like bg-[#3b82f6] are used where a token exists. For CSS files, a custom stylelint rule can flag raw hex values in places where a variable should be used. These automated checks catch drift before it reaches code review.

// .eslintrc.js
module.exports = {
  plugins: ['tailwindcss'],
  rules: {
    'tailwindcss/no-arbitrary-value': 'warn',
    'tailwindcss/classnames-order': 'warn',
    'tailwindcss/no-contradicting-classname': 'error'
  }
};

// .stylelintrc.json
{
  "rules": {
    "color-no-hex": [true, {
      "message": "Use a CSS variable token instead of a raw hex value"
    }]
  }
}

Token Versioning Strategy

Treat your token system like a published API with semantic versioning. Additive changes (new tokens, new values for existing tokens) are minor versions. Breaking changes (renames, deletions, value changes that affect visual appearance) are major versions. Use a CHANGELOG.md for the token package to record every change with its version, affected tokens, and migration instructions for consumers.

// tokens/CHANGELOG.md
/*
  ## v2.1.0 — 2026-06-15
  ### Added
  - color-action-ghost: new ghost button surface color
  - motion-duration-slow: 500ms for large layout transitions

  ## v2.0.0 — 2026-05-01
  ### BREAKING
  - Renamed: --color-primary → --color-action-primary
    Migration: replace all var(--color-primary) with var(--color-action-primary)
  - Removed: --color-accent (unused after brand refresh)
*/

Design-Developer Token Sync

Keeping design tool tokens (Figma variables) synchronized with code tokens is one of the hardest governance challenges. Tools like Token Studio for Figma or Theo can export Figma variables directly to JSON, which can then be transformed into Tailwind config values by a build script. This removes the manual synchronization step and ensures design and code always agree on token values.

// scripts/sync-tokens.js
// Run after exporting tokens from Figma Token Studio
const figmaTokens = require('./tokens/figma-export.json');

const tailwindColors = {};
Object.entries(figmaTokens.color).forEach(([key, token]) => {
  // Convert Figma token format to Tailwind format
  const cssVarName = '--color-' + key.replace(/\./g, '-');
  tailwindColors[key.replace(/\./g, '-')] =
    'var(' + cssVarName + ')';
});

console.log('Synced', Object.keys(tailwindColors).length, 'color tokens');

Token Governance Roles

Effective governance requires clearly defined roles. A Token Steward (usually a senior designer or design systems lead) owns the taxonomy and approves new token proposals. Contributors (designers and developers) submit token change requests through pull requests with a standardized template. Consumers (feature teams) use tokens read-only and submit enhancement requests via a dedicated channel rather than adding tokens directly.

/*
  Token Change Request Template (GitHub PR description)

  ## Token Change Request

  **Type**: [ ] Add  [ ] Modify  [ ] Deprecate  [ ] Remove

  **Token name**: color-action-destructive

  **Proposed value**: #dc2626

  **Rationale**: Needed for delete button component.
  Existing danger token is for form validation only.

  **Impact**: 0 existing usages (new token)

  **Design approval**: @designlead
*/

Auditing Token Coverage

Periodically audit your token coverage to find hardcoded values that escaped the governance process. A coverage report scans all HTML, JSX, and CSS files for raw color values, explicit spacing numbers not using the spacing scale, and arbitrary Tailwind values. High-coverage projects have near-zero hardcoded values; everything routes through a token. Aim for token coverage above 95% on any file that defines visual styling.

// scripts/token-coverage-audit.js
const fs = require('fs');
const glob = require('glob');

const hardcodedColorRegex = /#[0-9a-fA-F]{3,8}|rgb\(|hsl\(/g;
const arbitraryColorRegex = /\[#[0-9a-fA-F]{3,8}\]/g;

const files = glob.sync('src/**/*.{html,jsx,tsx,css}');
let totalViolations = 0;

files.forEach(file => {
  const content = fs.readFileSync(file, 'utf-8');
  const matches = [...(content.match(hardcodedColorRegex) || [])];
  if (matches.length) {
    console.log(file + ':', matches.length, 'violations');
    totalViolations += matches.length;
  }
});

console.log('Total violations:', totalViolations);

Living Documentation With Storybook

The best token documentation is living documentation — examples that are always up to date because they are rendered from the actual tokens in real time. Build a Storybook page that renders a color palette, spacing scale, and typography specimen using the active token values. Because these stories pull from the same CSS variables used in production, they can never fall out of sync with the real token values.

// stories/Tokens/ColorPalette.stories.jsx
const SEMANTIC_COLORS = [
  { name: 'Action Primary', cls: 'bg-action-primary', var: '--color-action-primary' },
  { name: 'Feedback Error', cls: 'bg-feedback-error', var: '--color-feedback-error' },
  { name: 'Surface Base', cls: 'bg-surface-base border', var: '--color-surface-base' }
];

export default { title: 'Design Tokens/Colors' };

export const SemanticPalette = () => (
  <div class="grid grid-cols-3 gap-4 p-6">
    {SEMANTIC_COLORS.map(c => (
      <div key={c.name}>
        <div class={c.cls + ' h-16 rounded-lg mb-2'} />
        <p class="text-sm font-medium">{c.name}</p>
        <code class="text-xs text-gray-500">{c.var}</code>
      </div>
    ))}
  </div>
);

Quick Check

Test your understanding of Tailwind CSS Mastery concepts from this lesson.

Lesson Recap

In this lesson you learned: naming conventions and a clear taxonomy prevent token proliferation, change control processes with deprecation periods manage breaking changes safely, and automated linting and coverage audits enforce token usage across the codebase. Next up we shift into Tailwind with React and Next.js, starting with project setup.

البدء مجانًا

تعلم HTML مع معلم ذكاء اصطناعي — مجانًا

اكتب وقم بتشغيل أكوادك الفعلية في المتصفح، واحصل على مساعدة فورية من معلم ذكاء اصطناعي متاح 24/7، واستمر من حيث توقفت على الويب أو في التطبيق.

الدورات
30
الدروس
120

الأسئلة الشائعة

هل درس «توثيق الرموز وحوكمتها» مجاني؟

نعم — نص درس «توثيق الرموز وحوكمتها» كامل متاح مجاناً هنا على الويب. لتمرينه بشكل تفاعلي (محرر أكواد مدمج ومدرس ذكاء اصطناعي متاح 24/7) وفتح باقي دورة Tailwind CSS Academy، انتقل إلى CoddyKit PRO. تتضمن دورة Tailwind CSS Academy 4 دروس في المجموع.

ماذا ستتعلم في «توثيق الرموز وحوكمتها»؟

وثّق نظام الرموز، وطبّق اصطلاحات التسمية، وأعدّ عمليات للمراجعة للحفاظ على اتساق الرموز ضمن نظام تصميم آخذ في التوسع. تتمرن على Tailwind CSS Academy مع أكواد عملية تشغلها مباشرة في المتصفح، ومدرس ذكاء اصطناعي متاح 24/7 يجيب على أسئلتك أثناء عملك.

هل أحتاج إلى خبرة سابقة لأبدأ Tailwind CSS Academy؟

لا تُشترط خبرة سابقة. Tailwind CSS Academy على CoddyKit منظم للمبتدئين حتى المتقدمين، لذا يمكنك البدء من هنا أو من البداية والتقدم بسرعتك الخاصة. هذا هو الدرس 4 من أصل 4.

كم من الوقت يستغرق درس «توثيق الرموز وحوكمتها»؟

معظم دروس CoddyKit تستغرق حوالي 5–10 دقائق. كل منها موجز وتفاعلي، لذا تحرز تقدماً مستمراً وتستأنف من حيث توقفت عبر الويب والتطبيق.

هل يمكنني كتابة وتشغيل أكواد في درس Tailwind CSS Academy هذا؟

نعم. كل درس في Tailwind CSS Academy يتضمن محرر أكواد مدمج، لذا تكتب وتشغل أكواداً حقيقية مباشرة في متصفحك وتحصل على تعليقات فورية من الذكاء الاصطناعي — بدون إعداد محلي.

جميع الدروس في هذه الدورة

  1. الرموز البدائية مقابل الرموز الدلالية
  2. إنشاء السمات بالاعتماد على متغيرات CSS
  3. استراتيجية السمات متعددة العلامات التجارية
  4. توثيق الرموز وحوكمتها
← العودة إلى Tailwind CSS Academy