如何建立適合移動裝置的文件

技術小能手發表於2018-05-18

我並不是完全相信移動為先的理念,但是我確實發現更多的人使用智慧手機和平板電腦等移動裝置來獲取資訊。這包括線上的軟體和硬體文件,但它們大部分都是冗長的,不適合小螢幕。通常情況下,它的伸縮性不太好,而且很難導航。

當使用者使用移動裝置訪問文件時,他們通常需要迅速獲取資訊以瞭解如何執行任務或解決問題,他們不想通過看似無盡的頁面來尋找他們需要的特定資訊。幸運的是,解決這個問題並不難。以下是一些技巧,可以幫助你構建文件以滿足移動閱讀器的需求。

簡短一點

這意味著簡短的句子,簡短的段落和簡短的流程。你不是在寫一部長篇小說或一段長新聞。使你的文件簡潔。儘可能使用少量的語言來獲得想法和資訊。

以廣播新聞報導為示範:關注關鍵要素,用簡單直接的語言對其進行解釋。不要讓你的讀者在螢幕上看到冗長的文字。

另外,直接切入重點。關注讀者需要的資訊。線上釋出的文件不應該像以前厚厚的手冊一樣。不要把所有東西都放在一個頁面上,把你的資訊分成更小的塊。接下來是怎樣做到這一點:

主題

在技術寫作的世界裡,主題是獨立的,獨立的資訊塊。每個主題都由你網站上的單個頁面組成。讀者應該能從特定的主題中獲取他們需要的資訊 — 並且只是那些資訊。要做到這一點,選擇哪些主題要包含在文件中並決定如何組織它們:

DITA

達爾文資訊型別化體系結構Darwin Information Typing Architecture (DITA) 是用於編寫和釋出的一個 XML 模型。它廣泛採用在技術寫作中,特別是作為較長的文件集中。

我並不是建議你將文件轉換為 XML(除非你真的想)。相反,考慮將 DITA 的不同型別主題的概念應用到你的文件中:

  • 一般:概述資訊
  • 任務:分步驟的流程
  • 概念:背景或概念資訊
  • 參考:API 參考或資料字典等專用資訊
  • 術語表:定義術語
  • 故障排除:有關使用者可能遇到的問題以及如何解決問題的資訊

你會得到很多單獨的頁面。要連線這些頁面:

連結

許多內容管理系統、維基和釋出框架都包含某種形式的導航 —— 通常是目錄或麵包屑導航,這是一種在移動裝置上逐漸消失的導航。

為了加強導航,在主題之間新增明確的連結。將這些連結放在每個主題末尾的標題另請參閱相關主題。每個部分應包含兩到五個連結,指向與當前主題相關的概述、概念和參考主題。

如果你需要指向文件集之外的資訊,請確保連結在瀏覽器新的選項卡中開啟。這將把讀者送到另一個網站,同時也將讀者繼續留你的網站上。

這解決了文字問題,那麼圖片呢?

不使用圖片

除少數情況之外,不應該加太多圖片到文件中。仔細檢視文件中的每個圖片,然後問自己:

  • 它有用嗎?
  • 它是否增強了文件?
  • 如果刪除它,讀者會錯過這張圖片嗎?

如果回答否,那麼移除圖片。

另一方面,如果你絕對不能沒有圖片,就讓它變成響應式的。這樣,圖片就會自動調整以適應更小的螢幕。

如果你仍然不確定圖片是否應該出現,Opensource.com 社群版主 Ben Cotton 提供了一個關於在文件中使用螢幕截圖的極好的解釋

最後的想法

通過少量努力,你就可以構建適合移動裝置使用者的文件。此外,這些更改也改進了桌面計算機和膝上型電腦使用者的文件體驗。

原文釋出時間為:2018-05-18

本文作者:Scott Nesbitt

本文來自雲棲社群合作伙伴“Linux中國開源社群”,瞭解相關資訊可以關注“Linux中國開源社群”。


相關文章