SuperAPI AI 工具集

technical-writing-for-designers

设计与创作

查看项目

更新于 10-16 05:06

技能介绍

用途:面向设计师的技术写作,聚焦三类产出——设计文档、组件规格、设计决策记录(DDR),让工程、产品等技术受众能准确理解并实现设计意图。

主要能力:提供组件文档的结构模板,包含 Purpose(一句话说明解决的问题)、When to Use(具体使用场景)、When NOT to Use(常见误用及替代方案)、Props/API 表格(Prop、Type、Default、Description)、States(Default、Hover、Active、Focus、Disabled、Loading、Error)、Accessibility(ARIA 角色与属性、键盘行为、屏幕阅读器预期)以及常见用法的代码示例。另提供 DDR 模板,包含编号与标题、日期、状态(Accepted / Proposed / Deprecated)、Context(触发决策的情境)、Decision(决定内容)、Alternatives Considered(备选方案及被否原因)、Consequences(影响与后果)。

使用方式:按模板逐项填写,组件文档以组件名为标题,先写用途与适用/不适用场景,再列 API 与状态,最后补无障碍与示例;DDR 按编号顺序记录,标注日期与状态,说明背景、决定、备选与后果。资料未提供具体安装命令或工具集成方式。

适用场景:设计系统与组件库文档、跨职能协作中的设计说明、需要留痕的设计决策记录。

限制:资料仅给出模板结构,未提供收费、价格、平台支持、效果数据或完整操作步骤,这些信息暂未提供。