SuperAPI AI 工具集

english-writing-quality

写作与研究

查看项目

更新于 10-15 22:15

技能介绍

用途:在英文 Markdown 文档、README、技能文本或面向用户的仓库文档需要超出 Markdown 结构检查的质量把关时使用本技能。

主要能力:用 Vale 检查技术文档风格、术语、重复词以及未来仓库专属写作规则;用 Harper 做本地/离线语法、拼写、标点与表层行文建议;对误报进行分诊;并注意日英混合文档的注意事项。

使用方式:先判断该场景需要哪类质量检查,再运行工具。将检查结果视为评审证据而非自动修改,只修复能提升清晰度且不改变技术含义的问题。记录误报与词汇缺口,以便后续调整 Vale 规则或 Harper 词典,再考虑 CI 强制执行。具体命令、示例与解读指引见其 Vale And Harper 部分。

限制:不适用于 AI 检测器或人化改写、内容生成、改变技术含义的改写,也不能替代作者判断。若 Vale 提示配置缺失,确认 Home Manager 已从 config/vale/.vale.ini 链接 ~/.vale.ini,或传入 --config ~/.vale.ini;不要仅为让全局检查生效而在仓库根目录添加 .vale.ini。若 Harper 报告未知技术术语,应视为词典候选,而非直接改写标识符或产品名。