如何创建移动设备友好的文档

帮助用户在智能手机或平板电脑上快速轻松地找到他们需要的信息。
351 位读者喜欢这篇文章。
How to turn a Raspberry Pi into an eBook server

Opensource.com

我不太认同移动优先的整个理念,但我知道越来越多的人正在使用智能手机和平板电脑等移动设备随时随地获取信息。这包括在线软件和硬件文档,其中大部分内容冗长且不太适合小屏幕。通常,它们无法正确缩放,并且可能难以导航。

当人们使用移动设备访问文档时,他们通常想要快速获取信息,以了解如何执行任务或解决问题。他们不想在看似无休止的页面中跋涉,以找到他们需要的特定信息。幸运的是,解决这个问题并不难。以下是一些技巧,可帮助您构建文档以满足移动读者的需求。

考虑简短

这意味着简短的句子、简短的段落和简短的步骤。您不是在写小说或长篇新闻报道。使您的文档简洁明了。尽可能少用文字来传达想法和信息。

以广播新闻报道为指南:关注关键要素,并用简单、直接的语言解释它们。不要让读者在屏幕上一页又一页地浏览冗长的文本。

关注关键要素,并用简单、直接的语言解释它们。
此外,直奔主题。关注读者在需要时所需的信息。在线发布的文档不应像过去那样厚厚的手册。不要将所有内容都堆积在一个页面上。将您的信息分解成更小的块。以下是如何做到这一点

考虑主题

在技术写作领域,主题是独立的、独立的信息块。每个主题都包含您网站上的一个页面。读者应该能够从特定主题中获得他们需要的信息——并且仅限该信息。为了实现这一点,请选择要包含在文档中的主题,并决定如何组织它们

考虑 DITA

Darwin 信息类型化架构,或 DITA,是一种用于编写和发布的 XML 模型。它在技术写作领域已被广泛采用,特别是对于较长的文档集。

我并不是建议您将文档转换为 XML(除非您真的想这样做)。相反,请考虑将 DITA 的单独主题类型的概念应用于您的文档

  • 通用:概述信息
  • 任务:逐步操作步骤
  • 概念:背景或概念信息
  • 参考:专门信息,如 API 参考或数据字典
  • 术语表:定义术语
  • 故障排除:有关用户可能遇到的问题以及如何修复它们的信息

您最终会得到很多单独的页面。要连接这些页面

考虑链接

许多内容管理系统、维基和发布框架都包含某种形式的导航——通常是目录或面包屑导航。这种导航在移动设备上会淡化背景。

为了更强大的导航,在主题之间添加显式链接。将这些链接放在每个主题的末尾,标题为另请参阅相关主题。每个部分应包含两到五个链接,指向与当前主题相关的概述、概念和参考主题。

如果您需要指向文档集之外的信息,请确保链接在新浏览器选项卡中打开。这会将读者发送到另一个站点,同时也将他们保留在您的站点上。

如果您需要指向文档集之外的信息,请确保链接在新浏览器选项卡中打开。
文本部分就完成了。那么图形呢?

考虑朴素

除了一些例外,图像对文档没有太大帮助。批判性地查看文档中的每个图像。然后问

  • 它有作用吗?
  • 它能增强文档效果吗?
  • 如果我删除此图像,读者会错过它吗?

除了一些例外,图像对文档没有太大帮助。
如果这些问题的答案都是,请删除该图像。

另一方面,如果您绝对离不开图像,请使其响应式。这样,图像将自动调整大小以适应较小的屏幕。

如果您仍然不确定是否使用图像,Opensource.com 社区版主 Ben Cotton 提供了一个关于何时在文档中使用屏幕截图的精彩解释

最后的想法

稍加努力,您就可以构建文档,使其非常适合移动设备用户。另一个优点:这些更改也改进了桌面计算机和笔记本电脑用户的文档体验。

标签
That idiot Scott Nesbitt ...
我长期使用免费/开源软件,并为乐趣和利润而写作各种东西。我没有把自己看得那么严肃,我所有的特技都是自己完成的。

2 条评论

写得好,Scott。我发现自己已经同意您的许多观点,并且也学到了一些东西。我想补充的一个观点是我没有看到的是,PDF 很少是电子文档的好选择。当我将保存为 PDF 而不是 epub 或 HTML 的文档下载到手机时,我会感到畏缩,因为文档的静态文本到页面的比例将需要我不断地缩放和滚动。阅读格式设置为在各种屏幕尺寸上查看的文档是如此容易!

我完全同意您的观点。事实上,本文的前几个草稿包含一个部分,解释了为什么您应该提供 EPUB 版本来代替/补充 PDF。遗憾的是,我超出了字数限制,所以我不得不删减了它。

PDF 绝对不是一种移动设备友好的格式。对于布局密集的 PDF 尤其如此,正如您所提到的,它们需要在较小的屏幕上进行大量滚动和缩放。

回复 作者: LipstickLiberty

知识共享许可协议本作品根据知识共享署名-相同方式共享 4.0 国际许可协议获得许可。
© . All rights reserved.