系统性缩短文档,更少成就更多可能!

系统性缩短文档可以直接降低印刷和翻译成本。节省下来的成本用于优化文档质量和针对市场增加多种语言, 正确的缩短文档还可以提高可理解性和接受程度,并且可以在移动媒体中使用这些内容:不仅由于翻译成本提高和移动文档的原因,在阅读能力下降的背景下,技术文档的“极简”也有意义。

缩短时也会出现这样的问题:需要为哪些目标群缩短,怎样缩短?缩短哪些内容、句子、媒介?怎样一致操作?哪些表现形式可以支持缩短?库存数据发生了什么变化?想成功的缩短文档必须明确的目标、系统性的分析,同时使用不同的基本缩短方案。

删除不必要的内容

通常可以完全删除内容,因为认真探究用户群的信息需求以后发现,特定的现有信息是多余的。

好处既包括降低成本(印刷、物流、翻译和内部流程成本,比如审核费用),也包括通过专注于最佳地准备实际相关的内容提高信息质量。出发点还包括:

  • 坚持使用相关性原则:始终想一想用户为什么需要这些说明;比如产品说明只是绝对理解和排除故障所需的知识。
  • 删除不必要的前言;这可以包括图形转换、先导组织者、引言和购买确认。
  • 在说明中不包括广告信息(信号词为:“确保”、“优势”、“更好”等)——不从产品手册复制文本。
  • 减少或删除有关选装件和型号的内容(产品专用的说明书)。
  • 按法律要求的最低幅度减少内容。
  • 删除安全章节,比如免责条款、版本、参考标准、对必须遵守的法律的提示(职业联合会规定等)。

 按用户群调整信息深度

认真调查使用情况经常可以发现,没有高详细程度的文件,客户也可以实现目标。这样可以降低文本以及插图和显示的信息深度。降低信息深度通常可以出人意料地对信息质量产生正面影响。但要小心地避免超出目标范围以外。

这时同样有降低成本和提高信息质量方面的好处。但与缩短内容相反,这需要较高的编辑能力。与编辑工作相伴的可用性测试在这时可以成为编辑培训有价值的组成部分。

出发点还包括:

  • 降低插图和显示的信息深度;这一方案通常会对质量产生影响。
  • 按用户组的能力调整信息深度;继续发展用户组的能力,数十年前的文本通常都是多余的。
  • 考虑探究学习;不能逐步规定所有内容,而是使用户“进入正确的方向”。这一方案通常适用于软件文档,通常与优化软件界面(GUI)联系在一起。
  • 使用操作说明取代逐步说明;尤其是专业人员通常只需要特定的详细信息进行操作。按逐步原则详细展示通常是不必要的,也不与目标相符。
  • 降低图片的详细程度;这时会提高图片的加工费用,但通常也会产生更高的重复使用率,以及使减少后的图片产生更低的修改需求。只展示重要信息的图片无疑对客户更为有利。与这一观点相互配合选择恰当类型的图片、比照图像的照片,不应教条,而是应差异化地进行选择。

丰富信息

通常不需要其他调查就可以丰富信息,完全按编辑观点操作,不需要讨论内容范围。

在所有领域都可以感受到其好处,从节省成本到更好的信息质量。

出发点还包括:

  • 规定简短的表达样例:没有被动式、没有缀词和补助语、简单明了的表述(尤其是在表中)。
  • 使用更多表格。
  • 坚持以所谓的主题-述位结构进行说明。
  • 删除不必要的词组和词语。
  • 严格地补充使用文本和图片;比如纯图片的结构说明和包括作为主要媒介的图片的装配说明书。
  • 丰富平面图;这一方案只影响印刷和物流成本,可能快速干扰质量。比如:更少的空白区域、空页、页面中开头的章节、小字、多栏版面设计。

优化划分

经过优化的划分通常可以使文本整体上变得更加简短。出发点还包括:

  • 避免冗余;比如不能重复日常工作和操作示意图,而是清除,或者不将技术参数保存在文本中,而是集中保存。但这一出发点通常是经济性和信息质量间的妥协。只要不是分散的信息范围(尤其是打印信息),重新使用和唯一来源解决方案对此都会有帮助。
  • 在安全章节中说明一次危险,而不是持续重复;为此必须在选择性阅读时探究安全入门的范例。但进行这种讨论是值得的,必要时要通过相应的法律能力提供支持。
  • 删除多语言说明书中的插图。
  • 根据用户组的信息需求优化信息产品之间的内容限制。
  • 按目标群的视角为信息产品分配内容,优化内容的逻辑、使用时间和准备成本。

其他缩短方案

其他缩短方案包括

  • 减少语言;但这通常与合理的趋势相反,仅在少数情况下可以成为一个选项。更应将从其他缩短方案获得的操作空间用于提供其他语言。
  • 提高信息的重复使用率,比如通过优化模块。降低详细程度也属于这一操作领域。
  • 删除电子媒介中的内容;这一方案不是直接缩短,但可以产生极大的潜力,因为不仅能降低印刷和物流成本,还能极大地降低流程成本,比如通过修改和更新内容。另外,可以使电子信息提高用户友好性、媒体多样性和访问方式。

缩短项目

为了能成功运行缩短项目,必须

  • 明确定义目标;
  • 系统性地分析信息,比如使用问题类型和计算机语言检测程序分析方法;
  • 提交数量明细表,以便能推测影响;
  • 使信息和编辑流程透明,以便能评估组织后果。

之后必须以分析为基础认真选择缩短方案。

仅有经济性层面的论据可能比较困难,因为现有文本和现有翻译内容的负担更重。因此某些企业又必须重新取消当初兴高采烈开展的缩短项目,因为编辑和重新翻译成本过高,并且未明确突出大量的好处,比如客户关系、改善内部沟通等。