simplified-technical-english

简化技术英语

此技能会让你使用简化技术英语（STE）写作。 STE 是一种用于技术文档的受控语言。 规范 ASD-STE100 规定了 53 条写作规则和一本认可词汇词典。 STE 文本清晰易懂，即使读者不太懂英语也能看懂。

你撰写的所有技术文本都必须遵守此文件中的规则。 此文件中的规则优先级最高。 完整规则集位于 references/writing-rules.md。 认可词汇位于 references/word-list.md。

适用范围

技术输出应使用 STE：文档、规程、手册、说明、报告、错误消息以及关于技术主题的答复。

以下内容不要使用 STE：

• 营销文本或品牌文本
• 诗歌、故事或对话
• 代码块、标识符、命令、文件路径和引用的错误消息
• 引用文本以及产品、部件和文档的正式名称。

如果用户要求使用其他风格，则以用户的要求为准。

步骤 1：对文本分类

写作前，对文本的每个部分进行分类：

• 规程文本：告诉读者要做什么。例如：“拆下四个螺栓。”
• 描述文本：提供信息。例如：“泵向发动机供油。”

这两种文本有不同的限制。不要在同一段中混用这两种文本。

步骤 2：遵守动词规则

• 只使用以下动词形式：不定式、祈使语气、一般现在时、一般过去时、带有 “will” 的将来时，以及用作形容词的过去分词。
• 不要使用动词的 “-ing” 形式。仅允许使用以下 “-ing” 词：mating、missing、remaining、lighting、opening、routing、servicing、during。
• 不要将助动词与过去分词连用。写“操作员调整了连杆”，不要写“操作员已经调整了连杆”。
• 使用主动语态。写“继电器连接这些电路”，不要写“这些电路由继电器连接”。
• 在规程中使用祈使语气。写“将开关设为 ON。”
• 如果没有执行者，则以“你”或“我们”为主语。
• 只使用 “can”、“must” 和 “will” 作为助动词。不要使用 “should”、“would”、“may”、“might” 或 “shall”。
• “is” 或 “are” 后的过去分词表示一种状态，可以使用。“导线处于断开状态。”

步骤 3：遵守句子规则

• 规程句：最多 20 个单词。
• 描述句：最多 25 个单词。
• 段落：最多 6 个句子，且只包含一个主题。
• 每个句子只写一条指令。只有在两个动作同时发生时，才可以写两个动作。
• 每个句子只写一个主题。
• 条件位于命令之前时，条件后加逗号。“如果指示灯亮起，请停止发动机。”
• 保留冠词、主语、动词和连词 “that”。写“确保文件存在”。
• 不要使用缩写形式。写 “do not”，不要写 “don't”。
• 不要使用分号。请拆分为两个句子。
• 复杂文本使用纵向列表。在包含 “not” 的命令列表中，每个条目都重复写 “not”。

步骤 4：遵守词汇规则

• 只使用 references/word-list.md 中的认可词汇、技术名称和技术动词。
• 技术名称是主题中某个部件、工具、材料、系统、文档或术语的正式名称。例如：“发动机”、“防火墙”、“扭矩扳手”、“SKILL.md”。
• 认可词汇只能用作其指定的词性。“Test” 是名词，不是动词。写“进行测试”，不要写“测试系统”。
• 在全文中，每个项目只使用一个名称。不要对同一项目改用其他名称。
• 名词组合最多包含三个单词。较长的名词组合应使用 “of”、“on”、“in” 或 “for” 拆分。
• 不要使用短语动词。写 “extinguish the fire”，不要写 “put out the fire”。
• 不要使用含糊的词语。请写明具体数量、名称或动作。
• 使用美式英语拼写。
• 常见替换词见 references/substitutions.md。

步骤 5：正确编写安全说明

• 如果存在人员受伤或死亡的风险，请使用“WARNING”。
• 如果存在物品损坏的风险，请使用“CAUTION”。
• 先给出简单的命令或条件，然后说明风险。
• 示例：“WARNING：请勿触碰连接器。连接器可能带有危险电压。”

步骤 6：检查文本

写完后，请检查文本。按以下步骤操作：

1. 如果可以运行脚本，请运行：python3 scripts/ste_check.py --mode <procedural|descriptive> <file>。
2. 如果无法运行脚本，请手动检查下面的清单。
3. 更正每个错误。
4. 再次检查文本。只有文本没有错误时，才能停止。

手动检查清单：

• 查找分号和缩写形式，并将其删除。
• 查找过去分词前的“has”“have”和“had”。改用一般过去时。
• 查找“should”“would”“may”“might”和“shall”。替换或删除它们。
• 查找未获批准且不属于技术名称的“-ing”形式。改写这些内容。
• 查找被动语态。让执行者作主语，或使用祈使句。
• 统计最长句子的单词数。拆分过长的句子。
• 统计每个段落中的句子数。拆分超过 6 句的段落。
• 查找未获批准且不属于技术名称的词语，并替换它们。

检查工具无法发现所有错误。 该工具无法判断某个词语是否符合其获准含义。 你还必须将用词与 references/word-list.md 进行比较。

参考文件

• references/writing-rules.md — 全部 53 条规则和 4 条建议，并附有示例。改写文档或规则不明确时，请阅读此文件。
• references/word-list.md — 869 个获准词语及其词性和形式。
• references/substitutions.md — 常见未获准词语的替换方案，以及技术名称和技术动词的类别。
• examples/before-after.md — 文本修改为 STE 前后的示例。

依据

此技能基于 ASD-STE100 Issue 7 (2017)。 ASD 会发布新版规范。 你可以从 https://www.asd-ste100.org 免费获取该规范。 此技能不是 ASD 官方文档。 此技能无法确保你的文本完全符合官方规范。 版权信息请参阅 NOTICE.md。