需求:類似 MS Word F1 說明,支援線上閱讀、線上更新內容,前端以 HTML 呈現。傳統方案使用編輯器產出 HTML 存資料庫,前端讀取渲染。本文對比傳統 CHM 方案與現代 Web 方案,給出技術選型建議。
| 維度 | 傳統 CHM (HTML Help Workshop) | 現代 Web 方案 |
|---|---|---|
| 編輯體驗 | 需安裝 Workshop,編輯器較簡陋 | 可接入富文本編輯器(TinyMCE、CKEditor、TipTap),所見即所得 |
| 部署方式 | 編譯成 .chm 檔,客戶端需下載/解壓 | 靜態站點部署(Nginx/CDN)或動態渲染,瀏覽器直接訪問 |
| 線上更新 | 需重新編譯分發 .chm,用戶需重新下載 | 後台發布即時生效,支援版本控制、灰度發布 |
| 跨平台 | 僅 Windows 原生支援,Mac/Linux 需第三方閱讀器 | 全平台瀏覽器通用,響應式適配移動端 |
| 搜索/SEO | 依賴 CHM 內建索引,無 SEO | 可接入 Algolia/ElasticSearch,搜尋引擎可收錄 |
| 維護成本 | 工具鏈老舊,擴展困難 | 前後端分離,生態豐富,易擴展 |
GET /docs/:slug、POST /docs(編輯器保存)# 1. 後端構建鏡像
docker build -t doc-api ./backend
# 2. 前端構建靜態資源
npm run build --prefix frontend
# 3. Nginx 反向代理 + 靜態資源服務
# 4. CI/CD 自動化部署
參考經典教程:HTML Help Workshop 入門,半天可產出 .chm。但長期維護請直接上現代 Web 架構。
「編輯器 → 資料庫 → HTML 呈現」是正確直覺。拋棄 CHM,擁抱 前後端分離 + 富文本編輯器 + 靜態站點生成 (SSG),即可獲得最佳的編寫體驗、即時更新能力與跨平台訪問體驗。