用扣子(Coze)实现「组件文档编写」:人设、工作流与发布
前端工程师经常要做「组件文档编写」这类事:为组件编写 Storybook 示例与说明。每次都从头写提示词,结果时好时坏;把它做成智能体 Skill,就能让智能体每次按同一套步骤执行,输出结构也更稳定。
本文介绍如何在 扣子(Coze)智能体与工作流 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | 组件文档编写(storybook-writer) |
| 作用 | 为组件编写 Storybook 示例与说明 |
| 输入 | 组件代码 |
| 输出 | 示例文件 |
| 形态 | 纯提示词 |
| 风险 | 低 |
| 适用人群 | 前端工程师 |
处理流程分四步:
- 列出组件状态
- 为每个状态写示例
- 补充参数说明
- 检查渲染
这个技能纯指令型,不需要额外脚本或外部连接,复制到大多数平台都能用;风险较低,但输出仍需快速过目再使用。
在 扣子(Coze)智能体与工作流 中是什么形态
扣子(Coze)是字节跳动推出的智能体开发平台,可以为智能体设置人设与回复逻辑,挂载插件、知识库和工作流,并发布到多个渠道。
国内版与海外版在功能和发布渠道上可能不同,具体以所用版本的官方文档为准。
示例配置
# 扣子(Coze)配置思路示意,界面字段以平台当前版本为准
智能体: 组件文档编写
人设与回复逻辑: 你负责为组件编写 Storybook 示例与说明。收到组件代码后按工作流处理,不确定处要说明。
工作流 storybook_writer:
- 开始: content
- 大模型: 列出组件状态;为每个状态写示例
- 大模型: 补充参数说明;检查渲染
- 结束: 示例文件
知识库: 团队规范与示例(可选)
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在前端工程师提出相关请求时能对上号;二是约束部分要写进「视觉与交互结果要在真实浏览器里确认」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 新建智能体,写好人设与回复逻辑
- 新建工作流,按技能步骤添加大模型、代码、插件节点
- 上传团队规范作为知识库(可选)
- 在调试窗口测试多组输入
- 发布到需要的渠道
实操:一次完整的运行
假设你在浏览器、组件库与设计稿中发出这样的请求(虚构示例):
帮我做一下组件文档编写,材料是附上的组件代码。
智能体识别到任务与「组件文档编写」相关后,会依次列出组件状态、为每个状态写示例、补充参数说明、检查渲染。最终交付示例文件,并在末尾列出需要人工确认的内容。你的工作是对照原始组件代码抽查两三处关键信息,确认无误后再使用。
测试与验收
在调试窗口查看工作流每个节点的运行结果,尤其检查插件返回为空时的处理。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准组件代码,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- 人设写得过于花哨,反而削弱了流程约束。
- 插件授权范围过大。
- 只写了步骤,没写交付格式,导致每次输出的示例文件结构不同。
- 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。
延伸阅读
- 组件文档编写 · Dify 工作流 版
- 组件文档编写 · 快速上手
- 组件文档编写 · 组合用法
- 深色模式适配 · 扣子(Coze)智能体与工作流 版
- 接口调用层生成 · 扣子(Coze)智能体与工作流 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。