一、軟件幫助文檔怎么做
對于一個軟件產品系統來說,軟件幫助文檔要讓用戶知道你的產品能做什么,怎么使用,以及遇到問題應該怎么解決,主要圍繞這三方面來填寫內容。其中,產品的簡介,一段話簡要概括產品的研發目的,使用場景等信息。
1.產品說明
產品的簡介,一段話簡要概括產品的研發目的,使用場景等信息。可以直接放在幫助文檔的首頁,讓用戶一進來就能直觀的看到。
2.操作指南
用步驟一、二、三的方式展示出怎么快速上手使用產品,內容簡潔步驟清晰,不需要添加太多描述性的話語。
3.產品功能介紹
對于產品的特點功能進行介紹,包括這個功能的作用,能夠用在什么地方,使用方法,進行簡單羅列,較好每個功能單獨放出來介紹,適當在幫助文檔中添加鏈接的方式引導到別的文章。
4.常見問題
這是幫助文檔很重要到一部分,每個問題單獨列出來,文字通俗易懂,流程清晰,文字要少,操作步驟類到盡量用圖文結合或者視頻文字結合的方式,減少用戶的閱讀難度。
5.應用案例
這方面的內容可以放在幫助文檔里面,也可以直接放在產品官網單獨列出來,幫助用戶了解你的產品,并且放上優異案例,增加用戶對產品的信任感,促進轉化付費。
延伸閱讀:
二、WIKI是什么
Wiki是一種在網絡上開放且可供多人協同創作的超文本,支持面向社群的協作式寫作,Wiki站點可以有多人(甚至任何訪問者)維護,每個人都可以發表自己的意見,或者對共同的主題進行擴展與探討。
其內容具有極高的關聯性,初始架構不好的話可能會造成內容結構零散,不好閱讀;Wiki 語法標準不一樣,不同的wiki系統采用的語法不一致,造成作者編輯困難;并且結構和頁面展示形式較難調整。使用wiki的時候需要遵循一定的準則,精心的編寫維護。