以规则为基础的技术写作——德语技术写作者

“以规则为基础的书写——德语技术写作者”指导方针发表于 2014 年初。它是为以英语写作的德语技术作者考虑的。这样一方面有了适用于英语技术文档的规定,但是是用德语书写的,明确涉及了与德语的区别。另一方面有了关于所有说德语的人在英语中所犯的错误的规定。这使得这份指导方针与存在的面向以英语为母语的人的英语技术文档指导方针有所区别。

指导方针的基本结构以德语对称物为准。这些规定以德语撰写,根据英语示例举例说明。在一项德语规定同时有内容时,会参考该规定。

该指导方针包括有关文本、句子和词汇、常规使用提示、术语表和索引的规定。

文本规定

通过标题和小标题使文本结构化。这些标题同样用于设置目录和用于在文件中定位的重要信息源。为了优化选词和标题内容,指导方针包括这方面的一些重要规定。

交叉引用负责保证读者可以从一个信息点切换到另一信息切换点,由此在文件中开辟独特的路径。技术作者必须注意,通过交叉引用不能使读者混乱,而是要引导他们。

索引是一种重要的定位源。它可以帮助读者准确找到所需要的信息——如果索引得到良好的布置。

在术语表中包含有关所使用专业概念的重要背景信息。指导方针展示了组织术语表的方法。

句子规定

下一种信息单位是句子。句子中多种含义的信息会使读者困惑。如果句子不完整,原因可能是缺少可供理解的重要信息。

另一章节涉及句子的复杂性。如果句子在语言上过于复杂,可能使读者的注意力从操作方法上偏离,使他必须先“弄明白”说明的含义。

在德语中语序相当自由,而在英语中的语序有更多规定。如果语序遵循英语标准,那么句子会更容易阅读和理解。

您可能已经知道比如避免使用被动式等风格规定,因为这也适用于其他语言,在德语技术文档的指导方针中也有类似的规定。

由于标点和动词时态的使用与德语明显不同,这些问题对于德语作者来说尤其困难,因此在该指导方针中有这方面的章节。

词语规定

在词语规定方面尤其有许多面向德语作者的规定。这包括英语语言变形方面的区别。“语言变形和风格”一章涉及英式英语和美式英语以及口语。与缩写和缩略语的处理一样,必须同样按英式或美式标准规定单位制。

另一章涉及英语中形容词复合词的构成,它与德语语法有很大的区别。指导方针另外还及动词、出现的缩写形式,比如“can’t”。

英语中的大小写虽然较德语简单,但也有一些需要遵守的标准。 有多种在英语中形成第二格的方法,比如使用“of”或撇号。介词可能是英语最复杂的语言问题之一。

对以德语为母语的人面临的特殊问题,比如所谓的“错误的朋友”,进行了单独处理。

使用“以规则为基础的书写——德语技术写作者”指导方针工作

在编排指导方针时,确保了作者一方面可以通过一个章节了解该领域的所有方面信息。另一方面,指导方针包含交叉引用、术语表和索引,这样有不同信息需求的不同的作者也可以按不同方式浏览信息。

比如介绍了保持标题中大小写一致性的多种方法。编辑人员首先要通过指导方针了解这些方法,之后再做决定。指导方针有帮助决策的作用。之后作者遵循其他有关如何在具体情况下落实所选规定的提示。在落实一项规定时,作者可能遇到不了解的语法概念,可以寻求有语法解释的术语表的帮助。如果编辑人员使用软件进行自动检查,那么他们通常会收到这种规定是否可以自动检查、在通用的工具中是否已经集成了这些规定的提示。

总结

新“以规则为基础的书写——德语技术写作者”指导方针发布于 2014 年 4 月。来自实际文档、咨询、高校、软件生产商的专家和以英语为母语的人及以德语为母语的人聚集到一起,以便为德语技术作者撰写英语文件提供支持。指导方针包括文本、句子和词语等信息单位。有不同的使用指导方针进行工作的方法——就像技术作者的信息需求不同一样。