用途
ASD-STE100 Writer 用于按 ASD-STE100 简化技术英语(Simplified Technical English,STE)撰写和改写技术文档。STE 是一种受控语言,其目标是让母语非英语的读者更容易阅读技术文本,同时使机器翻译更准确。
STE 由两部分组成:
- 一套写作规则。
- 一本经批准的用词词典。
主要能力
该技能包含 STE 的写作规则和一小部分示例用词选择,不包含完整词典。它可以:
- 读取源文本并判断文本类型:程序性文本给出指令,描述性文本给出数据。
- 依据规则改写文本。
- 使用检查清单做质量核对。
- 在用户要求时,输出两列表格展示改动:初始文本与新文本。
使用方式
处理流程如下:
- 读取源文本,找到文本类型。程序性文本给出指令,描述性文本给出数据。
- 阅读 references/rules.md,遵守全部规则。
- 撰写新文本。
- 用 references/checklist.md 做检查。
- 如果用户要求展示改动,制作两列表格:初始文本和新文本。
核心规则(简版,完整规则见 references/rules.md):
- 写短句。程序性句子最多 20 个词,描述性句子最多 25 个词。
- 一句话写一条指令。如果一个步骤有两个动作,写成两句或两个步骤。
- 指令使用祈使句,例如:“Remove the bolt.”
- 使用主动语态。被动语态只用于描述性文本,且仅在无法使用主动语态时使用。
- 使用词的批准含义。一个词只有一个含义。
- 一个事物只用一个词,不要使用同义词。
- 尽可能使用冠词(“a”“an”“the”)。
- 不要把动名词(“-ing”词)用作名词或形容词,技术名称除外。
- 名词组合中最多使用三个名词。
- 描述性文本的一个段落最多写六句话。
- 把警告或注意事项放在其适用的步骤之前。
- 警告或注意事项以命令或明确条件开头。
- 不要使用斜杠(“/”),但允许使用“and/or”。
- 使用简单时态:现在时、过去时和将来时。
- 不要为了缩短文本而删词,要保持文本清晰。
- 不要使用长破折号。
警告和注意事项:
- 对受伤或死亡风险写警告(warning),对设备损坏风险写注意事项(caution)。
- 先写条件,再写命令。
警告示例:
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。
词典的法律限制
ASD 拥有 ASD-STE100 规范及完整词典的版权。该技能不包含完整词典,只包含写作规则和一小部分示例用词选择。完整规范可从 https://asd-ste100.org 免费获取。
如果不确定某个词是否被批准,可采取以下做法之一:
- 使用 references/word-choices.md 中的词。
- 告诉用户该词需要对照官方词典核对。
- 不要臆断某词已被批准。
质量检查
在把文本交给用户之前,做以下检查:
- 统计每个句子的词数。
- 找出每个被动动词,如有可能改为主动语态。
- 找出每个“-ing”词,如规则不允许则修改。
- 找出“不要使用”表中的每个词。
- 确保每个术语在全文中保持一致。
- 确保技术数据没有改变。
不要为了遵守规则而改变技术内容。如果规则与技术准确性冲突,告知用户。
适用场景
适用于需要按 ASD-STE100 简化技术英语撰写或改写技术文档的场景,例如操作说明、程序性文本和描述性文本。
限制
- 不包含 ASD-STE100 完整词典,只有写作规则和少量示例用词。
- 不确定某词是否被批准时,不能臆断,需使用示例词表或提示用户核对官方词典。
- 不得为了遵守规则而改变技术内容;规则与技术准确性冲突时应告知用户。
- 关于收费、价格、平台、效果等信息,资料暂未提供。