SimpleEnglish README

项目的 README,来自 github.com/AminBlg/SimpleEnglish。合并为一个 markdown 文件:README.md。

✈️ your AI writes like a LinkedIn post. make it write like a Boeing manual.

An agent skill that makes LLMs write plain English with the discipline of ASD-STE100 Simplified Technical English,
the controlled language aerospace has used since 1983 so that a tired mechanic cannot misread an instruction.
Layman-readable by default, STE-strict on request.

95% fewer visible reply defects, measured 9 models benchmarked Agent Skills version 2.1.2 MIT GitHub stars

AminBlg%2FSimpleEnglish | Trendshift

Works in every agent that reads the Agent Skills standard: Claude Code, Cursor, VS Code Copilot, OpenAI Codex, Gemini CLI, Goose, OpenCode, and about 25 more. One folder, no dependencies, MIT.

Install

Any agent, with the skills CLI:

npx skills add AminBlg/SimpleEnglish

This installs the skill only. It does not install the session hook or the output style below, so setting outputStyle to simple-english:simple-english without the plugin does nothing. Use the Claude Code plugin for those.

Claude Code plugin, with the session hook and the output style:

claude plugin marketplace add AminBlg/SimpleEnglish && claude plugin install simple-english@simple-english

The output style is named simple-english:simple-english. The short name does not resolve. Select it with /config under Output style, or put {"outputStyle": "simple-english:simple-english"} in ~/.claude/settings.json.

Codex plugin, with the session hook:

codex plugin marketplace add AminBlg/SimpleEnglish
codex plugin add simple-english@simple-english

Codex asks you to trust the hook before its first run. The hooks need Node.js. Details in src/hooks/README.md.

No skill support? Paste the rule block of prompts/system-prompt.md into your system prompt, AGENTS.md, or .cursorrules. The page ends with a 60-token version for tight budgets.

Then ask for any technical writing, or say "rewrite this with simple-english".

See it

Left is real, unedited Claude output. Right is the same model with the skill loaded.

Without skill With skill

Leveraging sqlpipe's robust architecture, users can seamlessly synchronize their Postgres tables to S3 with minimal configuration overhead. Before getting started, you should ensure that your AWS credentials have been properly configured — this is crucial for avoiding frustrating permission issues down the line.

sqlpipe copies your Postgres tables to S3. It needs one configuration file.

Before you start, make sure that your AWS credentials are correct. If they are not, S3 rejects the upload with a permission error.

More rewrites in examples/before-after.md: READMEs, runbooks, incident reports, error messages, release notes.

Benchmarks

Every number below is recomputed from the committed raw files by python3 evals/check_numbers.py, which CI runs on every push. All Claude runs: claude-sonnet-4-6, low effort, no settings loaded. Judges are Claude models on Claude text, so family bias is possible.

Replies, 8 chat questions with a jargon term each, two runs, raw files and tables. Counts are totals over the 16 replies. 95% fewer visible defects (em-dashes, bold, headers, bullets) with 2.0.1 than with no skill (218 → 11). These counts come from the 2026-09-02 runs of 2.0.1, which still had the five-sentence reply cap that 2.1.0 removed. No run exists yet for 2.1.0 or later. A blind judge preferred 2.0.1 over 2.0.0 in 14 of 16 pairs.

Condition words sentences em-dashes bold headers bullets
no skill 216 16.8 62 79 25 52
2.0.0 184 14.4 43 72 4 52
2.0.1 146 7.9 5 2 0 4

On gpt-4.1-mini the same 8 questions went from 23 sentences, 64 bold spans, and 101 bullets per 8 replies. With 2.0.1 they went to 5.2 sentences and zero formatting.

Documents, the 8 sqlpipe writing tasks scored with the STE linter, one run per cell. One run moves by about 0.5 on this model, so read the rows as parity or better, not as a ranking.

Condition viol/100w Reduction
no skill 4.09
1.3.0 2.11 48%
2.0.0 1.70 58%
2.0.1 0.91 78%

The linter history: 81.3% fewer linter violations across 9 Claude models (144 generations, RESULTS.md), plus Pi, opencode, and OpenAI runs in evals/results/. Those numbers reproduce. A 2026-09-02 audit showed that they measure rule obedience, not what a reader sees, which is why 2.0.1 reports the reply counts above.

The rules

Two registers in SKILL.md, about 1,700 tokens. The 53 numbered rules of Issue 9 live in rule-catalog.md for check mode and Strict mode.

The reply, every chat answer:

Rule What it kills
Prose by default: a list or a table only for content of that shape, no bold The wall of formatting around a one-line answer
First sentence answers The preamble
No em-dashes The spliced half-thought
Define a concept term in a few words Jargon the reader has to look up
No contractions, openers, or closers "Great question!" and "Hope this helps!"

The document: docs, READMEs, runbooks, error messages, release notes:

Rule What it kills
Max 20 words per instruction, 25 per description The run-on sentence
Condition before command Trailing "...if the flag is set" that readers execute too late
Simple tenses, active voice "has been updated", ", making it easy to..."
No should/would/may/might Hedging. can, will, must survive
One word = one meaning, whole document check/verify/confirm/validate roulette
Keep articles, keep "that" Telegraph style. STE is short, not terse
No bold lead-ins, no heading over two sentences Decoration that hides the fact
State the fact, not its importance "crucial", "robust", "not just X, it is Y"

Two modes. Plain, the default, is all of the above. Strict adds the STE dictionary discipline from strict-vocabulary.md when you name STE, ASD-STE100, or compliance. The reply stays Plain in every mode.

FAQ

Does this make output STE-certified? No. Nothing does, because ASD certifies no tool. Strict mode gets close. Word-level rulings live in the official standard, a free download.

Will my docs sound robotic? They will sound like Airbus manuals: flat and impossible to misread. For docs that is the whole point. Keep your voice for your blog.

Why not just prompt "write clearly"? "Clearly" is an opinion. "No sentence over 20 words" is a spec. Agents follow specs.

Why a 40-year-old aerospace standard? It is maintained (Issue 9, January 2025), numbered, and testable. It is also a near-perfect negative of every AI writing tell.

How was it built? Against the primary Issue 9 text, not summaries. A community audit (#4) checked the vocabulary tables against the dictionary. Scenarios and recorded results: evals/pressure-tests.md.

Star history

Star History Chart

Word-choice linter

evals/ste_lint.py measures the mechanical rules and cannot see word choice. tools/ste-dictionary/ holds an extractor that builds the word lists from your own copy of the free Issue 9 PDF. A linter reads them. The repository ships the tool and no dictionary content, because the standard forbids reproduction without written authority from ASD.

Contributing

Open an issue for questions and bug reports. Pull requests are welcome. A change that moves a published number ships the raw files with it, and python3 evals/check_numbers.py must pass. Run python3 evals/ste_lint.py --self-test before you push. Say in the PR whether an agent wrote the code, and do not add attribution trailers.

License

MIT for everything here. The repo paraphrases the rules for teaching and reproduces no spec text or dictionary content. Unofficial project, not affiliated with or endorsed by ASD or STEMG. ASD-STE100 is a registered trademark of ASD.

SimpleEnglish (AminBlg/SimpleEnglish)

正在搜索数据库…

这是什么?一个智能体技能,让大语言模型使用 ASD-STE100(航空航天领域所用的受控语言)写出简明英语。适用于文档、README、运维手册和错误信息,让疲惫的读者也不会误解指令。
这是框架、库还是提示词?它是一组供智能体加载的指令文件(SKILL.md),不是可以导入的代码。它没有依赖项,规则块也可以直接粘贴到系统提示词里。
怎么让它跑起来?用 skills CLI 为任意智能体安装该技能。若要使用会话钩子和输出风格,请改用 Claude Code 插件。然后让它做技术写作,或说明要用 simple-english 改写文本。
开始前需要准备什么吗?不需要 Python 包。只有可选的钩子需要 Node.js,而且智能体必须能读取 Agent Skills 标准。如果智能体不支持技能,也可以把规则块粘贴到提示词中。
安装时有什么坑吗?只安装技能不会添加会话钩子或输出风格,所以单独设置 outputStyle 不会生效。要获得这些功能,请使用 Claude Code 插件。
我的文档会读起来像机器写的吗?读起来像平实、精确的手册。默认风格简单易读,适合普通读者;只有在你要求符合 STE 或 ASD-STE100 时,才会启用严格模式。
它支持哪些智能体?任何能读取 Agent Skills 标准的智能体都可以,包括 Claude Code、Cursor、VS Code Copilot、OpenAI Codex、Gemini CLI、Goose 和 OpenCode,另外还有约 25 个。
改写后的句子是什么样的?README 展示了未经编辑的 Claude 文本「利用 sqlpipe 强大的架构……」,改写后变成「sqlpipe 把你的 Postgres 表复制到 S3,只需要一个配置文件。」句子简短,没有废话。
它能减少多少可见缺陷?没有使用该技能时,16 条聊天回复共有 218 处可见缺陷,比如长破折号、粗体、标题和项目符号。使用 2.0.1 版本后,数量降到 11 处,减少约 95%。作者说明这是 2026-09-02 测得的结果。
作者为什么选择航空航天标准?ASD-STE100 Issue 9 有人维护、有编号、可测试,因此智能体可以把它当作规范来遵循。作者称,它几乎与常见的 AI 写作习惯相反,比如含糊其辞和装饰性排版。
输出内容有 STE 认证吗?没有。这种方式无法获得任何认证,因为 ASD 不对任何工具进行认证。严格模式能较接近标准,而词汇层面的规则来自官方的 Issue 9 标准,该标准可免费下载。
作者
AminBlg
大小
0.6 MB
星标
4.5K
时长
3个月
提交 · 90 天