组件文档应该记录什么？

用简短说明记录用途、选项、状态和使用边界，让部件不必靠猜。

组件文档是部件的使用说明。它帮助设计、开发和内容人员正确选用部件，并理解什么时候需要另一种方案。

先记住这几件事

• 先写用途和适用条件，再说明结构、可调整选项、状态和例子。
• 默认值 是没有另外设置时采用的选择；默认选择应清楚，重要差异要说明。
• 写清键盘、名称和错误反馈等无障碍要求，让实现人员能检查行为。
• 记录限制、相似部件的区别、维护入口和变更说明，减少重复询问。

用途与上下文的记录见 Figma 资源说明指南 ；组件更新前的管理考虑见 Figma 组件管理建议 。

写说明的流程

文档信息的示意

下面是假设保存按钮的说明。

用一个例子走一遍

新同事要给资料页增加保存操作。文档先说明用途，再告诉他文字可以替换、加载时显示什么、失败提示放在哪里。他照说明完成后，用键盘验证。若不知道为何禁用按钮，维护者补充可用条件，让下一位同事不必再猜。

边界与常见误解

文档不需要一次写成厚手册，但必须能支持正确使用。截图不是全部说明；代码示例也不能代替用途解释。内容要跟着部件变化，过时说明会让使用者继续采用已经不适用的做法。