关于 intelligence-vocabulary
intelligence-vocabulary 是用于撰写 CopilotKit Intelligence 客户文档的技能,统一术语,并区分面向客户的文案与代码标识符。
主要功能
- 01统一客户文案的术语
- 02搜索并替换禁用说法
- 03保留代码标识符和路径段
- 04新页面与文档技能协同
- 05Inspector 步骤使用界面标签
适用场景
- 01编辑 Intelligence 文档
- 02检查导航和按钮标签
- 03新增或重命名 Intelligence 页面
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ copilotkit/ copilotkit --skill intelligence-vocabulary安装后在 Claude Code 中输入/intelligence-vocabulary确认已加载。
附带文件references/words.md
详细介绍
智能词汇表
面向客户的智能文档对每个概念只使用一个名称。同一事物出现第二个名称即为回归。
何时使用
在撰写或编辑客户会阅读的关于 CopilotKit Intelligence 的文字之前,加载此技能。这包括 showcase/shell-docs 下的页面、片段、导航标题、按钮标签和图片替代文本。
当变更新增、重命名或删除 Intelligence 页面时,也要加载 skills/intelligence-docs/SKILL.md。该技能负责保持落地页同步。本技能负责用词。
不要为了重命名代码而加载此技能。标识符、路由别名、环境变量、API 字段和组件名称保持原样,即使其中出现了停用词。
流程
流程 1:应用词汇表
- 在撰写或编辑面向客户的 Intelligence 文字之前,阅读
references/words.md。 - 对标题、导航标题、按钮标签、替代文本和正文文字,使用 Use 列。
- 套餐名称保持为 Developer、Team、Team Self-hosted 和 Enterprise。
- 如果某个事实在
references/words.md中已有归属页面,请链接到该页面。不要用第二个名称再次解释该事实。 - 使用已发布控件所呈现的标签来撰写 Inspector 点击步骤:Rich Threads 和 Automatic Learning。
流程 2:检查变更
- 在新增或编辑的文字中搜索
references/words.md的 Stop 列中的每个短语。 - 如果命中项被
references/words.md中的例外清单列出,则保留。 - 将其他所有命中项改写为该概念对应的 Use 词。
- 保持标识符、别名、环境变量、API 字段和组件名称不变。
决策树
- 面向客户的 Intelligence 文字、标签或替代文本:流程 1,然后流程 2
- 页面新增、重命名或删除:用本技能处理用词,用
skills/intelligence-docs/SKILL.md处理落地页 - 唯一的编辑是代码、别名、环境变量或 API 字段:停止。不要为了匹配词汇表而重命名它
- 页面未提及 Intelligence:停止
危险信号
| 信号 | 含义 | 应改为 |
|---|---|---|
| 同一页面上同一概念出现两个名称 | 跳过了词汇表 | 流程 2 |
| 用 "managed" 或 "hosted" 作为 CopilotKit 运营的部署的名称 | 部署名称发生了漂移 | 写作 cloud-hosted |
| 通过重命名组件、别名或环境变量去掉了停用词 | 将该技能应用到了代码上 | 恢复该标识符。只更改客户文字 |
| 在客户页面中添加了 Clerk 或发布截止时间 | 泄露了内部实现 | 删除该句子。说明客户做什么 |
错误处理
- 停用短语位于标识符内部: 保留该标识符。仅当周围文字将停用词用作面向客户的名称时,才更改周围文字。
- 命中项在例外清单上: 保留它。不要 "修正" managed Channel、customer-managed、托管区、工单 id 或套餐名称。
- 批准的词与可见的产品标签不一致: 对于点击步骤,使用已发布控件所呈现的标签。记录该冲突。不要发明第三个名称。
- 新事实没有归属页面: 停止并指出缺失的页面。不要用新的同义词将该事实暂放在附近的页面下。
评论
支持 Markdown