跳转到内容

结构

design system 的文档由一组条目(entry)组成,每个条目的内容是一串分节(section)。这套结构来自 DSDS 的文档模型;DSDS 用 YAML 来写,这里用 Markdown 页面来写。

条目 记录什么
系统 design system 整体:用途、使用者、怎样安装
Token 一个或一组 design token 的用途和用法。值留在 token 文件里
主题 一组有名字的 token 覆盖值,例如暗色主题
组件 一个可复用的界面部件
其他条目 其余所有内容:基础(例如颜色、排版)、组合多个组件的模式、指南

条目之间互相链接。对话框用到按钮,按钮用到颜色 token,弹出框可以列为对话框的替代方案。把这些关系写下来,读者可以顺着链接看下去,工具也能找出一处修改会影响到哪些地方。

每个条目都由分节组成,任何条目都可以用任何一种分节。

分节 内容
定义 术语和它们的含义
准则 使用规则,每条带要求级别。见准则
步骤 有先后顺序的操作,例如安装一个包
一般分节 放不进其他类型的文字

DSDS 给每个分节标明读者:人、agent,或者两者。默认写给人看,agent 也会读。只有当 agent 反复犯某个人不会犯的错时,才单独加一节写给 agent,例如用 div 拼出一个按钮。

  • 这套系统用来做什么,服务哪个产品
  • 怎样安装,导出了哪些文件
  • 它的基础:token、主题、排版、无障碍规则
  • 指向它的组件、模式和指南的链接
  • 当前版本和变更记录的链接

DSDS 概览,其中介绍了条目、分节和读者。