SuperAPI AI 工具集

style-audit

通用与其它

查看项目

更新于 10-16 06:24

技能介绍

用途:style-audit 是项目本地的写作审计工具,用于审查产品文案(技能、参考文档、README、规则)的表达风格。它属于判断层,负责发现脚本无法识别的问题,例如没有在同句解释的生造标签、由外来材料生造的名词、产品文案中的流程痕迹。

主要能力:依据规则文件审计。plain-language.md 要求使用日常词汇而非术语,判断标准是项目外读者无需查资料即可理解;生造标签和比喻首次出现时必须在同一句中解释;外来材料要用自己的话描述,不能音译成自造名词。punctuation.md 规定正文不使用分号,由脚本检查,人工抽查即可。内容纪律要求产品文案不出现来源引用、仓库致谢、流程痕迹和生造比喻。

使用方式:默认审查变更文件(git diff --name-only),也可按要求审查全部 skills/、rules/、README*。.zh-CN 翻译适用同样标准。每条发现需给出术语或句子、引用行、失败原因(一句话)和具体修改建议(平实改写或同句解释,含确切措辞)。修复落地且术语完全清除后,将其追加到 scripts/check-style.sh 的 BANNED 中,若两个技术栈都出现则都要追加。提交前运行 bash scripts/check-style.sh 并确认通过。

适用场景:适合维护产品文档、技能说明和规则文件的项目,在提交前做风格把关。

限制:该技能是项目本地工具,不随产品发布;脚本层只识别已审计发现过的禁用词和分号,无法发现新问题;应偏向沉默,只报告外部读者真正会卡住的内容,已就地解释的术语、行业标准词汇(API、spec、TDD、AARRR)以及技能或产品名称不算问题。其他细节暂未提供。