線上文件(使用者手冊、API 參考、說明中心、產品指南)可以以 PDF 或網頁 (HTML) 形式發布。格式選擇會影響使用者尋找和閱讀內容的方式、更新內容的容易程度以及內容是否在行動裝置上正常運作。兩者都有真正的優勢,許多組織將兩者用於不同的目的。

HTML 文件如何更好地工作
HTML 文件是網頁原生的。搜尋引擎對各個頁面進行索引,這意味著搜尋特定主題的使用者可以直接進入相關部分,而不必下載檔案並在其中進行搜尋。在 Google 上搜尋「如何重設產品密碼」可以將使用者直接帶到幫助內容的第 47 頁 - 這是下載連結後面的 PDF 不可能做到的。
HTML 也會適應任何螢幕。行動用戶無需縮放和滾動固定佈局頁面即可閱讀文件。無需替換文件即可更新內容 - 修復拼寫錯誤或更新螢幕截圖,並且更改會立即對所有用戶生效。 HTML 文件可以包含互動式元素:使用者可以一鍵複製的程式碼範例、可擴充部分、嵌入影片、跨所有內容的即時搜尋。
嘗試編輯PDF
無需安裝。直接在您的瀏覽器中工作。
PDF 文件的優勢
PDF 文件可以離線使用。下載手冊的使用者可以在沒有網路連線的情況下閱讀它——在飛機上、在連接有限的資料中心中,或在不允許使用電話的環境中使用設備時。對於硬體文件、工業手冊或現場使用的任何技術參考,這是一個顯著的實際優勢。
PDF 也維護可以可靠列印的固定佈局。當技術人員需要根據列印的清單或安裝指南進行工作時,每次都能正確列印的 PDF 比可能在不同瀏覽器和印表機上不可預測地重新格式化的 HTML 更好。
對於代表特定產品版本的正式文件(軟體版本 3.2 的手冊、特定產品版本的規格),PDF 建立不會變更的固定記錄。 HTML 文件始終是最新的,這通常很好,但意味著文件的歷史版本可能不會保留,除非您專門對它們進行版本控制。
可發現性:最重要的因素
對於大多數線上文件來說,可發現性是決定因素。如果用戶需要搜尋協助並透過 Google 或您網站的搜尋找到它,那麼 HTML 就會取得決定性的勝利。搜尋引擎越來越多地對 PDF 內容進行索引,但索引的粒度不那麼細 — 指向 PDF 特定頁面的搜尋結果不如直接指向回答問題的 HTML 部分的搜尋結果有用。
如果您的文件主要是透過導航(使用者已經知道去哪裡)而不是搜尋來找到的,那麼可發現性差距就不那麼重要了,其他因素就會發揮作用。
通用混合方法
許多文件團隊都發布這兩種格式。主要文件以 HTML 形式存在-可搜尋、適合行動裝置、始終最新。為想要下載完整手冊、列印手冊或保留本機副本的使用者從相同內容產生 PDF 匯出。 Sphinx、MkDocs 和 GitBook 等工具可以透過最少的額外工作從相同的來源內容產生兩個輸出。
這種混合避免了專門選擇一種格式的權衡。線上用戶可以獲得可搜尋、響應靈敏的 HTML 體驗。需要離線或可列印版本的使用者可以獲得乾淨、格式良好的 PDF。內容在一個地方維護並發佈為兩種格式,因此沒有額外的維護負擔。
何時選擇其中之一
如果符合以下條件,請選擇 HTML:文件主要線上使用、搜尋引擎可見性很重要、內容經常更改或行動存取很重要。如果符合以下條件,請選擇 PDF:使用者需要離線存取、需要列印文件、代表產品的固定版本,或需要作為獨立文件分發。對於大多數現代軟體產品和服務,具有 PDF 下載選項的 HTML 文件可以有效地涵蓋這兩個基礎。
嘗試編輯PDF
無需安裝。直接在您的瀏覽器中工作。
