SuperAPI AI 工具集

ux-writing

写作与研究

查看项目

更新于 10-16 02:28

技能介绍

用途:这是一套面向用户可见文本与文档的判断规则,把用户可见文字视为产品行为,要求与代码同等质量标准。每条规则源自真实评审缺陷,并保留反例说明推理依据。

主要能力与规则要点: 状态与诊断输出:报告生效值而非存储值,按运行时方式解析环境变量与分层配置;失败时诊断须保持真实,某层配置加载失败应回退到仍能加载的最完整状态,不要回退为空默认值;只显示差异项及其来源,完整枚举交给专门的 inspect 命令;按声明粒度标注来源;新增元数据后重读相邻标签。机器可读输出是契约,不得加入装饰、提示或标注,缺失也是契约的一部分,应编写否定测试;不得截断路径、ID、URL。 错误信息:每个错误回答发生了什么、在哪里、现在该做什么;指名问题文件或输入、被拒字段、允许字段及正确位置;大声失败而非静默降级。 文档:每份文档只承担一种职责;理由说明属于独立文体,写在设计记录、ADR 或 PR 中;每个事实只有一个权威出处,其余位置链接;重述加链接是缺陷;优先最小充分编辑;插入内容注意相邻性;形容词需有证据;README 各节各司其职;按读者需要排序,任务不再是单一任务时拆分;提醒只点名最易遗忘项。 易过时事实:不把变化快于文档的值写进长期页面,记录在哪里读取当前答案;指针指向符号而非仓库;文档无法观察运行时。 最终状态:面向未参与对话的读者;说明代码实际行为;注释只承载非显而易见的原因;证据服务于读者决策;交付物不叙述自身生产。 行为变更同步:grep 旧措辞,覆盖 --help 选项字符串、集中消息模块、README 与文档、捆绑技能文件与 MCP 工具描述、路线图或状态说明,并重新解析链接。 测试文案:断言扁平化文本或行为,而非控制台格式;注意颜色环境变量泄漏;机器格式应断言必须缺失的内容。

使用方式与限制:资料未提供具体安装命令、调用方式或运行步骤,仅为规则集合;适用场景为编写与评审 CLI 输出、错误与帮助文本、README、文档及注释等用户可见内容。