按团队需求定制「组件文档编写」Skill:可调参数与改写示例
把「组件文档编写」交给智能体,难点不在模型能力,而在流程是否说清楚:输入是什么(组件代码),按什么顺序处理,交付什么(示例文件),哪些事不能做。Skill 就是把这些写下来的载体。
通用版的「组件文档编写」能覆盖大多数情况,但每个团队都有自己的习惯。下面列出最值得调整的几个地方。
可调参数一览
| 参数 | 默认 | 可以怎么改 |
|---|---|---|
| 输出格式 | 示例文件 | 改成团队模板、表格或固定小标题 |
| 详略程度 | 适中 | 给领导看的精简版 / 给执行者看的详细版 |
| 语气风格 | 中性 | 按团队文风、对外或对内调整 |
| 严格程度 | 标注不确定项 | 提高到“任何推断都要给依据” |
| 步骤 | 4 步 | 增加团队特有的检查步骤 |
改写示例:description
通用版:
为组件编写 Storybook 示例与说明。当用户提到组件文档编写时使用。
团队版(示意):
按本团队规范进行组件文档编写:先读取 reference.md 中的模板与术语表,再处理组件代码。当团队成员提到组件文档编写或上传相关材料时使用。
改写示例:增加团队步骤
## 步骤
1. 列出组件状态
2. 为每个状态写示例
3. 补充参数说明
4. 检查渲染
5. 对照 reference.md 中的团队检查表逐项确认
6. 按团队模板输出,并在开头写一句结论
按角色出多个版本
同一个技能可以为不同角色准备变体:新人版写得更细,并解释每一步的理由;熟手版只保留关键检查点。也可以在一个技能里用参数区分,例如“简版/详版”。
定制时别丢掉的东西
- 领域底线:视觉与交互结果要在真实浏览器里确认
- 缺信息先提问
- 需人工确认清单
- 风险较低,但输出仍需快速过目再使用
交付物结构示例
建议把示例文件固定成下面的结构(示意),方便复核与归档:
## 结论
一句话说明最重要的发现或结果
## 主要内容
- 列出组件状态:……
- 为每个状态写示例:……
- 补充参数说明:……
- 检查渲染:……
## 依据
- 引用输入中的具体位置或数据
## 需人工确认
- ……(没有则写“无”)
结构固定之后,复核的人只要先看“结论”和“需人工确认”两部分,就能快速判断结果能否使用。
平台选择建议
同一个「组件文档编写」技能可以落在不同平台上,选择时主要看你在哪里工作、要不要执行代码、要不要接外部系统:
- Cline Rules:Cline 支持在项目中用
.clinerules写规则(可以是单个文件。详见Cline Rules 版 - LangChain / LangGraph 工具:LangChain 用 @tool 装饰器把函数变成工具。详见LangChain / LangGraph 工具 版
- Claude Code Skill:Claude Code 的 Agent Skills 以文件夹为单位:一个 SKILL.md(YAML 头写 name 与 description)加上可选的脚本和参考资料。智能体平时只看到 description。详见Claude Code Skill 版
这个技能纯指令型,不需要额外脚本或外部连接,复制到大多数平台都能用,可据此排除不支持相应能力的平台。
延伸阅读
- 组件文档编写 · MCP 服务 版
- 组件文档编写 · n8n AI Agent 版
- 组件文档编写 · 快速上手
- 深色模式适配 · 定制指南
- 接口调用层生成 · 定制指南
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。