Back to Details

ste100-writer

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

ASD-STE100 Writer

ASD-STE100 文档撰写技能

What this skill does

本技能的功能

This skill helps you to write technical documents in ASD-STE100 Simplified Technical English (STE). STE is a controlled language. It makes technical text easy to read for persons whose first language is not English. It also makes machine translation more accurate.
STE has two parts:
  • A set of writing rules.
  • A dictionary of approved words.
本技能可帮助您使用ASD-STE100简化技术英语（STE）撰写技术文档。STE是一种受控语言，它能让母语非英语的人士更易阅读技术文本，同时也能提高机器翻译的准确性。
STE包含两部分：
  • 一套写作规则
  • 一份核准词汇词典

Legal limit on the dictionary

词典的法律限制

ASD owns the copyright of the ASD-STE100 specification and of the full Dictionary. This skill does not contain the full Dictionary. It contains only the writing rules and a small set of example word choices. Get the full specification at no cost from https://asd-ste100.org.
If you are not sure that a word is approved, do one of these:
  • Use a word from 
    references/word-choices.md
    .
  • Tell the user that the word needs a check against the official Dictionary.
Do not invent a claim that a word is approved.
ASD拥有ASD-STE100规范及完整词典的版权。本技能未包含完整词典，仅包含写作规则及一小部分词汇选择示例。您可从https://asd-ste100.org免费获取完整规范。
若您不确定某个词汇是否已获核准，请执行以下操作之一：
  • 使用
    references/word-choices.md
    中的词汇
  • 告知用户该词汇需对照官方词典进行核查
请勿虚构词汇已获核准的声明。

Procedure

操作流程

  1. Read the source text. Find the text type. Procedural text gives instructions. Descriptive text gives data.
  2. Read 
    references/rules.md
    . Obey all the rules.
  3. Write the new text.
  4. Do a check with 
    references/checklist.md
    .
  5. If the user gives you a command to show the changes, make a table with two columns: the initial text and the new text.
  1. 阅读源文本，确定文本类型。流程性文本用于提供操作指令，描述性文本用于提供数据。
  2. 阅读
    references/rules.md
    ，遵守所有规则。
  3. 撰写新文本。
  4. 使用
    references/checklist.md
    进行检查。
  5. 若用户要求展示修改内容，创建包含两列的表格：初始文本和修改后的文本。

Core rules (short form)

核心规则（精简版）

Read 
references/rules.md
for the full set.
  • Write short sentences. A procedural sentence has a maximum of 20 words. A descriptive sentence has a maximum of 25 words.
  • Write one instruction in one sentence. If a step has two actions, write two sentences or two steps.
  • Use the imperative for instructions. Example: "Remove the bolt."
  • Use the active voice. Use the passive voice only in descriptive text, and only when the active voice is not possible.
  • Use the approved meaning of a word. One word has one meaning.
  • Use one word for one thing. Do not use synonyms.
  • Use articles ("a", "an", "the") where possible.
  • Do not use a gerund (an "-ing" word) as a noun or as an adjective. A technical name is an exception.
  • Use a maximum of three nouns together in a noun cluster.
  • Write a maximum of six sentences in a paragraph of descriptive text.
  • Put the warning or the caution before the step that it applies to.
  • Start a warning or a caution with a command or with a clear condition.
  • Do not use a slash ("/"), but "and/or" is permitted.
  • Use simple verb tenses: the present tense, the past tense, and the future tense.
  • Do not remove words to make the text short. Keep the text clear.
  • Do not use em dashes
完整规则请查阅
references/rules.md
。
  • 撰写短句。流程性句子最多20个单词，描述性句子最多25个单词。
  • 一个句子仅包含一条指令。若一个步骤包含两个动作，需拆分为两个句子或两个步骤。
  • 指令使用祈使语气。示例："Remove the bolt."
  • 使用主动语态。仅在描述性文本中且无法使用主动语态时，才可使用被动语态。
  • 使用词汇的核准含义。一词一义。
  • 一物一词。请勿使用同义词。
  • 尽可能使用冠词（"a", "an", "the"）。
  • 请勿将动名词（以"-ing"结尾的单词）用作名词或形容词。技术名称除外。
  • 名词簇中最多使用三个名词连用。
  • 描述性文本段落最多包含六个句子。
  • 将警告或注意事项放在其适用的步骤之前。
  • 警告或注意事项以指令或明确条件开头。
  • 请勿使用斜杠（"/"），但允许使用"and/or"。
  • 使用简单动词时态：一般现在时、一般过去时和一般将来时。
  • 请勿为简化文本而删减词汇，需保持文本清晰。
  • 请勿使用破折号

Warnings and cautions

警告与注意事项

Write a warning for a risk of injury or death. Write a caution for a risk of damage to equipment. Write the condition first, then the command.
Example of a warning:
WARNING: THE FUEL IS FLAMMABLE. KEEP FLAMES AND SPARKS AWAY FROM THE WORK AREA. FUEL FIRES CAN CAUSE INJURY OR DEATH.
针对可能导致受伤或死亡的风险撰写警告。针对可能导致设备损坏的风险撰写注意事项。先写条件，再写指令。
警告示例：
WARNING: THE FUEL IS FLAMMABLE. KEEP FLAMES AND SPARKS AWAY FROM THE WORK AREA. FUEL FIRES CAN CAUSE INJURY OR DEATH.

Common changes

常见词汇替换

Do not useUse
commence, initiatestart
terminatestop, end
utilizeuse
in order toto
prior tobefore
subsequent toafter
in the event thatif
is capable ofcan
attempttry
assisthelp
approximatelyabout
sufficientenough
requireneed
indicateshow
ascertainfind, make sure
Read 
references/word-choices.md
for more examples.
请勿使用建议使用
commence, initiatestart
terminatestop, end
utilizeuse
in order toto
prior tobefore
subsequent toafter
in the event thatif
is capable ofcan
attempttry
assisthelp
approximatelyabout
sufficientenough
requireneed
indicateshow
ascertainfind, make sure
更多示例请查阅
references/word-choices.md
。

Quality check

质量检查

Before you give the text to the user, do these checks:
  • Count the words in each sentence.
  • Find each passive verb. Change it to the active voice, if possible.
  • Find each "-ing" word. Change it, if the rules do not permit it.
  • Find each word from the "Do not use" table.
  • Make sure that each term is the same in all of the text.
  • Make sure that the technical data did not change.
Never change the technical content to obey a rule. If a rule and the technical accuracy have a conflict, tell the user.
在将文本交付给用户之前，请执行以下检查：
  • 统计每个句子的单词数量。
  • 找出所有被动动词，尽可能改为主动语态。
  • 找出所有以"-ing"结尾的单词，若规则不允许则进行修改。
  • 找出所有来自“请勿使用”表格中的词汇。
  • 确保文本中每个术语保持一致。
  • 确保技术数据未被修改。
切勿为遵守规则而更改技术内容。若规则与技术准确性存在冲突，请告知用户。