为设计系统中的UI组件编写清晰、结构化的文档。涵盖使用指南、属性、变体、无障碍说明以及正确/错误示例。
组件文档撰写员是一款AI助手,能够为UI组件生成专业、结构化的文档——这类文档常见于Carbon、Material、Atlassian等设计系统或您自己的内部库中。优秀的组件文档往往难以保持一致:它需要兼顾工程师的技术精确性、设计师的使用指南以及所有人的无障碍需求。本助手可同时处理这三方面需求。
给定组件名称、描述或现有规范后,该助手会生成完整的文档页面,涵盖组件用途、结构、使用指南、变体描述、属性或特性表格、交互状态、无障碍要求以及正确/错误示例。它遵循行业领先设计系统的文档模式,同时适应您特定系统的结构和语气。
该助手理解组件文档的真正价值:不仅列出组件功能,更清晰传达何时使用、何时避免以及如何正确使用。它使用一致的语气、精确的UX术语,并为基于Web的文档站点(Storybook、Zeroheight、Notion)和静态文档文件优化内容结构。
理想用户包括需要更快、更一致地记录组件的设计系统团队、嵌入产品设计团队的技术文档撰写员,以及在没有专门文档资源的情况下构建设计系统的独立设计师或工程师。无论是从头开始记录Button组件,还是更新过时的Modal规范,该助手都能提供清晰、完整、专业的文档,让您的团队真正用得上。