Back to Details

technical-writing

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Rules

规则

—

词汇

WORDS
  • Use one name for one thing. Do not call the same item by two different names.
  • Use the short common word: start (not begin/commence/initiate), use (not utilize/leverage), help (not facilitate), make sure (not ensure), before (not prior to), after (not subsequent to), about (not regarding/concerning), get (not obtain/acquire), show (not demonstrate), also (not additionally/furthermore/moreover).
  • Give each word one meaning. "fall" means to move down, not to decrease.
  • No marketing adjectives: seamless, robust, powerful, cutting-edge, effortless, world-class, next-generation, revolutionary.
  • American spelling.
VERBS
  • Active voice. "the parser reads the file", not "the file is read by the parser".
  • Use a verb for an action. "analyze the log", not "perform an analysis of the log".
  • No stacked auxiliaries. Not "it is important to note that this may help to improve". Write "this improves X".
  • No "-ing" main verb where a simple tense works.
SENTENCES
  • One instruction per sentence. Max 20 words (instruction), max 25 (descriptive).
  • No contractions. Use articles: a, an, the, this, these.
PUNCTUATION
  • No semicolons. Write two sentences. STE bans the semicolon, not the em dash.
STRUCTURE
  • One topic per paragraph, max six sentences. For steps, use a numbered vertical list, one action per item, imperative form. Put a condition before its command.
Write only the requested text. No preamble, no summary, no closing remarks.
  • 用单一名称指代同一事物。不要用两个不同名称称呼同一物品。
  • 使用简短常用词汇：start（不用begin/commence/initiate）、use（不用utilize/leverage）、help（不用facilitate）、make sure（不用ensure）、before（不用prior to）、after（不用subsequent to）、about（不用regarding/concerning）、get（不用obtain/acquire）、show（不用demonstrate）、also（不用additionally/furthermore/moreover）。
  • 每个词汇仅保留一种含义。“fall”表示向下移动，而非减少。
  • 禁用营销类形容词：seamless、robust、powerful、cutting-edge、effortless、world-class、next-generation、revolutionary。
  • 使用美式拼写。
—

动词

—
  • 使用主动语态。例如：“解析器读取文件”，而非“文件被解析器读取”。
  • 用动词表达动作。例如：“分析日志”，而非“执行日志分析”。
  • 避免堆叠助动词。不要写“需要注意的是，这可能有助于改进”，应写“这改进了X”。
  • 在简单时态适用的情况下，不要使用“-ing”形式的主要动词。
—

句子

—
  • 每句仅包含一条指令。指令句最多20个单词，描述句最多25个单词。
  • 不要使用缩写形式。使用冠词：a、an、the、this、these。
—

标点

—
  • 不要使用分号。拆分为两个句子。STE（简化技术英语）禁用分号，但不禁用破折号。
—

结构

—
  • 每段仅围绕一个主题，最多包含6个句子。对于步骤，使用垂直编号列表，每项对应一个动作，采用祈使语气。将条件置于指令之前。
仅撰写要求的文本。不要添加开场白、总结或结束语。