Skip to content

Advanced Features

Demonstrating some advanced features for specific use cases.

UX and Doc Content Alignment

A design system may include protocols for externalizing UI strings. In a tightly coupled content strategy, you may want use these strings in your documentation as well.

In this example, strings are externalized in a JSON file and the Macros plugin extends out to do the rest.

{ 
    "locale": "en-US", 
    "translations": { 
        "user.table.name": "Name", 
        "user.table.address": "Address",
        "user.table.email": "Email",
        "user.table.username": "Username"
    } 
}

In the UI, imagine a user table where teammates can see each other's information on a user table.

In the documentation, the user table needs some conceptual and reference explanation.

User Table

Element Description Editable
Name The user first and last name. ✅
City, State The user city and state. ✅
Email The user email address and unique identifier. Request an email change from your admin. ❌
Username The user selected display name. ✅

Check My Work

Click the at the top of the page ⬆️