開發者必知 製作標準使用者手冊的15條技巧

2021-08-29 15:01:03 字數 1248 閱讀 1004

於是智慧型文字管理應運而生。智慧型文字管理理解終端使用者的行為,並在多數可能的實際行為中與使用者需求保持一致。在本文中,我將提供一些實際技巧,幫助你建立合適、易懂、可讀性強的使用者手冊。

了解你的讀者

了解手冊的讀者是誰,讀者需要了解什麼內容。這樣你就可以決定手冊內容的深度與廣度,以及編寫手冊應使用何種語言(例如,針對專家與初學者的語言與內容都有所不同)。關鍵在於只提供使用者需要的資訊——不多也不少。

採用面向任務的方法

多數產品的功能體現在允許使用者實現特殊的任務。採取面向任務的方法,根據應用產品能夠執行的任務來安排手冊內容。例如,如果產品幫助你配置網路,你的手冊目錄應包含這樣的標題,如「建立乙個網路」、「配置網路設定」及「刪除網路」。

確保資訊流程合乎邏輯

仔細研究一下產品,以循序漸進的方式了解先做什麼、接著做什麼、最後做什麼。這樣做可以大大改進檔案資訊的易讀性。

應用模組

應用目錄

目錄可幫助我們了解手冊的整體內容。保證手冊內容全面、結構完整、並擁有乙個模組化的布局。這種方法可幫助使用者方便找到他們所需要的資訊。

應用有意義的一致標籤

清晰且提供資訊的標籤可幫助使用者快速而正確的找到資訊。避免使用一般的標籤標題,標籤應簡明扼要。

以交談式的語調書寫

採用常見問答(faq)的編寫方法。這種方法允許你輕而易舉地縮短使用者與產品之間的差距,並提供許多使用者需要的通用資訊。

仔細考慮重要資訊的位置

首先檢視頁面或螢幕的中部,然後是左上角,是人類的本性。盡量將材料的重點內容安排在布局的物理中心附近,並將主標題安排在左上角。

應用適當的插圖

盡可能將資訊製成**

**可改善資訊的可讀性。在需要根據不同的基礎描述物件,或在不同的維度間比較物件時,可應用**。

提供例項

用類推、例項或個案研究來證明你的概念與說明。例項有助於使用者迅速掌握概念,並更好地理解其內容。

包含解決問題的提示

建立很好的索引

編輯與審核

對材料進行編輯,保證它遵守完整性、語言、拼寫與語法、連貫性與格式方面的規則。

執行「現實檢查」

確保對材料與產品進行協同測試,以揭示書面材料與現實應用之間的差異。對揭示的差異進行糾正,並重複測試過程,保證在糾正過程中不會出現新錯誤。

顧客支援

記住,使用者手冊的主要目的在於提高使用者的生產效率,減少顧客支援時間、成本與努力。優質的材料可作為新使用者的培訓材料,以及返回使用者的支援材料。遵守上述指導方針可保證資訊的訪問性與可用性,減少支援時間,提高顧客滿意度。

Android開發者必知的開發資源

隨著android平台市場份額的持續猛增 越來越多的開發者開始投入android應用程式的開發大潮。如果您是一位2013年剛剛入行的android開發新兵,恭喜你,因為這個平台已經在過去幾年裡變得愈發成熟了,絕對值得住你全情投入。目前來看,android現成的開發資源早已經汗牛充棟,我們這篇帖子,就...

Android開發者必知的開發資源

隨著android平台市場份額的持續猛增 越來越多的開發者開始投入android應用程式的開發大潮。如果您是一位2013年剛剛入行的android開發新兵,恭喜你,因為這個平台已經在過去幾年裡變得愈發成熟了,絕對值得住你全情投入。目前來看,android現成的開發資源早已經汗牛充棟,我們這篇帖子,就...

Android開發者必知的開發資源

隨著android平台市場份額的持續猛增 越來越多的開發者開始投入android應用程式的開發大潮。如果您是一位2013年剛剛入行的android開發新兵,恭喜你,因為這個平台已經在過去幾年裡變得愈發成熟了,絕對值得住你全情投入。目前來看,android現成的開發資源早已經汗牛充棟,我們這篇帖子,就...