乐于分享
好东西不私藏

专治 AI 技术文档 “空话泛滥、歧义难懂”,程序员文档生产力利器

专治 AI 技术文档 “空话泛滥、歧义难懂”,程序员文档生产力利器

写 API 文档、报错文案、运维手册、Release Notes 还在忍受 AI 输出空话套话、长难句堆砌、模糊模棱两可的 “LinkedIn 风废话”?AminBlg 开源项目 SimpleEnglish 直接把航空业 40 年成熟工业标准 ASD-STE100 植入 AI,强制大模型输出零歧义、极简、可落地的标准化技术英文,彻底根除 AI 写作通病,完美适配 Cursor、Claude Code、Copilot、Gemini 等全系列 AI 编程工具。

源代码:

https://github.com/AminBlg/SimpleEnglish

一、核心功能:基于航空工业标准的 AI 写作约束技能
SimpleEnglish 是一套遵循ASD-STE100 简化技术英语规范的跨 Agent 通用 Skill 插件,核心由标准化规则库、多场景适配模板、自动化校验基准三部分组成:
  1. 53 条强制可落地写作规则

    严格限制句式、时态、语态、词汇,核心硬约束:单句指令≤20 词、描述句≤25 词;仅允许简单时态、主动语态;禁用模糊情态词 should/may/might;一词一义、一条指令一句话;条件前置,杜绝后置歧义从句;禁止空洞营销词汇(seamlessly、holistic 等 AI 高频空话)。

  2. 多开发场景专属适配模板

    内置程序员高频写作场景规则集:报错信息、运维 Runbook、故障复盘报告、版本更新日志、代码注释、AI 系统提示词、多语言翻译预处理,自动匹配对应行文逻辑(例如报错强制顺序:故障现象→根因→修复步骤)。

  3. 跨全平台 AI Agent 兼容

    遵循通用 Agent Skill 标准,一键适配 25 + 主流编码工具:Claude Code、Cursor、VS Code Copilot、Codex、Gemini CLI、OpenCode;无原生 Skill 支持的 GPT、网页版 Claude 也可复制提示词直接使用。

  4. 量化校验基准 + TDD 验证体系

    内置完整评测脚本,覆盖 6 大模型、8 类写作任务共 96 组对照实验;加载技能后文本 STE 规范违规率平均下降 72.9%,输出 Token 同步缩减,句子平均长度从 11.2 词压缩至 9.7 词,自带 Regex 静态校验规则,结果可复现、可量化。

  5. 双模式切换

    • 实用模式:执行核心结构规则,保留行业专业术语,日常写文档首选;

    • 严格模式:贴近航空官方认证标准,适合硬件、工业、医疗、军工高严谨性文档。

二、能帮程序员解决什么实际问题?

1. 彻底消除 AI 文档歧义,减少用户咨询成本

AI 原生输出充斥模糊、委婉、冗长句式,比如It should be noted that permission issues may cause upload failure,工具自动改写为直白主动句Set correct AWS credentials. Wrong credentials stop S3 upload,运维、前端、海外客户一眼看懂,大幅降低线上答疑工单量。

2. 大幅缩减文档校对、重写工时

不用逐段删减 AI 空话、拆分长难句、修正被动语态;插件自动完成标准化改写,原本 1 小时校对的 Release Notes,5 分钟就能定稿,单人文档效率提升 60% 以上。

3. 统一团队英文文档规范,降低协作沟通成本

团队成员英文水平参差不齐,文档风格混乱;接入 SimpleEnglish 后,所有人的 API 手册、注释、故障报告遵循同一套工业标准,新人接手项目无需反复理解晦涩文档。

4. 降低国际化翻译成本,适配海外业务

STE 标准原生为多语言本地化设计,句式简单、词汇固定,机器翻译准确率大幅提升,减少人工译后修正工作量,适合出海产品、开源项目英文文档。

5. 规范 AI 系统提示词,优化代码 Agent 行为

给 Superpowers、各类代码助手的 AGENTS.md 系统提示词做标准化,删除模糊的 should/may 等不确定词汇,AI 执行流程更稳定,减少执行偏差、幻觉问题。

6. 规范报错日志,快速定位线上故障

自动结构化错误文案,抛弃 “something went wrong” 这类无用话术,直接输出明确故障点与修复指令,排查线上 Bug 速度显著加快。

三、直击当前 AI 技术写作的行业痛点
  1. 通用提示词 “写清晰” 无量化标准,AI 无法稳定执行

    只靠一句 “简洁清晰” 约束 AI 是主观要求,模型理解飘忽;而 SimpleEnglish 依托航空工业 53 条可检测硬规则,每条都有明确边界,AI 不存在自由发挥空间,效果稳定可复现。

  2. LLM 天生偏好冗长书面空话,技术文档可读性极差

    大模型训练数据充斥商业软文、学术套话,默认输出堆砌高级虚词、超长复合句、被动语态,技术人员阅读、客户理解门槛极高,人工改写耗时巨大。

  3. 缺少跨 AI 工具通用技术英文标准化方案

    市面上规范写作的 Prompt、插件大多仅适配单一工具,换 Cursor、Claude、Copilot 就要重新配置;SimpleEnglish 一套 Skill 通吃几乎所有主流代码 Agent。

  4. 高严谨行业无低成本 AI 写作合规方案

    硬件、嵌入式、医疗、军工、轨道交通等领域对操作手册、故障报告歧义零容忍,商用 STE 校验工具收费昂贵,而本项目 MIT 开源免费,轻量化无依赖。

  5. 团队文档无统一规范,代码注释、API 文档风格割裂

    企业缺少统一英文写作规范,程序员注释有的极简、有的晦涩,海外客户阅读体验两极分化,没有自动化统一工具。

四、填补行业空白:

市面上同类工具无法替代的核心优势

  1. 唯一落地航空级工业受控语言的开源 AI Skill

    市面上仅有零散 “简洁英文” 提示词模板,无完整标准化规则库、评测体系、多场景适配;SimpleEnglish 完整落地 40 年成熟 ASD-STE100 官方标准,对照原版手册逐条校准规则,无错误臆造条款。

  2. 轻量化无依赖,全渠道零门槛兼容

    仅 Python 脚本 + 纯文本规则文件,无需复杂部署;支持终端一键安装、网页端复制提示词、IDE 插件三种使用方式,不占用本地资源,小设备也能运行。

  3. 和 Superpowers 等 AI 开发生态完美互补

    Superpowers 约束 AI 编码工程流程,SimpleEnglish 约束文档、注释、提示词语言规范,二者搭配实现 “代码规范 + 文档规范” 双闭环,完整解决 AI 开发全链路产出质量问题。

  4. 开源免费可二次定制行业词汇

    商用 STE 校对软件年费高昂,本项目 MIT 协议开放源码,开发者可自定义行业专属术语词典(后端数据库、嵌入式硬件、医疗设备专业词汇),适配垂直业务场景。

  5. 自带量化评测工具,效果可验证

    绝大多数写作 Prompt 无法量化优化效果,该项目提供完整基准测试脚本,可自行跑数据对比优化前后违规率,方便团队落地验收。

五、普通人 / 程序员极简上手教程(3 种渠道全覆盖)

方式 2:Claude 网页端(付费版)

  1. 下载仓库SKILL.md文件本地保存;

  2. claude.ai → 设置 → 自定义 → Skills,上传文件并启用;

  3. 输入需求时自动标准化英文输出,也可手动指令rewrite this with simple-english重写已有文本。

方式 3:ChatGPT、通用网页 AI(无 Skill 能力)

复制仓库prompts/system-prompt.md全部内容,粘贴到自定义指令 / GPT 预设;后续所有对话自动遵循 STE 简化英文规则。

使用流程

  1. 完成插件 / 提示词部署,自动全局生效;

  2. 正常下达写作需求:写 API 文档、生成报错文案、编写 Release Notes;

  3. AI 自动输出标准化简洁英文;

  4. 复杂工业文档可手动开启严格模式进一步收紧规范。

新手小提示

工具自动区分场景,不会篡改营销文案,仅对技术类文本生效;不需要采集数据,无隐私上传,无强制遥测,本地完成文本校验。

六、项目可发展性

短期迭代(近半年)

  1. 扩充更多程序员专属场景模板:前端组件文档、后端接口注释、运维监控告警文案、开源项目 README 规范;

  2. 完善 Windows、Linux 全终端兼容,优化批量文档重写脚本,支持批量处理项目内所有 md 注释文件;

  3. 扩充国产 AI 适配:豆包代码、通义灵码、Kimi Code 插件原生支持,覆盖国内开发者主流工具。

中期生态拓展

  1. 搭建行业预制词库:嵌入式硬件、医疗器械、新能源、轨道交通专属术语包,一键导入适配垂直行业;

  2. 对接主流文档工具(MkDocs、Swagger、GitBook)插件,自动校验仓库内所有英文文档;

  3. 团队协作功能:共享自定义词汇库、统一规范配置文件,适配企业多开发人员协同场景;

  4. 拓展多语言受控翻译链路,支持 STE 英文一键输出规范中日德技术文档。

长期行业价值

当下 AI 生成技术文档已成开发刚需,但歧义、晦涩、空话问题始终无解;SimpleEnglish 把工业级受控语言标准轻量化、开源化,填补 AI 技术写作标准化基础设施空白。

未来会成为 AI 开发生态标配 Skill,和 Superpowers 形成 “代码流程 + 文档语言” 双规范体系,成为企业约束 AI 产出质量的底层工具;项目无绑定特定大模型,适配所有本地 / 云端 LLM,模型迭代不会淘汰该工具,长期具备稳定使用价值。

可持续核心优势

  1. 底层标准 ASD-STE100 持续更新(2025 年发布最新第九版),工具同步迭代规则,生命周期极长;

  2. 模块化规则架构,新增场景、行业词库无需重构核心逻辑,扩展成本极低;

  3. 开源社区轻量化维护,单 Python 文件核心逻辑,开发者可自由二次改造,无商业闭源限制。

源代码:

https://github.com/AminBlg/SimpleEnglish

AI 写技术文档空话多、歧义重、读着累?开源 SimpleEnglish 把航空 40 年严谨写作标准植入所有代码 AI,文档违规率直接下降 72.9%,API 手册、报错日志、Release Notes 一键标准化,MIT 免费开源,搭配 Superpowers 直接打通 AI 开发全链路规范,程序员写英文文档必备神器!

END
关注我们

获取更多开源新资讯