Clarity Design命名规范

转自Clarity Design
至于为什么用-而不用_,请移步这里:连接复合词成分

公约

设计师给开发者提供的资源的命名应该是清晰、准确、分门别类的,以最大程度地让开发者更高效的使用资源。因此,此公约应作为约束,统一各个端的开发者与设计师的资源名使用,尽量不让开发者对资源进行二次命名修改。


范围

  • Web 前端资源的文件名
  • Android 资源的文件名
  • iOS 资源的文件名
  • Sketch 图层命名

Sketch 的图层命名

在使用类似 Sketch 等工具进行设计时,图层名称请使用本公约的相关规范进行命名,## 文件与图层名规范请保持一致,以便更方便地导出资源。在 Sketch 中,不需要导出的 Symbol 可以使用「/」来分隔以分组。需要导出的资源务必使用下方提供的命名方式。


使用全称

我们在命名中应该尽量不要使用简称。减少语义上的偏差,例如有的人习惯称 icon 为 icn,而有些则习惯使用 ico,为了减低大家的沟通成本,应最大程度避免使用 button -> btn,background -> bg。


使用连字符 (-)

https://en.wikipedia.org/wiki/Hyphen

命名时使用 (-) 作为资源名区块连接符号。(-) 符号较容易被辨识,并且通常比其他连接符号更加节约空间。


使用小写英文

所有资源的命名都应该使用小写的英文命名,尤其是在资源上传至服务器后,如果使用有大写字母的文件名,将会导致维护成本的增加。统一地使用小写,将降低后期维护的成本。注意,请不要使用任何拼音。


格式

常规的资源文件类型有:.jpg / .png / .svg / .gif / .tif / .pdf / .md / .ico / .ttf / .wof / .otf

导出素材命名规范

Web:
[type]-[location]-[usage]-[annotation*repeatable]-[state].png
[类型]-[位置]-[用途]-[备注*可重复]-[状态].png
icon-sidebar-navigation-link-normal.png

iOS:
[type]-[location]-[usage]-[annotation*repeatable]-[state]@[resolution].png
[类型]-[位置]-[用途]-[状态]-[备注*可重复]@[分辨率].png
icon-sidebar-navigation-link-normal@2x.png

Android:
[drawable目录]/[type]-[location]-[usage]-[annotation*repeatable]-[state].png
[类型]-[位置]-[用途]-[状态]-[备注*可重复].png
drawable-hdpi/icon-sidebar-navigation-link-normal.png

SKETCH图层:
icon-sidebar-navigation-link-normal@2x

[type](必填)

当前资源的类型,例如 icon、button、image、avatar。

[location]

当前资源使用到的位置,如特定只能用在底部的按钮:button-footer.png

[usage]

当前资源用途,如作为链接使用的图标:icon-link.png

[annotation]

当前资源的备注,此项可重复,如果遇到描述不清楚或不足够的状态,可以添加单个或 多个 备注,如:icon-link-grey.png 、avatar-link-middle.png 或是 button-frame-gray-small.png。

[state]

当前资源的状态。如: button-icon-danger-normal.png

[resolution]

如果表示资源大、中、小三个大小。请在[annotation]中描述,这里仅在 iOS 和 Sketch 图层中使用。


名词处理

当 [location] 或是 [usage] 等非备注内容所使用的名词非单个单词为短语时。允许使用## 「_」进行分隔。如:

Web:
[type]-[location_words]-[usage_words]-[annotation*repeatable]-[state].png
[类型]-[位置]-[用途]-[备注*可重复]-[状态].png
icon-official_website-navigation_bar-link-normal.png

补充阅读

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,734评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,931评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,133评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,532评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,585评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,462评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,262评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,153评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,587评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,792评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,919评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,635评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,237评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,855评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,983评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,048评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,864评论 2 354

推荐阅读更多精彩内容