simple-english

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Simple English: Write Like an Aerospace Manual

简洁英语:像编写航空手册一样写作

Write technical text with the rules of ASD-STE100 Simplified Technical English. STE is the controlled language that aerospace and defense manufacturers use for maintenance documentation. The rules exist so that a tired reader who is not a native English speaker cannot misread an instruction. They remove the usual signs of AI-generated text as a side effect: long sentences, synonym rotation, hedges, filler, and decorative clauses.
Write for that tired reader. Each sentence must survive one read.
遵循ASD-STE100简化技术英语规则撰写技术文本。STE是航空航天和国防制造商用于维护文档的受控语言。制定这些规则是为了让疲惫的非母语读者不会误解指令。同时,这些规则还能消除AI生成文本的常见特征:长句、同义词替换、模糊表述、冗余内容和修饰性从句。
为那位疲惫的读者写作。每句话都应做到一遍读懂。

Your Task

你的任务

When asked to write or rewrite technical text:
  1. Select the mode (pragmatic or strict, below).
  2. Classify each passage as procedural or descriptive. Every other rule depends on this.
  3. Fix your vocabulary before drafting. Pick ONE verb for the check/verify/confirm/validate concept and ONE noun for config/settings. Use no other word for these concepts in the whole document.
  4. Apply the rules from the catalog below.
  5. Run the self-check before you deliver. This step is not optional.
  6. Never touch code, identifiers, commands, or quoted errors (see Untouchables).
When asked to CHECK text instead of writing it, report each violation as: rule number, the offending text, a compliant rewrite. Cite only rule numbers that exist in this file. Do not cite rule numbers from memory: the numbering is unintuitive and models invent it (tested — an agent without this file cited "Rule 3.1: short sentences"; the real Rule 3.1 is about verb forms).
当要求撰写或改写技术文本时:
  1. 选择模式(下文的实用模式或严格模式)。
  2. 对每段文本分类:分为流程类或描述类。其他所有规则都以此为基础。
  3. 起草前确定词汇。为“检查/验证/确认/校验”这类概念选择一个动词,为“配置/设置”这类概念选择一个名词。在整个文档中,这些概念只能使用选定的词汇。
  4. 应用下文规则目录中的规则
  5. 交付前进行自我检查。此步骤为必填项。
  6. 绝不修改代码、标识符、命令或引用的错误信息(参见“不可修改内容”)。
当要求检查文本而非撰写文本时,需按以下格式报告每一处违规:规则编号、违规文本、合规改写版本。仅引用本文档中存在的规则编号,不要凭记忆引用:规则编号的设定并不直观,AI模型会自行编造(经测试——没有本文档的Agent引用了“规则3.1:短句”,而真实的规则3.1是关于动词形式的)。

Two Modes

两种模式

ModeWhenWhat you apply
Pragmatic (default)Docs, READMEs, error messages — the user wants clear textAll structural rules. Domain words stay ("idempotent", "webhook").
StrictThe user names STE, ASD-STE100, or complianceStructural rules + full vocabulary discipline, and tell the user that full compliance needs the official dictionary (free at asd-ste100.org).
模式使用场景应用规则
实用模式(默认)文档、README、错误信息——用户需要清晰文本所有结构规则。保留领域词汇(如"idempotent"、"webhook")。
严格模式用户明确提及STE、ASD-STE100或合规要求结构规则 + 完整词汇规范,并告知用户完全合规需要官方词典(可在asd-ste100.org免费获取)。

Step 1: Classify the Text

步骤1:文本分类

Procedural (instructions)Descriptive (explanations)
PurposeTell the reader what to doExplain what a thing is or does
Verb formImperative: "Install the pump."Simple present/past/future
Sentence limit20 words (Rule 5.1)25 words (Rule 6.3)
Unit ruleOne instruction per sentence (5.2)One topic per paragraph (6.5), max six sentences per paragraph (6.6)
Do not mix the two in one passage. A "Getting started" section is procedural. An "Architecture" section is descriptive. A note inside a procedure is descriptive (25-word limit, no imperative).
流程类(指令)描述类(说明)
目的告知读者要做什么解释事物是什么或如何运作
动词形式祈使句:“Install the pump.”一般现在时/过去时/将来时
句子长度限制20词(规则5.1)25词(规则6.3)
单元规则每句一个指令(规则5.2)每段一个主题(规则6.5),每段最多6句(规则6.6)
请勿在同一段落中混合两种类型。“快速入门”属于流程类,“架构”属于描述类。流程中的注释属于描述类(25词限制,不得使用祈使句)。

THE RULE CATALOG

规则目录

53 rules in 9 sections, paraphrased from ASD-STE100 Issue 9 with software examples. The official wording is in the free standard at asd-ste100.org.
共9部分53条规则,改编自ASD-STE100第9版,并附有软件示例。官方措辞可在asd-ste100.org免费获取的标准文档中查看。

Section 1 — Words (Rules 1.1-1.14)

第1部分——词汇(规则1.1-1.14)

RuleInstruction
1.1Use only approved words, technical nouns, or technical verbs.
1.2Use an approved word only as its listed part of speech.
1.3Use an approved word only with its approved meaning.
1.4Use only the approved forms of verbs and adjectives.
1.5You can use domain words as technical nouns ("webhook", "commit", "endpoint").
1.6Use an unapproved word only when it is a technical noun or part of one.
1.7Do not use technical nouns as verbs.
1.8Use the technical nouns of your project or industry.
1.9When you pick a technical noun, pick a short and clear one.
1.10No regional, slang, or jargon words as technical nouns.
1.11One item, one name. Do not call it "config" here and "settings" there.
1.12You can use domain verbs as technical verbs ("deploy", "compile", "merge").
1.13Do not use technical verbs as nouns.
1.14Use American English spelling.
In pragmatic mode, rules 1.5, 1.8, and 1.12 do the heavy lifting: your domain vocabulary is legal. The ones agents break are 1.7, 1.11, and 1.13.
Before: You can webhook the event, then do a deploy. After: Send the event to the webhook. Then deploy the service.
规则编号要求
1.1仅使用批准词汇、技术名词或技术动词。
1.2批准词汇仅可按其列出的词性使用。
1.3批准词汇仅可按其批准的含义使用。
1.4仅使用动词和形容词的批准形式。
1.5领域词汇可作为技术名词使用(如"webhook"、"commit"、"endpoint")。
1.6仅当非批准词汇是技术名词或其组成部分时,才可使用。
1.7不得将技术名词用作动词。
1.8使用项目或行业的技术名词。
1.9选择技术名词时,应选择简短清晰的词汇。
1.10不得将地域词汇、俚语或行话用作技术名词。
1.11同一事物使用同一名称。此处称“config”,别处就不能称“settings”。
1.12领域动词可作为技术动词使用(如"deploy"、"compile"、"merge")。
1.13不得将技术动词用作名词。
1.14使用美式英语拼写。
在实用模式下,规则1.5、1.8和1.12是核心:你的领域词汇均为合规词汇。AI模型最容易违反的是规则1.7、1.11和1.13。
修改前: You can webhook the event, then do a deploy. 修改后: Send the event to the webhook. Then deploy the service.

Section 2 — Multi-word nouns (Rules 2.1-2.2)

第2部分——复合名词(规则2.1-2.2)

RuleInstruction
2.1Write multi-word nouns of three words or fewer.
2.2When a technical noun needs more than three words, write it in full once, then give a short form or hyphenate the units.
Break long noun chains with prepositions (of, on, in, for):
Before: the connection pool timeout configuration value After: the timeout value for the connection pool
规则编号要求
2.1复合名词长度限制为3词及以内。
2.2当技术名词需要超过3词时,先完整写出,之后使用缩写或连字符连接各单元。
使用介词(of、on、in、for)拆分过长的名词链:
修改前: the connection pool timeout configuration value 修改后: the timeout value for the connection pool

Section 3 — Verbs (Rules 3.1-3.7)

第3部分——动词(规则3.1-3.7)

RuleInstruction
3.1Use only the verb forms that the dictionary gives.
3.2Use only: infinitive, imperative, simple present, simple past, simple future, past participle as adjective.
3.3Use the past participle only as an adjective ("the cached response").
3.4No auxiliary verbs for complex constructions. No present perfect, no "is to be installed".
3.5Use an "-ing" form only as a technical noun or inside one ("logging", "the mounting bracket") — never as a verb.
3.6Active voice. In descriptive text, passive is legal only when the agent is unknown.
3.7Describe an action with a verb, not a noun ("compress the file", not "perform compression of the file").
Approved modals: can, will, must. Banned: should, would, may, might, could. The standard rejects "could" even for possibility: write "an explosion can occur", never "could occur". For "should": a requirement becomes "must"; a suggestion is stated as fact or deleted. This matters double for agent instructions — models read "should" as optional.
Before: The migration has completed and the table is being rebuilt. After: The migration is complete. The database rebuilds the table.
Before: The flag can be set in the config file, making restarts unnecessary. After: You can set the flag in the config file. Then a restart is not necessary.
Before: The temperature must be adjusted. After: Adjust the temperature.
规则编号要求
3.1仅使用词典给出的动词形式。
3.2仅使用:不定式、祈使句、一般现在时、一般过去时、一般将来时、作形容词的过去分词。
3.3过去分词仅可作为形容词使用(如"the cached response")。
3.4不得使用助动词构建复杂句式。不得使用现在完成时,不得使用“is to be installed”这类表达。
3.5“-ing”形式仅可作为技术名词或其组成部分使用(如"logging"、"the mounting bracket")——绝不可用作动词。
3.6使用主动语态。在描述类文本中,仅当施动者未知时才可使用被动语态。
3.7用动词描述动作,而非名词(如"compress the file",而非"perform compression of the file")。
批准使用的情态动词:can、will、must。禁止使用:should、would、may、might、could。 该标准甚至拒绝用“could”表示可能性:应写"an explosion can occur",绝不可写"could occur"。对于“should”:要求类表述改为“must”;建议类表述改为陈述事实或直接删除。这对AI指令尤为重要——模型会将“should”视为可选操作。
修改前: The migration has completed and the table is being rebuilt. 修改后: The migration is complete. The database rebuilds the table.
修改前: The flag can be set in the config file, making restarts unnecessary. 修改后: You can set the flag in the config file. Then a restart is not necessary.
修改前: The temperature must be adjusted. 修改后: Adjust the temperature.

Section 4 — Sentences (Rules 4.1-4.5)

第4部分——句子(规则4.1-4.5)

RuleInstruction
4.1Write short and clear sentences.
4.2Do not omit words or use contractions to shorten sentences. Keep articles, keep "that".
4.3Use a vertical list for complex text.
4.4Use connecting words between sentences on related topics ("Then", "As a result").
4.5Put an article (the, a, an) or a demonstrative adjective (this, these) before nouns where applicable.
Rule 4.2 is the anti-terseness rule. STE is short sentences with complete grammar, not telegraph style:
Wrong shortening: Ensure file exists before running. STE: Make sure that the file exists before you run the command.
规则编号要求
4.1撰写简短清晰的句子。
4.2不得省略词汇或使用缩写来缩短句子。保留冠词,保留“that”。
4.3复杂文本使用垂直列表呈现。
4.4相关主题的句子之间使用连接词(如"Then"、"As a result")。
4.5名词前需根据情况添加冠词(the、a、an)或指示形容词(this、these)。
规则4.2是反简洁过度规则。STE要求短句但语法完整,而非电报式风格:
错误简化: Ensure file exists before running. STE规范: Make sure that the file exists before you run the command.

Section 5 — Procedural writing (Rules 5.1-5.5)

第5部分——流程写作(规则5.1-5.5)

RuleInstruction
5.1Maximum 20 words per sentence. Warnings and cautions included.
5.2One instruction per sentence, unless two actions happen at the same time.
5.3Write instructions in the imperative: "Run the migration."
5.4Put a required condition before the command, divided by a comma: "If the build fails, read the log."
5.5Notes give information, never instructions. Notes get the 25-word limit.
Before: You'll want to grab the API key from the dashboard before configuring the client, which you can do under Settings. After: Get the API key from the dashboard, under Settings. Then configure the client with this key.
规则编号要求
5.1每句最多20词,包括警告和注意事项。
5.2每句一个指令,除非两个动作同时发生。
5.3指令使用祈使句:“Run the migration.”
5.4必要条件置于命令之前,用逗号分隔:“If the build fails, read the log.”
5.5注释仅提供信息,不得包含指令。注释遵循25词限制。
修改前: You'll want to grab the API key from the dashboard before configuring the client, which you can do under Settings. 修改后: Get the API key from the dashboard, under Settings. Then configure the client with this key.

Section 6 — Descriptive writing (Rules 6.1-6.6)

第6部分——描述写作(规则6.1-6.6)

RuleInstruction
6.1Give information gradually: one new fact per sentence.
6.2Use key words and phrases to give the text a logical structure.
6.3Maximum 25 words per sentence.
6.4Group related information in paragraphs.
6.5One topic per paragraph.
6.6Maximum six sentences per paragraph.
No imperative in descriptive text. Descriptions explain; procedures instruct.
规则编号要求
6.1逐步提供信息:每句一个新事实。
6.2使用关键词和短语构建文本的逻辑结构。
6.3每句最多25词。
6.4相关信息分组为段落。
6.5每段一个主题。
6.6每段最多6句。
描述类文本不得使用祈使句。描述用于解释,流程用于指令。

Section 7 — Safety instructions (Rules 7.1-7.3)

第7部分——安全说明(规则7.1-7.3)

RuleInstruction
7.1Use a word that shows the risk level ("WARNING" = injury, "CAUTION" = damage).
7.2Start with a clear command or condition.
7.3Then give the risk or the possible result.
Never bury the instruction after the explanation. The pattern transfers directly to destructive CLI flags, irreversible migrations, and dangerous API options.
Before: Note that data loss may occur in some circumstances if the destructive flag happens to be enabled when running against production. After: CAUTION: Do not use the
--force
flag against production. The flag deletes rows that do not match the source.
规则编号要求
7.1使用表示风险等级的词汇("WARNING"表示可能造成伤害,"CAUTION"表示可能造成损坏)。
7.2以清晰的命令或条件开头。
7.3随后说明风险或可能的后果。
绝不可将指令隐藏在解释之后。该模式可直接应用于破坏性CLI标志、不可逆迁移和危险API选项。
修改前: Note that data loss may occur in some circumstances if the destructive flag happens to be enabled when running against production. 修改后: CAUTION: Do not use the
--force
flag against production. The flag deletes rows that do not match the source.

Section 8 — Punctuation and word count (Rules 8.1-8.7)

第8部分——标点与词数统计(规则8.1-8.7)

RuleInstruction
8.1All standard punctuation is legal except the semicolon. Write two sentences instead.
8.2Use hyphens to connect words that act as one unit.
8.3Parentheses are legal for references, item numbers, abbreviations, plural forms, explanations, alternatives.
8.4In a vertical list, the lead-in colon ends a sentence for word count.
8.5Text inside parentheses counts as one word.
8.6Count as one word each: numbers, numbers with units, abbreviations, alphanumeric identifiers, quoted text, titles, labels, proper nouns.
8.7A hyphenated word counts as one word.
Rule 8.6 matters for software text:
sqlpipe run --config sqlpipe.yaml
in backticks is quoted text and counts as one word. Long identifiers do not blow your sentence budget.
规则编号要求
8.1所有标准标点均合规,分号除外。应拆分为两个句子。
8.2使用连字符连接构成一个单元的词汇。
8.3括号可用于引用、项目编号、缩写、复数形式、解释、替代选项。
8.4在垂直列表中,引导性冒号作为句子结尾计入词数。
8.5括号内的文本计为一个词。
8.6以下内容各计为一个词:数字、带单位的数字、缩写、字母数字标识符、引用文本、标题、标签、专有名词。
8.7连字符连接的词汇计为一个词。
规则8.6对软件文本至关重要:反引号中的
sqlpipe run --config sqlpipe.yaml
属于引用文本,计为一个词。长标识符不会占用句子词数限额。

Section 9 — Writing practices (Rules 9.1-9.4, GR-1 to GR-8)

第9部分——写作实践(规则9.1-9.4,GR-1至GR-8)

RuleInstruction
9.1When a word-for-word replacement does not work, restructure the sentence.
9.2Use each approved word correctly: approved meaning, approved part of speech.
9.3Do not build phrasal verbs ("go down" → "decrease", "set up" → "install" or "configure").
9.4Keep one consistent style and terminology through the whole document.
General recommendations GR-1 to GR-8: keep the conjunction "that", be careful with "with", give pronouns clear referents, prefer "this + noun" over bare "this", avoid false friends, avoid Latin abbreviations, use inclusive language, and use the possessive apostrophe form only when you are sure it is correct (GR-8: if unsure, do not use it — non-native readers find it hard).
GR-6 for software docs: "e.g." → "for example", "i.e." → "that is", and delete "etc." — name the items or write "and more".
规则编号要求
9.1当逐词替换不可行时,重构句子。
9.2正确使用每个批准词汇:使用批准的含义和词性。
9.3不得构建短语动词(如将"go down"改为"decrease",将"set up"改为"install"或"configure")。
9.4整个文档保持一致的风格和术语。
通用建议GR-1至GR-8:保留连词“that”,谨慎使用“with”,确保代词指代明确,优先使用“this + 名词”而非单独的“this”,避免假同源词,避免拉丁语缩写,使用包容性语言,仅在确定正确时使用所有格撇号(GR-8:若不确定,请勿使用——非母语读者难以理解)。
针对软件文档的GR-6:将"e.g."改为"for example","i.e."改为"that is",删除"etc."——列出具体项或写"and more"。

VOCABULARY DISCIPLINE

词汇规范

The official dictionary (~900 approved words, ~1,200 banned words with alternatives) is copyrighted by ASD and is not reproduced here. Its mechanics apply without it: one word, one meaning, one part of speech.
Known part-of-speech rulings, useful as patterns:
WordRuling
test, check, workNoun only. "Do a test", not "test the pump". "Check that X" becomes "make sure that X".
oilNoun only as used in STE examples. For the verb, the dictionary gives "lubricate".
helpVerb only. For the noun, the dictionary gives "aid": "with the aid of".
fall"To move down by gravity" only, never "decrease".
follow"To come after" only, never "obey". Write "obey the instructions".
above, belowPhysical positions only. For limits write "more than", "less than".
官方词典(约900个批准词汇,约1200个禁用词汇及替代词)由ASD拥有版权,此处未复制。其核心原则依然适用:一词一意,一词一性。
以下是已知的词性判定,可作为参考模式:
词汇判定
test, check, work仅作名词。“Do a test”,而非“test the pump”。“Check that X”改为“make sure that X”。
oil在STE示例中仅作名词。动词形式需使用词典中的“lubricate”。
help仅作动词。名词形式需使用词典中的“aid”:“with the aid of”。
fall仅表示“因重力向下移动”,绝不可表示“减少”。
follow仅表示“跟随”,绝不可表示“遵守”。应写“obey the instructions”。
above, below仅表示物理位置。表示限制应写“more than”“less than”。

The modal ladder

情态动词替换表

You wroteSTE writes
should (requirement)must
should (recommendation)Delete it, or state it as fact: "X is better because Y."
may / might / could (possibility)can
may (permission)can
would (hypothetical)Restructure: "If X occurs, Y occurs."
你写的内容STE规范写法
should(要求)must
should(建议)删除,或改为陈述事实:“X is better because Y.”
may / might / could(可能性)can
may(许可)can
would(假设)重构句子:“If X occurs, Y occurs.”

Slop-to-simple substitutions

冗余内容替换表

This table is ours, not the ASD dictionary. It maps the words AI-generated docs overuse to plain replacements. If the word carries no fact, delete it instead of replacing it.
SlopWrite instead
leverage, utilizeuse
in order toto
prior tobefore
ensuremake sure that
it is worth noting that(delete)
it's important to, crucially(delete — state the fact)
simply, just, easily, seamlessly, effortlessly(delete)
robust, powerful, comprehensive, performant(delete, or give the measurable property)
functionalityfunction, feature
enables you to, allows you toyou can
is designed to, aims to(delete — say what it does)
facilitatehelp, make possible
dive into, delve intoread, examine
when it comes tofor
in the event thatif
due to the fact thatbecause
as needed, as necessary(state the condition)
and/orPick one, or write "X, or Y, or both"
e.g. / i.e. / etc.for example / that is / (name the items)
gracefully handles(say what it does: "retries three times, then stops")
out of the boxby default
under the hoodinternally
blazingly fast, state-of-the-artfast (give the number) / (delete)
streamlinemake simpler, make faster
plethora, myriadmany
addresses the issue, tacklescorrects the fault, removes the error
此表为自定义内容,非ASD词典内容。它将AI生成文档过度使用的词汇映射为简洁替代词。若词汇无实际信息,直接删除即可。
冗余词汇替代写法
leverage, utilizeuse
in order toto
prior tobefore
ensuremake sure that
it is worth noting that(删除)
it's important to, crucially(删除——直接陈述事实)
simply, just, easily, seamlessly, effortlessly(删除)
robust, powerful, comprehensive, performant(删除,或给出可衡量的属性)
functionalityfunction, feature
enables you to, allows you toyou can
is designed to, aims to(删除——直接说明功能)
facilitatehelp, make possible
dive into, delve intoread, examine
when it comes tofor
in the event thatif
due to the fact thatbecause
as needed, as necessary(说明具体条件)
and/or二选一,或写“X, or Y, or both”
e.g. / i.e. / etc.for example / that is / (列出具体项)
gracefully handles(说明具体行为:“retries three times, then stops”)
out of the boxby default
under the hoodinternally
blazingly fast, state-of-the-artfast(给出具体数值) / (删除)
streamlinemake simpler, make faster
plethora, myriadmany
addresses the issue, tacklescorrects the fault, removes the error

Consistency pass

一致性检查

Collapse these common rotations to one term each (Rules 1.11, 9.4):
  • check / verify / confirm / validate / ensure → pick one
  • config / configuration / settings / options → pick one
  • delete / remove / drop / destroy → one per meaning, kept consistent
  • error / issue / problem / failure → "error" for errors, "failure" for failed operations
  • run / execute / invoke / launch → pick one
  • show / display / render / present → pick one
将以下常见同义词统一为单个术语(规则1.11、9.4):
  • check / verify / confirm / validate / ensure → 选一个
  • config / configuration / settings / options → 选一个
  • delete / remove / drop / destroy → 按含义各选一个并保持一致
  • error / issue / problem / failure → “error”用于错误信息,“failure”用于失败操作
  • run / execute / invoke / launch → 选一个
  • show / display / render / present → 选一个

Untouchables

不可修改内容

These are technical names (Rules 1.5, 8.6). Leave them exact, even when they break vocabulary rules:
  • Code blocks, inline code, identifiers, CLI commands, flags, file paths
  • Quoted error messages and log lines
  • Product names, API endpoint names, config keys
  • Numbers with units — each counts as one word in the sentence limit
以下内容为技术名称(规则1.5、8.6)。需保持原样,即使违反词汇规则:
  • 代码块、行内代码、标识符、CLI命令、标志、文件路径
  • 引用的错误信息和日志行
  • 产品名称、API端点名称、配置键
  • 带单位的数字——在句子词数限制中各计为一个词

Beyond Documentation

文档之外的应用

Same rules, different targets. Full adaptations in
references/use-cases.md
:
  • Error messages: state what happened (simple past), the cause if known, then the fix as an imperative. No "Oops", no "Please ensure", no apology filler.
  • Runbooks: STE's home turf. Imperative steps, conditions first, warnings before the step.
  • Incident reports: simple past only. "We have identified an issue that may have impacted" becomes "Between 14:02 and 14:31 UTC, 12% of requests failed."
  • Release notes: breaking changes follow the warning pattern — command first, risk second.
  • Agent instructions (prompts, AGENTS.md): a system prompt is a procedure for a reader that cannot ask questions. One instruction per sentence, no "should", condition first.
  • Translation prep: STE's original job. One meaning per word plus complete grammar removes most translation ambiguity.
规则相同,应用场景不同。完整适配示例见
references/use-cases.md
  • 错误信息:用一般过去时说明发生的情况,若已知原因则说明原因,然后用祈使句给出修复方法。不得使用“Oops”“Please ensure”或道歉类冗余内容。
  • 运行手册:STE的核心应用场景。祈使句步骤,条件前置,步骤前添加警告。
  • 事件报告:仅使用一般过去时。“We have identified an issue that may have impacted”改为“Between 14:02 and 14:31 UTC, 12% of requests failed.”
  • 发布说明:破坏性变更遵循警告模式——先给出命令,再说明风险。
  • Agent指令(提示词,AGENTS.md):系统提示词是给无法提问的读者的流程说明。每句一个指令,不得使用“should”,条件前置。
  • 翻译准备:STE的原始用途。一词一意加上完整语法可消除大部分翻译歧义。

Self-Check Before You Deliver

交付前自我检查

This step is not optional. Run these four checks on your draft:
  1. Count words in your three longest sentences. Over the 20/25 limit → split them.
  2. Search your draft for:
    'll
    ,
    're
    ,
    's
    (contraction),
    has been
    ,
    have been
    ,
    should
    ,
    -ing
    verbs after a comma, semicolons.
  3. Search for every
    if
    and
    when
    . Each one stands at the START of its sentence, before the command. "Increase the timeout if the network is slow" → "If the network is slow, increase the timeout."
  4. Search for the verbs you did NOT pick in Your Task step 3 (the check/verify/confirm set). Replace every hit with your chosen verb.
Fix what you find, then deliver. For a full audit, run
references/checklist.md
.
此步骤为必填项。对草稿进行以下四项检查:
  1. 统计最长三句的词数。若超过20/25词限制→拆分句子。
  2. 在草稿中搜索:
    'll
    're
    's
    (缩写)、
    has been
    have been
    should
    、逗号后的
    -ing
    动词、分号。
  3. 搜索所有
    if
    when
    。每个词都应位于句子开头,命令之前。“Increase the timeout if the network is slow”改为“If the network is slow, increase the timeout.”
  4. 搜索任务步骤3中未选定的动词(check/verify/confirm系列)。将所有匹配项替换为选定的动词。
修复发现的问题后再交付。如需全面审核,可运行
references/checklist.md

Full Example

完整示例

Before (real unedited AI output):
Connection timeouts. If sqlpipe hangs or fails with
dial tcp: i/o timeout
, check that the host running sqlpipe can reach the Postgres port (usually 5432) — this is often a security group or firewall rule blocking the connection. If you're connecting to a managed database (RDS, Cloud SQL, etc.), confirm the instance allows connections from sqlpipe's IP. You can also try increasing
source.connect_timeout_seconds
in your config, since a slow network path can trip the default timeout even when the connection eventually succeeds.
After (classified procedural, verb = "make sure", conditions first, one instruction per sentence):
Connection timeouts. sqlpipe stops with
dial tcp: i/o timeout
when it cannot reach the Postgres port (5432 by default).
  1. Make sure that the host that runs sqlpipe can reach the Postgres port. A firewall or security group usually blocks it.
  2. If the database is managed (RDS, Cloud SQL), make sure that the instance accepts connections from the IP of sqlpipe.
  3. If the network is slow, increase
    source.connect_timeout_seconds
    in the configuration.
What changed: 40-word sentences split under 20; "you're" expanded; "check/confirm" collapsed to "make sure that"; every condition moved before its command; "etc." removed; code and error strings untouched.
修改前(真实未经编辑的AI输出):
Connection timeouts. If sqlpipe hangs or fails with
dial tcp: i/o timeout
, check that the host running sqlpipe can reach the Postgres port (usually 5432) — this is often a security group or firewall rule blocking the connection. If you're connecting to a managed database (RDS, Cloud SQL, etc.), confirm the instance allows connections from sqlpipe's IP. You can also try increasing
source.connect_timeout_seconds
in your config, since a slow network path can trip the default timeout even when the connection eventually succeeds.
修改后(分类为流程类,动词=“make sure”,条件前置,每句一个指令):
Connection timeouts. sqlpipe stops with
dial tcp: i/o timeout
when it cannot reach the Postgres port (5432 by default).
  1. Make sure that the host that runs sqlpipe can reach the Postgres port. A firewall or security group usually blocks it.
  2. If the database is managed (RDS, Cloud SQL), make sure that the instance accepts connections from the IP of sqlpipe.
  3. If the network is slow, increase
    source.connect_timeout_seconds
    in the configuration.
修改点:40词的句子拆分为20词以内;“you're”展开;“check/confirm”统一为“make sure that”;所有条件移至命令之前;删除“etc.”;代码和错误字符串保持不变。

Limits

限制

STE is for technical facts and instructions. Do not apply it to marketing copy, blog voice, or brand writing — it deletes persuasion by design. When a user asks for STE on marketing text, say so and offer it for the docs instead.
This skill is an unofficial aid. It is not affiliated with or endorsed by ASD or STEMG, and no tool can guarantee STE compliance. ASD-STE100 is a registered trademark of ASD. The official standard is a free download at asd-ste100.org.
STE适用于技术事实和指令。请勿将其应用于营销文案、博客风格或品牌写作——其设计初衷就是消除说服性内容。当用户要求对营销文本应用STE时,需告知这一点,并建议将其应用于文档。
本技能为非官方辅助工具。与ASD或STEMG无关,也不代表其认可,任何工具都无法保证完全符合STE规范。ASD-STE100是ASD的注册商标。官方标准可在asd-ste100.org免费下载。

References

参考资料

  • references/checklist.md
    — full verification pass with searchable patterns, for check mode and final audits
  • references/use-cases.md
    — long-form adaptations: error messages, runbooks, incident reports, commits, UI copy, i18n
  • references/checklist.md
    ——包含可搜索模式的完整验证流程,适用于检查模式和最终审核
  • references/use-cases.md
    ——长篇适配示例:错误信息、运行手册、事件报告、提交信息、UI文案、国际化