Gitbook – 用所見即所得的方式來撰寫你的產品/服務指南

用家在使用產品時遇上阻礙,大多數都會參考說明書,但若果你的產品是數碼產品,又該如何提供說明書給用戶參考呢?其實是可以利用線上文檔這類的工具,就如今次介紹的Gitbook,能夠以章節的方式助你疏理好產品介紹、使用方式、注意事項等內容,配合搜索功能,這樣的結構亦有助用家找到他們想要的資訊。

Gitbook網站

主頁:https://www.gitbook.com/

這次介紹的Gitbook為產品/服務的創作者提供一個簡易的途徑來撰寫產品/服務的指南,別看Gitbook有個book字就以為是用來寫書的哦(當然你的確可以這樣做,Gitbook.com的前身就是Gitbooks.io,有不少人真的會用來寫書),那Gitbook到底有甚麼優點呢?

Gitbook的優點

  • 使用WYSIWYG,所見即所得編輯器,方便一般人編輯
  • 有編輯修改記錄,可以追尋過去的版本
  • 可使用自訂域名,如docs.example.com
  • 免費版能創建最多十個指南,相當充裕
  • 免費版可自訂基本主題

但要注意,Gitbook目前只有簡體中文介面、英文介面或其他語言,免費版的指南左下角也會有Gitbook的標誌,亦會比付費版來得多限制,如無法團隊編輯。

示範網站

https://cjdocs.blowhk.com/

使用教學

    1. 前往註冊頁申請Gitbook帳號,可以用電郵、Google或Github帳號註冊
    2. 登入後,在控制台可以創建一個新的空間,一個空間可視為一個產品的指南
    3. 需要設置指南的主題顏色及標題
    4. 創建完成後會自動進入編輯區域,可以選擇他預設的範本或自行輸入文字及標題

      ▼添加文字及標題

      ▼Gitbook也提供不同格式的內容,如列點、引述、代碼塊、圖片等

      ▼亦可輕易透過拖拉調動各項內容的位置
    5. 可按需要添加不同分類、分頁、站外連結

      ▼可誘過拖拉方式添加子分頁

      ▼要注意,添加的分類及分頁預設的URL會是普通話拼音,如頁面一的URL是xxx.gitbook.com/fen-lei-yi,可按需求在SLUG一欄更改,如cat1
    6. 在完成部份編輯後,可按左下角的Save儲存,再按merge合併,當中可按需要添加更新的描述,方便日後追查

      ▼例子:新增主頁
    7. 修改記錄可在Activities內找到,修改人、時間、修改內容都可一目了然

      ▼點進去更可看到修改細節

自訂連結/域名

Gitbook免費計劃也支援自訂連結和域名,可以到右側欄–>Advanced–>Space URL或Custom domain。

▼自訂指南連結

▼自訂域名

若果要自訂域名,需要設置CNAME記錄,把想用的域名/子域名指向hosting.gitbook.com,如cjdocs.blowhk.com

付費版與免費版的分別

可參考價格頁面

總結

對於一般開發者或創作者來說,Gitbook可謂相當實用,若果是小型專案基本上免費版的功能都夠用,就如我開發的倉頡/速成練習工具應用指南也是用了Gitbook。

另外,若果Gitbook不夠用,又不想花太多錢買購付費版,又有時間或技術,可以考慮自行架設Bookstack,一款與Gitbook相似的開源軟體。

Author avatar
OpenserTk
https://opensertk.blowhk.com
現實中我是一個很被動的人,不過在網上就是一個樂意跟網友分享資訊的人。

發表評論

發佈留言必須填寫的電子郵件地址不會公開。

本站採用Cookies來提升你的使用體驗。