用户文档要考虑的5个主要文本指标
by ClickHelp —专业的帮助创作工具 最近,我们在此博客上多次提到可读性。 难怪,随着UX写作等现代趋势的发展,这已经成为可能的技术写作团队关注的焦点。 幸运的是,可读性并不是那么抽象,实际上可以将其分解为非常具体的元素。 今天,我们将讨论五个文本指标,创建更好的用户手册时需要考虑这些五个指标,以便更容易理解。 技术文档倾向于包含过多的术语,新用词和缩写。 这可能会妨碍读者充分理解文本。 此外,这也是用户不喜欢技术文档的原因之一-解释所有未知的词和概念会花费太多时间。 用户手册中的术语和新词很难避免,因为技术文档基于非常具体的领域和主题。 但是,有一些方法可以使所有没有准备的读者都更轻松。 所有术语和新词都应以简单的语言进行解释。 为了帮助读者处理在线文档中的难题,您可以: 在用户手册中创建链接和交叉引用 添加带有深入解释的文本隐藏部分 创建网络帮助泡泡 制作词汇表以供参考…