跳至主要内容

📦 專案交付說明

交付給客戶的檔案清單​

✅ 必須包含的檔案/資料夾​

tm-docs/
├── docs/                    # ✅ 文檔內容（最重要！）
├── static/                  # ✅ 靜態資源（圖片等）
├── src/                     # ✅ 自訂元件和樣式
├── docusaurus.config.js     # ✅ 網站配置
├── sidebars.js              # ✅ 側邊欄配置
├── package.json             # ✅ 專案依賴清單
├── package-lock.json        # ✅ 鎖定版本（建議包含）
├── 開啟文件管理系統.bat      # ✅ Windows 批次檔
├── 開啟文件管理系統.sh       # ✅ Mac/Linux 腳本
├── README_客戶使用指南.md    # ✅ 客戶使用指南
├── 文檔編輯指南.md          # ✅ 編輯指南
├── Markdown快速參考.md      # ✅ 語法參考
└── README.md                # ✅ 專案說明

❌ 不需要包含的檔案/資料夾​

tm-docs/
├── node_modules/            # ❌ 不需要（太大，客戶需自行安裝）
├── build/                  # ❌ 不需要（可重新建置）
├── .docusaurus/            # ❌ 不需要（自動生成）
└── .cache-loader/           # ❌ 不需要（自動生成）

📋 打包步驟​

方法 1：手動打包（推薦）​

  1. 清理不需要的檔案

    • 刪除 node_modules/ 資料夾（如果存在）
    • 刪除 build/ 資料夾（如果存在）
    • 刪除 .docusaurus/ 資料夾（如果存在）

  2. 打包成 ZIP

    • 選取整個 tm-docs 資料夾
    • 壓縮成 ZIP 檔案
    • 檔案名稱建議：[客戶名稱]_文檔系統_v1.0.zip

方法 2：使用 .gitignore（如果使用 Git）​

如果專案在 Git 管理下，.gitignore 已經排除了不需要的檔案：

  • 直接打包整個資料夾即可
  • Git 會自動排除 node_modules/ 和 build/

📝 客戶收到後需要做的事​

第一次使用（必須執行）​

  1. 解壓縮檔案

    • 將 ZIP 檔案解壓縮到任意位置
    • 例如：C:\Documents\客戶文檔系統\

  2. 安裝 Node.js（如果還沒安裝）

  3. 安裝依賴套件

    • 打開命令提示字元（CMD）或 PowerShell
    • 進入 tm-docs 資料夾： 
      cd C:\Documents\客戶文檔系統\tm-docs
    • 執行安裝： 
      npm install
    • 等待安裝完成（約 2-5 分鐘）

  4. 開始使用

    • 雙擊 開啟文件管理系統.bat 即可開始使用

✅ 交付檢查清單​

打包前請確認：

  • 已移除 node_modules/ 資料夾
  • 已移除 build/ 資料夾（可選，客戶可重新建置）
  • 包含所有 docs/ 中的文檔檔案
  • 包含所有 static/img/ 中的圖片
  • 包含 package.json 和 package-lock.json
  • 包含所有配置檔案（docusaurus.config.js、sidebars.js）
  • 包含所有教學文件
  • 包含批次檔（開啟文件管理系統.bat、開啟文件管理系統.sh）
  • 測試 ZIP 檔案可以正常解壓縮
  • 準備交付說明文件（本文件）

📧 交付時給客戶的說明​

郵件範本​

親愛的 [客戶名稱]，

已為您準備好文件知識庫系統，請查收附件。

【交付內容】
- 專案檔案（ZIP 壓縮檔）
- 使用指南文件

【第一次使用步驟】
1. 解壓縮 ZIP 檔案
2. 確認已安裝 Node.js（版本 >= 20.0）
3. 在 tm-docs 資料夾中執行：npm install
4. 執行 開啟文件管理系統.bat 開始使用

【詳細說明】
請參考 ZIP 檔案中的「README_客戶使用指南.md」

如有任何問題，歡迎隨時聯繫！

[您的名字]

🔍 常見問題​

Q: 為什麼不包含 node_modules？​

A:

  • node_modules 資料夾非常大（通常 200-500 MB）
  • 客戶需要根據自己的系統安裝，確保相容性
  • 使用 npm install 會自動下載正確的版本

Q: 客戶沒有 Node.js 怎麼辦？​

A:

  • 提供 Node.js 下載連結：https://nodejs.org/
  • 說明最低版本要求（Node.js >= 20.0）
  • 提供安裝教學或協助安裝

Q: 打包後檔案太大？​

A:

  • 確認已排除 node_modules/（通常佔 90% 以上空間）
  • 確認已排除 build/（可重新建置）
  • 壓縮後通常只有 5-20 MB

💡 建議​

  1. 提供兩種交付方式

    • ZIP 檔案（離線交付）
    • Git 儲存庫（如果客戶有 Git）

  2. 準備安裝教學影片

    • 錄製 5-10 分鐘的安裝教學
    • 包含 Node.js 安裝、npm install、第一次使用

  3. 提供技術支援

    • 第一次安裝時提供遠端協助
    • 確保客戶能順利開始使用

最後更新： 2025-01-XX