ste100-writer

ASD-STE100 Writer

此技能的作用

此技能可帮助你使用 ASD-STE100 简化技术英语（STE）编写技术文档。STE 是一种受控语言。它能让母语非英语的人更容易阅读技术文本，也能提高机器翻译的准确性。

STE 包含两部分：

• 一组写作规则。
• 一本核准词典。

词典的法律限制

ASD 拥有 ASD-STE100 规范和完整词典的版权。此技能不包含完整词典，只包含写作规则和少量示例词语。你可以从 https://asd-ste100.org 免费获取完整规范。

如果你不确定某个词是否获准使用，请采取以下做法之一：

• 使用 references/word-choices.md 中的词语。
• 告知用户需要对照官方词典核查该词。

不要编造某个词获准使用的说法。

流程

1. 阅读源文本，确定文本类型。程序性文本提供指示，描述性文本提供数据。
2. 阅读 references/rules.md，并遵守所有规则。
3. 撰写新文本。
4. 使用 references/checklist.md 进行检查。
5. 如果用户要求你展示修改内容，请制作一个包含两列的表格：原文和新文本。

核心规则（简版）

完整规则请参阅 references/rules.md。

• 句子要简短。程序性句子最多 20 个单词，描述性句子最多 25 个单词。
• 一句话只写一条指示。如果一个步骤包含两个操作，就写成两句话或两个步骤。
• 使用祈使句下达指示。例如：“Remove the bolt.”
• 使用主动语态。只有在描述性文本中，且无法使用主动语态时，才使用被动语态。
• 使用词语获准的含义。一个词只表示一个意思。
• 一种事物只用一个词来表达。不要使用同义词。
• 尽可能使用冠词（“a”“an”“the”）。
• 不要将动名词（以“-ing”结尾的词）用作名词或形容词。技术名称除外。
• 名词组合最多包含三个名词。
• 描述性文本的段落最多写六句话。
• 在适用的步骤之前写出警告或注意事项。
• 警告或注意事项以命令或明确的条件开头。
• 不要使用斜杠（“/”），但可以使用“and/or”。
• 使用简单时态：现在时、过去时和将来时。
• 不要为了缩短文本而删词。保持文本清晰。
• 不要使用 em dash。

警告和注意事项

有受伤或死亡风险时，写警告。有设备损坏风险时，写注意事项。先写条件，再写命令。

警告示例：

WARNING: THE FUEL IS FLAMMABLE. KEEP FLAMES AND SPARKS AWAY FROM THE WORK AREA. FUEL FIRES CAN CAUSE INJURY OR DEATH.

常见修改

不要使用	使用
commence, initiate	start
terminate	stop, end
utilize	use
in order to	to
prior to	before
subsequent to	after
in the event that	if
is capable of	can
attempt	try
assist	help
approximately	about
sufficient	enough
require	need
indicate	show
ascertain	find, make sure

更多示例请参阅 references/word-choices.md。

质量检查

在将文本交给用户之前，请进行以下检查：

• 统计每个句子的单词数。
• 找出每个被动语态动词。如果可以，请将其改为主动语态。
• 找出每个以“-ing”结尾的单词。如果规则不允许，请进行修改。
• 找出“不要使用”表格中的每个词。
• 确保全文中的每个术语保持一致。
• 确保技术数据没有变化。

切勿为了遵守规则而更改技术内容。如果规则与技术准确性相冲突，请告知用户。