我不太认同移动优先的整个理念,但我知道现在有越来越多的人使用智能手机和平板电脑等移动设备来随时随地获取信息。这包括在线软件和硬件文档,其中大部分内容冗长,不太适合小屏幕。通常,它们无法正确缩放,并且难以导航。
当人们使用移动设备访问文档时,他们通常希望快速获取信息,以了解如何执行任务或解决问题。他们不想浏览看似无休止的页面来找到他们需要的特定信息。幸运的是,解决这个问题并不难。以下是一些技巧,可帮助您构建文档以满足移动读者的需求。
考虑简短
这意味着简短的句子、简短的段落和简短的步骤。您不是在写小说或长篇新闻报道。使您的文档简洁明了。尽可能少用文字来传达想法和信息。
以无线电新闻报道为指南:关注关键要素,并用简单、直接的语言解释它们。不要让您的读者浏览一屏又一屏冗长的文本。
此外,直奔主题。关注读者在需要时所需的信息。在线发布的文档不应类似于过去厚厚的说明书。不要将所有内容都堆放在一个页面上。将您的信息分解成更小的块。以下是如何做到这一点考虑主题
在技术写作领域,主题是独立的、独立的信息块。每个主题都包含您网站上的单个页面。读者应该能够从特定主题中获得他们需要的信息——并且仅限于该信息。为了实现这一点,请选择要包含在文档中的主题,并决定如何组织它们
考虑 DITA
达尔文信息类型化架构,或 DITA,是一种用于编写和发布的 XML 模型。它在技术写作领域已被广泛采用,尤其是在较长的文档集中。
我并不是建议您将文档转换为 XML(除非您真的想这样做)。相反,请考虑将 DITA 的单独主题类型的概念应用于您的文档
- 通用:概述信息
- 任务:逐步程序
- 概念:背景或概念性信息
- 参考:专业信息,如 API 参考或数据字典
- 词汇表:定义术语
- 故障排除:有关用户可能遇到的问题以及如何解决这些问题的信息
您最终会得到很多单独的页面。要连接这些页面
考虑链接
许多内容管理系统、维基和发布框架都包含某种形式的导航——通常是目录或面包屑导航。这是一种在移动设备上会淡化背景的导航类型。
为了更强大的导航,在主题之间添加显式链接。将这些链接放在每个主题的末尾,标题为另请参阅或相关主题。每个部分应包含两到五个链接,指向与当前主题相关的概述、概念和参考主题。
如果您需要指向文档集之外的信息,请确保链接在新浏览器选项卡中打开。这会将读者发送到另一个站点,同时也将他们留在您的站点上。
文本方面就处理完了。那么图形呢?考虑朴素
除了一些例外,图像对文档的帮助不大。批判性地查看文档中的每个图像。然后问
- 它是否有用?
- 它是否增强了文档?
- 如果我删除此图像,读者会错过它吗?
另一方面,如果您绝对离不开图像,请使其响应式。这样,图像将自动调整大小以适应较小的屏幕。
如果您仍然不确定是否使用图像,Opensource.com 社区版主 Ben Cotton 提供了一个关于何时在文档中使用屏幕截图的出色解释。
最后的想法
稍加努力,您就可以构建您的文档,使其在移动设备用户上也能良好运行。另一个优点:这些更改也改善了桌面电脑和笔记本电脑用户的文档体验。
2 条评论