技术内容英文写作优化器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/write-good-english-prose-linting-technical-content。
技能介绍
技术文档中的英文写作痛点
技术团队在撰写文档、技术博客或 API 说明时,常面临一个隐蔽但影响显著的问题:英文表达不够清晰。不是语法错误,而是风格问题——句子冗长、用词模糊、被动语态过多、难以阅读。这类问题不会让编译器报错,却会增加读者的理解成本,降低文档的可读性。
工作原理与核心能力
这个技能基于开源工具 write-good,通过预定义的语言规则来检测英文散文中的常见问题:
- 模糊表达:如 "very good"、"extremely important" 等程度副词堆砌
- 冗长句式:如 "in order to" 可简化为 "to"
- 被动语态:过度使用 "was done" 而非主动语态
- 难读结构:过长的句子或从句嵌套
技能的核心工作方式包括:
- 文件扫描:接受 glob 模式匹配,批量处理
.md文件 - 行内标注:在输出中指出具体行号和问题位置
- 规则定制:支持从规则列表中排除特定词条,如将
read-only从only的检查中豁免 - 多语言扩展:通过
schreib-gut可扩展到德语文档检查
适用边界与注意点
这个工具的定位是轻量级风格检查,不是完整的语法检查器:
- 它不会检测拼写错误、主谓一致或时态问题
- 规则基于英文写作最佳实践,可能与团队内部风格指南不完全一致
- 对于技术术语密集的文档,部分规则可能需要豁免
- 输出是建议而非强制修改,需人工判断是否采纳
使用场景
- 维护团队 API 文档库,需批量扫描新增 Markdown 文件,找出模糊或冗长表达
- 技术博客作者写完草稿后,想在发布前检查英文句子是否难读
- CI 流水线中接入写作检查,对合并前的文档自动执行 write-good 提示
- 跨语言项目需要同时检查英文技术文档和德语文档,用 schreib-gut 做风格反馈
适合人员
- 维护 API 文档的开发者:需要快速找出文档中冗余和难读的英文句子
- 技术写作工程师:希望在发布前用轻量检查替代完整语法审校
- 开源项目维护者:需要在 CI 里对贡献者提交的文档做风格反馈
- 内容团队技术编辑:负责批量审阅英文技术博客并定位表达问题