mcpField
F
figma-annotation-guide

figma-annotation-guide

github.com/mohitagw15856设计与 UI1.5k48 次安装5 天前更新
代码仓库

关于 figma-annotation-guide

figma-annotation-guide 是为 Figma 屏幕或组件生成开发交接注释的技能,供设计与工程团队描述可实现的界面规范。它涵盖交互状态、布局、无障碍要求和边界问题,并借助 notugly 命令计算颜色对比度。

主要功能

  1. 01整理屏幕或组件概览
  2. 02描述交互及各类状态
  3. 03列出布局与内容规则
  4. 04注释无障碍要求
  5. 05计算并记录颜色对比度

适用场景

  1. 01为 Figma 屏幕编写开发交接说明
  2. 02补全交互元素的错误和空状态
  3. 03核对界面颜色对比度

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/mohitagw15856/pm-claude-skills --skill figma-annotation-guide

安装后在 Claude Code 中输入/figma-annotation-guide确认已加载。

详细介绍

Figma 注释指南技能

为 Figma 屏幕或组件生成一套完整的开发交接注释——将视觉设计转化为可实现的规范。

必需输入

  • 屏幕或组件描述(描述或概述设计内容)
  • 平台(iOS / Android / Web / React Native)
  • 交互类型(静态 / 交互式 / 动画 / 表单)
  • 开发人员受众(移动端 / 前端 / 全栈)

程序化辅助工具

无法凭肉眼判断对比度。AA 标准为 4.5:1,而白色背景上的 #777777 对比度为 4.478(不合格),#767676 为 4.54(合格)——无论怎么看 截图都无法分辨。请计算:

npx --yes notugly fix "#8ab4f8" "#ffffff"     # ratio, APCA, and the nearest passing colour
npx --yes notugly onepager <url> --out review.html   # every pairing, printable
npx --yes notugly vision                      # which colours merge for colour-blind viewers

notugly fix 会返回对比度、APCA 亮度对比度,以及与当前选定颜色最接近 且符合标准的颜色——色相和色度保持不变。请将这些数值填入下方的表格,而不是估算。

运行结果确定、零依赖,而且不会调用模型——因此运行无需花费,且每次结果都相同。

对比度注释应包含计算出的对比度和目标,例如: “4.52:1 — 正文文本符合 AA 标准”。“检查对比度”这样的注释只是任务,而非注释结果。

输出结构

1. 屏幕/组件概览

名称、用途、入口点、出口点。

2. 交互注释

[元素名称]

  • 默认状态:[视觉描述]
  • 点击/轻触时:[确切操作 — API 调用、状态变更、导航]
  • 加载状态:[描述]
  • 成功状态:[后续操作]
  • 错误状态:[错误表现和用户选项]
  • 禁用条件:[禁用时间和原因]
3. 状态清单
元素所需状态
[元素]默认、悬停、激活、禁用、加载、错误、空

标记缺失的设计:“警告:未设计错误状态——实现前必须补充”

4. 间距和布局说明

固定与流式元素、滚动行为、断点、安全区域。

5. 内容和文案规则

字符限制、动态与静态内容、截断规则、空状态。

6. 无障碍注释

触控目标、屏幕阅读器标签、焦点顺序、颜色对比度、动态效果偏好。

7. 边界情况和开发者问题
  • [需要提醒开发者的未解决问题]

质量检查

  • 为每个交互元素定义所有状态
  • 状态清单标记了缺失的设计
  • 无障碍说明涵盖触控目标和屏幕阅读器标签
  • 已说明空状态
  • 将边界情况列为可采取行动的问题

反模式

  • 不要只注释理想情况——必须记录错误、加载和空状态
  • 不要使用“加一些内边距”等模糊的间距描述——请指定确切的像素值或令牌名称
  • 不要省略无障碍注释——必须包含焦点顺序、ARIA 标签和颜色对比度
  • 不要遗漏交互行为描述——每个交互元素都需要记录响应方式
  • 不要遗漏边界情况——开发者需要知道在边界条件下会发生什么

示例触发语句

  • “为这个 Figma 屏幕编写开发注释”
  • “为[屏幕/组件]创建开发交接说明”
  • “为工程团队记录这个设计”
  • “编写[功能]的 Figma 规范”
  • “交接这个设计前,我应该注释哪些内容?”

评论

支持 Markdown