技术写作技术文

技术写作规则 ASD-STE100

2016-04-20  本文已影响151人  徘徊的行者


你可以使用哪些词:

​1. 仅使用规则字典中规定的词。

2. ​被用作描述技术名称的词。

3. ​被用作技术动词的词。

语言的组成:

只在使用已在字典中批准的词语作为语言的一部分。​

已批准的含义:

​仅使用单词在字典中定义的含义。不要以其他含义老使用该单词。

动词和形容词的使用方式:

仅以字典中规定的方式使用动词和形容词。​

技术名称使用规则:

1. ​你可以使用技术名词。

2. 技术名称仅可以用作名词​或者形容词,不可以用作动词。

3. ​一些未经过批准的单词被用来完善技术名词,但是仅限于他们被用作技术名词的一部分的时候,否则不要使用这些未经允许的词。

4. ​尽可能的使用官方的技术名词。

5. 如果可以,简化官方技术名词。

6. ​如果你可以选择,优先使用缩写或者简称。

7. 不要使用俚语或者行话。

8. 不要对同一个东西使用不同的技术名词。

技术动词使用规则:

1. 你可以使用是技术动词的单词。

2. 技术动词仅可以作为动词来用,不要用作名词​。你可以使用动词的过去分词来用作形容词。

一致性语言和描述:

​1. 一旦你使用某个单词描述了该事物,那么请在后续的描述中使用该词进行描述。

2. 使用一致性描述。

抽象:

​尽可能是你的描述表述精确。

名词短语

名词词组​:

​1.  不要使用超过3个名词来组成名词词组。

2. ​你可以使用如下两种方式之一来澄清作为技术名词的名词词组。

- 使用字符链接符号来展示​最密切相关的词之间的关系。

- 解释名词词组。然后,在第一次解释后,接下来的描述中使用缩写。

冠词:

​适当的在名词前面使用一个冠词(a,an)或者指示词(this,these)。

动词

动词的使用形式和时态使用:

​1. 仅使用字典中规定的动词的使用形式。

2. 不要使用动词的现在进行时,除非它是作为技术名词的一部分。

3. ​仅使用中规定的动词的使用形式:

- 不定式

- ​祈使句

- 一般现在时​

- 一般过去时

- 过去分词用作形容词

- 将来时​

4. 仅可以把过去分词用作形容词,放在名词前面或者是放在动词后面,例如TO BE, TO BECOM.

5. 不要把过去时和HAVE用在一起。

6. 不要把过去时变成一个复杂的动词。

主动时态:

在步骤写作和描述中尽可能地​使用主动时态。

如何描述一个动作:

​​如果在字典中,已经有关于此动作的描述词,请使用该词。

句子

短句:

1. 一个句子只能有一个主题。

2. 不要为了使句子简短而省略词语或者​结构。

列表:

对于复杂的句子,最好使用列表来陈述。

连接词:

对于连续剧,最好使用连接词来增强上下句之间的关联关系。

​步骤

句子长度:

​1. 尽可能的保持句子的简短性,最长不要超过20个单词。

2. 每个句子只描述一个动作。

3. 仅仅在多个动作连续发生的情况下,才在一个句子中描述多个动作。

动词:

​在一个指令中,使用动词的命令行模式。

​指令中的描述性声明:

​如果你在指令的前面有一段申明性的描述,请把它与后面的指令用逗号隔开。

​描述性写作

句子长度:

​1. 尽可能的保持句子的简短性,最长不要超过25个单词。

2. 尽量使用不同的句子长度和构造来保持稳定的可读性(使读者感觉有趣)。​

段落:

​1. 使用段落来展示你文档的逻辑结构。

2. 每个段落只能有一个主题句。

3. 请把主题句摆在段落开头的位置。​

句子和段落之间的关系:

​使用关键字使句子和段落之间的关系尽可能地清晰。

段落长度:

​1. 段落最长不要超过6个句子。

2. 在每10个段落中,不要使用一句话段落超过1次。​

信息量太大:

​对于新的、复杂的信息请慢慢陈述。

警告,注意,说明

如何写作警告和注意​:

​1. 使用简单清晰的指令来开始一个告警或者注意。

2. 告警信息和注意事项要描述准确。

​3. 如果可以,请针对此告警或者注意事项可能导致的风险,给出一个解决方案。

4. ​仔细确认你作为告警和注意的指令的正确性。

5. ​如果某个条件是技术人员处理此条告警或注意的必要条件,请把它放在最前面。

如何写说明:

说明是用来增加扩展信息的,而不是给出某个指令。

​标点符号和字数统计

标点符号在字数统计中的效果:

​1. 使用冒号(:)和破折号(-)来构建列表。

2. ​在进行字数统计的时候,冒号和破折号都是算独立段落的。

3. 使用连字符作为连接信号。

4. ​当你统计字数的时候,每一个在连字符中的单词都作为独立的单词来统计,除非它是一个前缀。

5. ​圆括号的使用:

- 图例或者文档的交叉引用。

- ​按照字母或者数字来表示顺序的图例或者文档中。

- ​当使用逗号来分离文本不够用的情况下。

- ​要设置不属于主语句的文本,但是也是重要到要被展示的信息。

- ​指示步骤中的子步骤顺序时。

其他字数统计相关的规则:

​当你统计数字时:

1. 圆括号中的段落算新的一句来统计。

2. ​一个阿拉伯数字算一个单词。

3. ​一个文字数字算一个单词。

4. ​一个缩略语或者一个首字母缩写算一个单词。

5. ​一个标题,一个标牌或者一段引用都算一个单词。

不允许使用的标点符号:

​不要使用分号(;)。

​写作练习

不同的结构:

​当使用不同的单词来描述已经不满足的时候,试着使用不同的句子构造来描述。

正确使用规定的单词:

​1. 当你使用单词组合成段落时,确认你使用的单词的意思都遵循字典中的定义。

2. 正确地使用词典来获取正确地词,含义,语言。

上一篇下一篇

猜你喜欢

热点阅读