SuperAPI AI 工具集

pflow-glossary

通用与其它

查看项目

更新于 10-15 21:40

技能介绍

用途:创建或扩展项目根目录的 GLOSSARY.md,把项目专有概念整理为规范术语表。文件只含一个 H1、可选的 H2 分组标题和表格,没有引言或备注。表格列为 Term(文档语言中的规范名称,单数,纯文本)、Code(代码中使用的标识符,始终为英文并用反引号包裹,未出现在代码中时为 —)、Definition(文档语言中的一句话定义,须能替换句子中的术语,不以术语开头,不用“is when”式表述)、Avoid(代码和文档中禁用的同义词,逗号分隔,无则为 —)。

主要能力:审计并读取现有术语表,扫描 README 和文档收集领域名词与同义词簇(如 Customer/Client/Account、Order/Purchase);只纳入项目专有概念,跳过字典或语言已定义的词;不读取整个代码库。通过一次 AskUserQuestion 确认每个同义词簇的规范名称、超出范围的候选以及用户指定术语中的歧义。

使用方式:先运行 .agents/skills/pflow-glossary/scripts/glossary-context.sh 获取术语表路径、格式、行数、扫描文件数和标识符计数;再用一次非交互 Bash 调用通过带引号的 heredoc 写入:.agents/skills/pflow-glossary/scripts/glossary-finalize.sh --overwrite <<'PFLOW_GLOSSARY_EOF' 后接完整术语表 Markdown,再以 PFLOW_GLOSSARY_EOF 结束。仅在步骤 2 读取过现有文件时才传 --overwrite;仅在用户指定位置时才传 --path <file>;用户不需要 AGENTS.md/CLAUDE.md 规则时传 --agents none。若 glossary-context.sh 或 glossary-finalize.sh 失败(非零退出或 JSON 中 status 为 error),打印 ⚠️ <error.message> 并停止;但 finalize 的 lint 错误例外,修复指定行后重试,最多 3 次。需修复每个警告(循环、过长、格式)并重新运行。

适用场景与限制:适用于为项目建立统一术语和禁止同义词。规则上,Avoid 中的词不能再作为 Term,脚本会拒绝;标识符计数只是同义词线索,并非术语列表;现有其他布局(卡片、列表)的术语表会被转换为表格并保留所有术语。报告需说明新增或变更的术语、AGENTS.md/CLAUDE.md 结果以及被排除的候选和原因,且不要回显文件内容。收费、平台、效果等信息暂未提供。