如何創建適合移動設備的文檔
我並不是完全相信移動為先的理念,但是我確實發現更多的人使用智能手機和平板電腦等移動設備來獲取信息。這包括在線的軟體和硬體文檔,但它們大部分都是冗長的,不適合小屏幕。通常情況下,它的伸縮性不太好,而且很難導航。
當用戶使用移動設備訪問文檔時,他們通常需要迅速獲取信息以了解如何執行任務或解決問題,他們不想通過看似無盡的頁面來尋找他們需要的特定信息。幸運的是,解決這個問題並不難。以下是一些技巧,可以幫助你構建文檔以滿足移動閱讀器的需求。
簡短一點
這意味著簡短的句子,簡短的段落和簡短的流程。你不是在寫一部長篇小說或一段長新聞。使你的文檔簡潔。儘可能使用少量的語言來獲得想法和信息。
以廣播新聞報道為示範:關注關鍵要素,用簡單直接的語言對其進行解釋。不要讓你的讀者在屏幕上看到冗長的文字。
另外,直接切入重點。關注讀者需要的信息。在線發布的文檔不應該像以前厚厚的手冊一樣。不要把所有東西都放在一個頁面上,把你的信息分成更小的塊。接下來是怎樣做到這一點:
主題
在技術寫作的世界裡,主題是獨立的,獨立的信息塊。每個主題都由你網站上的單個頁面組成。讀者應該能從特定的主題中獲取他們需要的信息 -- 並且只是那些信息。要做到這一點,選擇哪些主題要包含在文檔中並決定如何組織它們:
DITA
達爾文信息類型化體系結構 (DITA) 是用於編寫和發布的一個 XML 模型。它廣泛採用在技術寫作中,特別是作為較長的文檔集中。
我並不是建議你將文檔轉換為 XML(除非你真的想)。相反,考慮將 DITA 的不同類型主題的概念應用到你的文檔中:
- 一般:概述信息
- 任務:分步驟的流程
- 概念:背景或概念信息
- 參考:API 參考或數據字典等專用信息
- 術語表:定義術語
- 故障排除:有關用戶可能遇到的問題以及如何解決問題的信息
你會得到很多單獨的頁面。要連接這些頁面:
鏈接
許多內容管理系統、維基和發布框架都包含某種形式的導航 —— 通常是目錄或麵包屑導航,這是一種在移動設備上逐漸消失的導航。
為了加強導航,在主題之間添加明確的鏈接。將這些鏈接放在每個主題末尾的「另請參閱」或「相關主題」的標題處。每個部分應包含兩到五個鏈接,指向與當前主題相關的概述、概念和參考主題。
如果你需要指向文檔集之外的信息,請確保鏈接在瀏覽器新的選項卡中打開。這將把讀者送到另一個網站,同時也將讀者繼續留你的網站上。
這解決了文本問題,那麼圖片呢?
不使用圖片
除少數情況之外,不應該加太多圖片到文檔中。仔細查看文檔中的每個圖片,然後問自己:
- 它有用嗎?
- 它是否增強了文檔?
- 如果刪除它,讀者會錯過這張圖片嗎?
如果回答否,那麼移除圖片。
另一方面,如果你絕對不能沒有圖片,就讓它變成響應式的。這樣,圖片就會自動調整以適應更小的屏幕。
如果你仍然不確定圖片是否應該出現,Opensource.com 社區版主 Ben Cotton 提供了一個關於在文檔中使用屏幕截圖的極好的解釋。
最後的想法
通過少量努力,你就可以構建適合移動設備用戶的文檔。此外,這些更改也改進了桌面計算機和筆記本電腦用戶的文檔體驗。
via: https://opensource.com/article/17/12/think-mobile
作者:Scott Nesbitt 譯者:MjSeven 校對:wxy
本文轉載來自 Linux 中國: https://github.com/Linux-CN/archive