mcpField
D
decision-documentation

decision-documentation

github.com/owl-listener设计与 UI10874 次安装20 周前更新
代码仓库

关于 decision-documentation

用于记录无障碍设计决策及其理由的技能,适合希望团队持续理解决策背景的设计与产品团队。它采用结构化记录,涵盖替代方案、影响、取舍和证据,帮助后续团队了解决策依据。

主要功能

  1. 01记录决策背景与具体内容
  2. 02列出备选方案及否决理由
  3. 03说明无障碍影响和风险取舍
  4. 04附上研究、测试或标准证据
  5. 05提供决策文档评估问题

适用场景

  1. 01记录表单验证等无障碍设计选择
  2. 02向新团队成员说明既有实现原因
  3. 03为设计系统或代码库维护决策记录

安装

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

$npx skills add https://github.com/owl-listener/inclusive-design-skills --skill decision-documentation

安装后在 Claude Code 中输入/decision-documentation确认已加载。

详细介绍

无障碍决策文档

记录无障碍决策,让未来的团队不仅了解决定了什么,也了解为什么这样决定——避免因无人记得缘由而推翻正确决策。

为什么这很重要

无障碍障碍会在重新设计、框架更新、人员变动和紧迫的截止期限中悄然累积。最常见的原因不是恶意或无知,而是新团队成员不了解某项设计的缘由,就擅自改动。

文档是免疫系统。它能保护正确的决策,避免被当时不在场的人推翻。

决策记录格式

对于每项重要的无障碍决策,请记录:

标题

清晰且便于搜索的名称。 “表单验证:使用内联错误提示,而非摘要横幅”

日期和作者

决策时间及决策者。

背景

是什么情况促成了这项决策?有哪些限制条件? “在用户测试中,5 名认知障碍参与者中有 3 名没有注意到页面顶部的错误摘要横幅。他们修正了各个字段,却没有向上滚动查看横幅,因此不知道表单尚未提交。”

决策

具体说明做出了什么决定。 “所有表单验证错误都将直接显示在需要修正的字段下方。移除错误摘要横幅。通过每个字段上的 aria-describedby 向屏幕阅读器播报错误。”

考虑过的替代方案

评估了哪些其他选项,以及为何予以否决。 “我们考虑过在保留内联错误提示的同时保留摘要横幅,但测试显示这会造成困惑——用户不知道应该以哪种错误提示为准。”

无障碍影响

哪些人会受益,以及如何受益。 “认知障碍用户受益(无需记住哪些字段有错误),屏幕阅读器用户受益(在相关内容处播报错误),所有用户也都受益(更快修正错误)。”

风险与权衡

可能出现的问题或为此做出的取舍。 “如果表单中有很多错误,用户会在逐个浏览字段时依次看到错误,而不是一次看到所有错误。对于较长的表单,这可能意味着需要更多滚动。我们接受这一取舍,因为测试表明,具有上下文的错误提示能带来更高的修正率。”

证据

支持这项决策的研究、测试或标准。 “2024-03-15 用户测试(5 名参与者,其中 3 名有认知障碍)。WCAG 2.2 SC 3.3.1(错误识别)。”

何时记录

在以下情况下记录决策:

  • 你在两种或更多种无障碍方案中做出了选择
  • 你做出了一项取舍,以牺牲某个方面的无障碍性来改善另一方面
  • 你决定不修复某项内容(并记录原因)
  • 你基于合理原因采用了不同于 WCAG 技术的实现方式
  • 专门出于无障碍原因选择了某种设计模式
  • 用户测试揭示了无障碍方面的新发现,并因此改变了方向

存储位置

  • 与代码一起存放在代码库中(首选——随实现一同留存)
  • 存放在共享决策日志中(wiki、Notion、Confluence)
  • 存放在设计系统文档中(适用于系统级决策)
  • 切勿只留在某人的脑海中或 Slack 讨论串里

评估问题

  1. 无障碍决策是否连同其理由一起记录?
  2. 新团队成员能否查明某项内容为何采用特定方式构建?
  3. 是否明确记录了各种权衡?
  4. 文档是否存放在不易丢失的地方?

评论

支持 Markdown