From 7cbe274facee2703df39af985b8b5d64cb496ff5 Mon Sep 17 00:00:00 2001 From: "Xingyu.Wang" Date: Fri, 18 May 2018 17:07:22 +0800 Subject: [PATCH] PRF:20171221 How to create mobile-friendly documentation.md @MjSeven --- ...to create mobile-friendly documentation.md | 34 ++++++++++--------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/translated/tech/20171221 How to create mobile-friendly documentation.md b/translated/tech/20171221 How to create mobile-friendly documentation.md index 61efa2bca1..66900d2e07 100644 --- a/translated/tech/20171221 How to create mobile-friendly documentation.md +++ b/translated/tech/20171221 How to create mobile-friendly documentation.md @@ -1,15 +1,17 @@ 如何创建适合移动设备的文档 ===== -to 校正：原文章中有些右侧的 tag，出现在仓库文章中，这些没有翻译 + +> 帮助用户在智能手机或平板上快速轻松地找到他们所需的信息。 ![配图](https://opensource.com/sites/default/files/styles/image-full-size/public/lead-images/idea_innovation_mobile_phone.png?itok=RqVtvxkd) -我并不是完全相信[移动为先][1]的理念，但是我确实发现更多的人使用只能手机和平板电脑等移动设备来获取信息。这包括在线的软件和硬件文档，但它们大部分都是冗长的，不适合小屏幕。通常情况下，它的伸缩性不太好，而且很难导航。 -当用户使用移动设备访问文档时，他们通常需要迅速获取信息以了解如何执行任务或解决问题，他们不想通过看似无尽的页面来寻找他们需要的特定信息。幸运的是，解决这个问题并不看来。以下是一些提示，可以帮助你构建文档以满足移动阅读器的需求。 +我并不是完全相信[移动为先][1]的理念，但是我确实发现更多的人使用智能手机和平板电脑等移动设备来获取信息。这包括在线的软件和硬件文档，但它们大部分都是冗长的，不适合小屏幕。通常情况下，它的伸缩性不太好，而且很难导航。 + +当用户使用移动设备访问文档时，他们通常需要迅速获取信息以了解如何执行任务或解决问题，他们不想通过看似无尽的页面来寻找他们需要的特定信息。幸运的是，解决这个问题并不难。以下是一些技巧，可以帮助你构建文档以满足移动阅读器的需求。 ### 简短一点 -这意味着简短的句子，简短的段落和简短的程序。你不是在写一部长篇小说或一段长新闻。使你的文档简洁。尽可能使用少量的语言来获得想法和信息。 +这意味着简短的句子，简短的段落和简短的流程。你不是在写一部长篇小说或一段长新闻。使你的文档简洁。尽可能使用少量的语言来获得想法和信息。 以广播新闻报道为示范：关注关键要素，用简单直接的语言对其进行解释。不要让你的读者在屏幕上看到冗长的文字。 @@ -17,16 +19,16 @@ to 校正：原文章中有些右侧的 tag，出现在仓库文章中，这些 ### 主题 -在技术写作的世界里，主题是独立的，独立的信息块。每个主题都包含你网站上的单个页面。读者应该能从特定的主题中获取他们需要的信息 -- 并且只是那些信息。要做到这一点，选择哪些主题要包含在文档中并决定如何组织它们： +在技术写作的世界里，主题是独立的，独立的信息块。每个主题都由你网站上的单个页面组成。读者应该能从特定的主题中获取他们需要的信息 -- 并且只是那些信息。要做到这一点，选择哪些主题要包含在文档中并决定如何组织它们： -### 考虑 DITA +### DITA -[Darwin Information Typing Architecture][2] 或 DITA 是用于编写和发布的一个 XML 模型。它在技术写作中被[广泛采用][3]，特别是对于教程的文档集。 +[达尔文信息类型化体系结构][2]Darwin Information Typing Architecture （DITA） 是用于编写和发布的一个 XML 模型。它[广泛采用][3]在技术写作中，特别是作为较长的文档集中。 我并不是建议你将文档转换为 XML（除非你真的想）。相反，考虑将 DITA 的不同类型主题的概念应用到你的文档中： * 一般：概述信息 -* 任务：分布程序 +* 任务：分步骤的流程 * 概念：背景或概念信息 * 参考：API 参考或数据字典等专用信息 * 术语表：定义术语 @@ -34,19 +36,19 @@ to 校正：原文章中有些右侧的 tag，出现在仓库文章中，这些 你会得到很多单独的页面。要连接这些页面： -### 考虑链接 +### 链接 -许多内容管理系统，维基和发布框架都包含某种形式的导航 - 通常是目录或[面包屑][4]，这是一种在移动设备上淡入背景的导航。 +许多内容管理系统、维基和发布框架都包含某种形式的导航 —— 通常是目录或[面包屑导航][4]，这是一种在移动设备上逐渐消失的导航。 -为了加强导航，在主题之间添加明确的链接。将这些链接放在每个主题末尾的标题**另请参阅**或**相关主题**。每个部分应包含两到五个链接，指向与当前主题相关的概述，概念和参考主题。 +为了加强导航，在主题之间添加明确的链接。将这些链接放在每个主题末尾的标题**另请参阅**或**相关主题**。每个部分应包含两到五个链接，指向与当前主题相关的概述、概念和参考主题。 -如果你需要指向文档集之外的信息，请确保链接在浏览器新的选项中打开。这将把读者送到另一个网站，同时也将读者留你的网站上。 +如果你需要指向文档集之外的信息，请确保链接在浏览器新的选项卡中打开。这将把读者送到另一个网站，同时也将读者继续留你的网站上。 这解决了文本问题，那么图片呢？ -### 考虑不使用图片 +### 不使用图片 -除少数情况之外，图片不会增加太多文档。仔细查看文档中的每个图片，然后问自己： +除少数情况之外，不应该加太多图片到文档中。仔细查看文档中的每个图片，然后问自己： * 它有用吗？ * 它是否增强了文档？ @@ -60,7 +62,7 @@ to 校正：原文章中有些右侧的 tag，出现在仓库文章中，这些 ### 最后的想法 -通过较少的努力，你就可以构建文档以便移动设备用户很好的阅读。另外还有：这些更改也改进了桌面计算机和笔记本电脑用户的文档。 +通过少量努力，你就可以构建适合移动设备用户的文档。此外，这些更改也改进了桌面计算机和笔记本电脑用户的文档体验。 -------------------------------------------------------------------------------- @@ -69,7 +71,7 @@ via: https://opensource.com/article/17/12/think-mobile 作者：[Scott Nesbitt][a] 译者：[MjSeven](https://github.com/MjSeven) -校对：[校对者ID](https://github.com/校对者ID) +校对：[wxy](https://github.com/wxy) 本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译，[Linux中国](https://linux.cn/) 荣誉推出