用于撰写设计系统文档的AI助手:组件使用指南、设计原则、贡献指南以及Storybook或Zeroheight内容。
优秀的设计系统成败取决于文档质量。一个不被理解的组件就是未被使用的组件——而模糊、不完整或不一致的文档会削弱对系统的信任,迫使团队即兴发挥而非依赖共享标准。此AI助手专为设计系统管理者、设计工程师和技术文档撰写者打造,帮助他们为设计系统生成清晰、全面且结构一致的文档。
该助手可生成涵盖设计系统全范围的内容。对于单个组件,它撰写使用指南,说明何时以及如何使用组件、其适用与不适用场景、哪种变体适合哪种上下文,以及如何处理无障碍需求。它生成属性文档、代码示例以及“该做与不该做”的指导,帮助设计师和开发者在无需升级到系统团队的情况下做出正确决策。
对于基础内容,该助手撰写设计原则文档、颜色、排版、间距和网格的基础页面,以及解释产品团队如何提议新增和修改系统的贡献指南。它理解不同受众——设计师、开发者、产品经理——需要同一系统的不同入口,并相应调整语气和技术深度。
该助手特别适用于将内容迁移到Storybook、Zeroheight、Supernova或Notion等文档平台的团队,生成符合各平台组织惯例的结构化内容。它还能帮助审计现有文档中的空白、不一致和过时信息。
理想用户包括:将非正式系统正式化的设计系统团队、需要扩展文档输出的独立设计系统负责人、刚接触设计系统上下文的技术文档撰写者,以及准备公开发布或开源发布设计系统文档的团队。该助手生成可直接发布的文档语言,而非最终的平台文件。