Tech-Support 文件共筆需要你

在公司打拼的您，是否有過以下經驗?

  1. 遇到問題卻沒人可問，或不敢問?
  2. Help有時又長又分散，很難跟著做?
  3. 英文看不懂，只好放棄?
  4. 問題解決了，但不知道怎麼分享解方式?
  5. 解決過的問題，下次遇到時，又要找很久才能解決?

如果上述情況您經常遇到，請加入我們的行列，一起打造美好的中文查詢系統(Orz)，讓未來的您萬事皆可達，變有錢爸媽(*￣▽￣)/‧☆*」』*-.,_,.-*』」*-.,_☆)!

共筆工具介紹

市面上文件共筆方案有很多，但完成的文件可以兼具美觀、好瀏覽，又具備全文檢索功能的工具卻不多。本篇要介紹的共筆方式，是使用ReadtheDocs網站作為文件管理系統，文件成果為響應式網頁，不同裝置在閱讀上都能有良好的體驗。ReadtheDocs還可以使用中文全文檢索，方便閱讀者查詢相關文章，是網路文件服務的好選擇。

ReadtheDocs網站使用reStructuredText (.rst) 格式文件作為來源文件，文件經過網站內建程式自動轉換後，就會成為美觀的網頁，並具有全文查詢功能。

實務上，我們會把做好的reStructuredText (.rst) 文件存放在Github網站上，然後ReadtheDocs網站自動偵測Github網站上文件異動狀況。一有異動，ReadtheDocs就立刻重新製作成果網頁，因此文件製作人員只需要專心做兩件事：

  1. 編輯文件內容
  2. 將文件推送到Github上

IMG1

reStructuredText (.rst) 文件製作方式

由於ReadtheDocs使用reStructuredText格式文件作為來源文件，因此在文件製作上有以下幾種方式：

  1. 直接撰寫reStructuredText文件
  2. 使用Google文件編輯內容，再轉檔成reStructuredText格式
  3. 使用Word編輯內容，再轉檔成reStructuredText格式

Github使用方式

編輯好的reStructuredText文件要推送到Github上，ReadtheDocs才能偵測文件異動狀況。推送文件到Github上有幾種方便的方式：

  1. 使用Github for Desktop進行推送
  2. 使用GGEditor進行推送

共筆流程

統整一下reStructuredText (.rst) 文件製作方式與Github使用方式兩節的內容，筆者歸納出以下三種共筆方式供您參考：

方式 編輯工具 轉檔工具 Github推送工具 難易度
1

文字編輯器

  • Sublime Text
  • Notepad++
 無 Github for Desktop 難
2 Google 文件 GGEditor GGEditor 簡單
3 Word Pandoc Github for Desktop 中等

三種共筆方式的完整步驟，可以參考以下文件。筆者推薦各位使用第2種Google文件共筆方式，讓您省時又省力!