egg/TEMP_spec_system_V3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

2ND

Browse Source
This commit is contained in:
beabigegg
2025-08-28 08:59:46 +08:00
parent b9557250a4
commit 4f7f46b07a
42 changed files with 4992 additions and 494 deletions
Download Patch File Download Diff File Expand all files Collapse all files

381
USER_MANUAL.md
View File

@@ -1,105 +1,364 @@
# 系統操作說明書 (User Manual)
# 暫時規範管理系統 V3 操作說明書
歡迎使用新版「暫時規範管理系統」。本說明書將引導您如何操作整合了 ONLYOFFICE 線上編輯器的新系統。
歡迎使用企業級暫時規範管理系統 V3。本系統整合了LDAP認證、ONLYOFFICE線上編輯器及智慧通知系統，提供完整的文件生命週期管理解決方案。
## 📋 目錄
1. [系統簡介](#1-系統簡介)
2. [登入與主畫面](#2-登入與主畫面)
3. [核心操作流程](#3-核心操作流程)
4. [智慧通知系統](#4-智慧通知系統)
5. [進階功能](#5-進階功能)
6. [角色權限說明](#6-角色權限說明)
7. [常見問題](#7-常見問題)
---
## 1. 系統簡介
本系統旨在提供一個集中化平台，用於管理、追蹤和存檔所有暫時性的工程規範。它涵蓋了從草擬、線上編輯、簽核、生效到最終歸檔的完整生命週期。
暫時規範管理系統 V3 是一個集中化平台，用於管理、追蹤和存檔所有暫時性的工程規範。它涵蓋了從草擬、線上編輯、簽核、生效到最終歸檔的完整生命週期。
### 🚀 V3 版本新特色
- **LDAP/AD 整合**：使用企業Active Directory帳號登入
- **智慧通知系統**：動態收件人選擇與自動提醒
- **自動排程提醒**：系統主動發送到期提醒郵件
- **增強的編輯體驗**：ONLYOFFICE文件協作編輯
---
## 2. 登入與主畫面
### 2.1 登入
### 2.1 LDAP 登入
請使用管理員提供的帳號和密碼，在首頁進行登入。
🆕 **V3 新功能**：系統現在使用企業 Active Directory 進行單一登入。
### 2.2 主畫面 (暫時規範總表)
**🚨 重要登入規範**：
登入後的主畫面會列出所有暫時規範，功能包含：
✅ **正確格式**：必須使用完整的 UPN 格式帳號
例如：`user@domain.com`
- **建立新規範按鈕**: (僅 Editor/Admin 可見) 點擊此處開始建立一份新的規範。
- **搜尋與篩選區**: 可根據「編號」、「主題」或「狀態」快速找到目標。
- **規範列表**: 顯示每份規範的關鍵資訊。
- **操作按鈕**: 根據您的「角色」和規範的「狀態」提供不同的操作選項。
❌ **錯誤格式**：不支援縮略帳號
例如：`user`
**登入步驟**：
1. 在登入頁面輸入您的 **完整 AD 帳號**（例如：user@domain.com）
2. 輸入您的 **AD 密碼**
3. 點擊「**登入**」按鈕
> **注意**：
> - 首次登入的用戶預設為 `Viewer` 權限
> - 如需提升權限請聯繫系統管理員
### 2.2 主畫面功能
登入後進入暫時規範總表，包含以下區域：
- **🔍 搜尋與篩選區**：根據編號、主題或狀態快速查找
- **📊 狀態統計**：顯示各狀態規範的數量概覽
- **📋 規範列表**：詳細顯示所有規範資訊
- **⚡ 快速操作**：根據權限和規範狀態提供操作按鈕
### 2.3 狀態指示說明
| 狀態 | 圖示 | 說明 |
|------|------|------|
| 待生效 | 🟡 | 草稿完成，待管理員啟用 |
| 已生效 | 🟢 | 正在生效中的規範 |
| 已過期 | 🔴 | 已自動過期的規範 |
| 已終止 | ⚫ | 提早終止的規範 |
---
## 3. 核心操作流程
### 3.1 流程總覽
### 3.1 完整工作流程
新版系統的標準工作流程如下：
1. **Editor** 填寫初始資料表單，建立一份新的暫時規範草稿。
2. 系統將初始資料**自動填入** Word 範本，並在瀏覽器中開啟 **ONLYOFFICE 線上編輯器**。
3. **Editor** 在線上完成文件的詳細內容撰寫，文件會自動儲存。
4. 完成後，可下載最終的 Word 文件 (`.docx`)，進行線下簽核流程。
5. 簽核完成後，將文件儲存為 **PDF (`.pdf`) 格式**。
6. **Admin** 登入系統，上傳簽核完成的 PDF 檔案，正式**啟用**該規範。
```mermaid
graph TD
A[Editor建立草稿] --> B[ONLYOFFICE線上編輯]
B --> C[下載Word文件]
C --> D[線下簽核流程]
D --> E[Admin上傳PDF啟用]
E --> F[🆕選擇通知對象]
F --> G[規範正式生效]
G --> H[🆕自動到期提醒]
```
### 3.2 建立新的暫時規範 (Editor / Admin)
1. 在主畫面點擊 **[+ 建立新規範]** 按鈕。
2. 在「建立新的暫時規範」頁面，填寫所有初始資料，如主題、站別、Package 等。
3. 點擊 **[建立並開始編輯]** 按鈕。
4. 系統將會自動重新導向至 ONLYOFFICE 編輯器頁面，您會看到一個已預先填好初始資料的 Word 文件。
5. 在線上編輯器中完成所有內容的修改與撰寫。您的所有變更都會**自動儲存**。完成後可直接關閉分頁或返回總表。
1. **建立草稿**
- 點擊 **[+ 暫時規範建立]** 按鈕
- 填寫基本資料：主題、申請人、站別等
- 選擇適用的 TCCS 等級和 4M 類別
- 點擊 **[建立並開始編輯]**
2. **線上編輯**
- 系統自動開啟 ONLYOFFICE 編輯器
- 文件已預填初始資料
- 支援多人協作編輯
- 所有變更自動儲存
3. **完成草稿**
- 編輯完成後可直接關閉編輯器
- 或點擊 **[完成編輯]** 返回總表
### 3.3 啟用暫時規範 (僅限 Admin)
當一份規範的線下簽核流程完成後，管理員需執行以下操作使其生效：
🆕 **新增智慧通知功能**
1. 在總表中找到狀態為「**待生效**」的目標規範。
2. 點擊該規範右側的 **啟用圖示 (✅)**。
3. 在「啟用暫時規範」頁面，點擊 **[選擇檔案]**，並上傳**已簽核完成的 PDF 檔案**。
4. 點擊 **[啟用規範]** 按鈕。
5. 完成後，該規範的狀態會變為「**已生效**」。
1. **開始啟用流程**
- 找到狀態為「待生效」的規範
- 點擊 **啟用圖示 (✅)**
### 3.4 管理已生效的規範 (Editor / Admin)
2. **上傳簽核文件**
- 上傳已簽核完成的 PDF 檔案
- 系統自動驗證檔案格式
對於「**已生效**」的規範，您可以進行展延或提早終止：
3. **🆕 選擇通知對象**
- 在「郵件通知對象」欄位輸入姓名或Email
- 系統即時搜尋 LDAP 用戶
- 支援多人選擇
- 可選擇不發送通知
- **展延**:
1. 點擊 **展延圖示 (📅+**)。
2. 選擇新的結束日期，並**必須上傳新的佐證文件 (PDF 格式)**。
3. 點擊儲存，規範的效期將會延長。
- **終止**:
1. 點擊 **終止圖示 (❌)**。
2. 填寫提早終止的原因。
3. 提交後，規範狀態將變為「**已終止**」。
4. **確認啟用**
- 點擊 **[上傳並啟用]**
- 系統發送啟用通知郵件
- 規範狀態變更為「已生效」
### 3.5 搜尋、篩選與下載
### 3.4 展延暫時規範 (Editor / Admin)
- **搜尋/篩選**: 在主畫面的搜尋框和下拉選單中操作。
- **下載**:
- **待生效規範**:
- Editor 和 Admin 可下載仍在編輯中的 **Word** 原始檔。
- **已生效/已終止/已過期規範**:
- 所有角色都可以下載由 Admin 上傳的**最終簽核版 PDF**。
🆕 **新增智慧通知功能**
### 3.6 檢視歷史紀錄
1. **開始展延**
- 點擊 **展延圖示 (📅+)**
- 選擇新的結束日期
點擊規範最右側的 **歷史紀錄圖示 (🕒)**，可查看該規範的所有變更紀錄。
2. **上傳佐證文件**
- 必須上傳新的佐證文件 (PDF格式)
3. **🆕 通知對象選擇**
- 選擇需要通知的相關人員
- 使用動態搜尋功能選擇收件人
4. **確認展延**
- 點擊 **[確認展延]**
- 系統發送展延通知郵件
### 3.5 終止暫時規範 (Editor / Admin)
🆕 **新增智慧通知功能**
1. **開始終止**
- 點擊 **終止圖示 (❌)**
- 填寫提早結束原因
2. **🆕 通知設定**
- 選擇需要通知終止訊息的人員
3. **確認終止**
- 點擊 **[確認終止]**
- 系統發送終止通知郵件
- 規範狀態變為「已終止」
---
## 4. 使用者管理 (僅限 Admin)
## 4. 智慧通知系統
管理員可點擊導覽列的 **[帳號管理]** 來新增、編輯或刪除使用者帳號。
🆕 **V3 全新功能**
### 4.1 動態收件人選擇
所有主要操作（啟用、展延、終止）都支援智慧通知：
- **即時搜尋**：輸入姓名或Email即時搜尋AD用戶
- **多人選擇**：支援選擇多位收件人
- **自動完成**：顯示完整姓名和Email資訊
- **移除功能**：可隨時移除已選擇的收件人
### 4.2 通知郵件內容
系統會根據操作類型自動發送相應的通知郵件：
- **啟用通知**：包含規範編號、主題、生效/結束日期
- **展延通知**：包含新的結束日期和展延原因
- **終止通知**：包含終止原因和終止日期
### 4.3 🆕 自動到期提醒
系統每天自動檢查即將到期的規範：
- **7天前提醒**：首次到期預警
- **3天前提醒**：最終到期提醒
- **自動發送**：無需人工干預
- **群組通知**：發送給預設管理群組
> **管理員設定**：可在 `tasks.py` 中修改提醒天數和收件人群組
---
## 5. 常見問題 (FAQ)
## 5. 進階功能
**Q: 為什麼我看不到「建立規範」或「啟用」的按鈕？**
A: 您的帳號權限不足。建立規範需要 `Editor` 或 `Admin` 權限；啟用規範僅限 `Admin`。如有需要，請聯繫系統管理員。
### 5.1 搜尋與篩選
**Q: 我忘記密碼了怎麼辦？**
A: 請聯繫系統管理員，請他/她為您重設密碼。
**搜尋功能**：
- 支援規範編號模糊搜尋
- 支援主題關鍵字搜尋
- 即時搜尋結果更新
**Q: 為什麼編輯器頁面顯示 "Download failed" 或無法儲存？**
A: 這通常是開發環境的網路設定問題。請確認您主機的防火牆是否允許來自 Docker 的連線，或聯繫系統管理員檢查網路設定。
**篩選功能**：
- 按狀態篩選（待生效/已生效/已過期/已終止）
- 多條件組合篩選
- 篩選結果分頁顯示
**Q: 我可以上傳 Word 檔案來啟用規範嗎？**
A: 不行。為了確保文件的最終性和不可修改性，系統規定必須上傳已簽核的 **PDF 檔案**來啟用規範。
### 5.2 文件下載
**Word文件下載**：
- Editor/Admin 可下載編輯中的Word原始檔
- 適用於線下簽核流程
**PDF文件下載**：
- 所有用戶都可下載最終簽核版PDF
- 適用於已生效/已終止的規範
### 5.3 歷史紀錄追蹤
點擊 **歷史紀錄圖示 (🕒)** 查看：
- 操作時間戳記
- 執行用戶
- 操作類型（建立/啟用/展延/終止）
- 詳細說明
### 5.4 🆕 即將到期警示
在規範列表中會特別標示即將到期的規範：
- **🟡 橙色標示**：7天內到期
- **🔴 紅色標示**：3天內到期
- **閃爍動畫**：今日到期
---
## 6. 角色權限說明
### 6.1 權限等級
| 角色 | 登入 | 檢視 | 建立 | 編輯 | 啟用 | 展延/終止 | 刪除 |
|------|------|------|------|------|------|-----------|------|
| **Viewer** | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
| **Editor** | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ | ❌ |
| **Admin** | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
### 6.2 🆕 LDAP 權限管理
- **自動用戶創建**：AD用戶首次登入自動建立帳號
- **預設權限**：新用戶預設為 `Viewer` 權限
- **權限提升**：需要管理員手動調整資料庫或修改程式碼
**管理員手動提升權限**：
```sql
-- 使用完整UPN格式帳號
UPDATE ts_user SET role='admin' WHERE username='user@domain.com';
```
---
## 7. 常見問題
### 7.1 登入相關
**Q: 無法使用AD帳號登入？**
A: 請確認：
1. **必須使用完整UPN格式**：例如 user@domain.com（不支援縮略帳號如 user）
2. 密碼正確
3. 帳號未被鎖定
4. 聯繫IT部門確認LDAP連線狀態
**Q: 忘記密碼怎麼辦？**
A: 系統使用AD驗證，請透過企業標準流程重設AD密碼。
### 7.2 權限相關
**Q: 為什麼我看不到建立規範按鈕？**
A: 您的權限可能為 `Viewer`，請聯繫管理員提升權限至 `Editor`。
**Q: 為什麼我無法啟用規範？**
A: 啟用功能僅限 `Admin` 權限，請聯繫系統管理員操作。
### 7.3 編輯器相關
**Q: ONLYOFFICE編輯器無法載入？**
A: 請檢查：
1. 瀏覽器是否允許彈出視窗
2. 網路連線是否正常
3. 是否安裝最新版瀏覽器
4. 聯繫IT確認Document Server狀態
**Q: 編輯內容未儲存？**
A: ONLYOFFICE有自動儲存功能，但請確認：
1. 編輯期間保持網路連線
2. 避免同時多人編輯同一文件
3. 定期手動儲存 (Ctrl+S)
### 7.4 🆕 通知相關
**Q: 搜尋不到AD用戶？**
A: 請確認：
1. 輸入至少2個字元才開始搜尋
2. 用戶在AD中確實存在
3. 服務帳號有足夠權限搜尋AD
**Q: 沒有收到通知郵件？**
A: 請檢查：
1. Email地址是否正確
2. 垃圾郵件資料夾
3. 公司郵件伺服器設定
4. 聯繫IT確認SMTP設定
**Q: 自動提醒郵件何時發送？**
A: 系統每天凌晨2:00自動檢查並發送提醒，分別在到期前7天和3天發送。
### 7.5 檔案相關
**Q: 可以上傳Word檔案來啟用規範嗎？**
A: 不可以。為確保文件完整性，啟用時必須上傳已簽核的 **PDF檔案**。
**Q: 檔案上傳失敗？**
A: 請確認：
1. 檔案格式正確（PDF）
2. 檔案大小未超過限制
3. 檔案名稱不含特殊字元
4. 網路連線穩定
### 7.6 效能相關
**Q: 系統回應速度慢？**
A: 可能原因：
1. 網路連線問題
2. 伺服器負載過高
3. 資料庫查詢耗時
4. 聯繫系統管理員檢查
---
## 🆘 技術支援
如遇到本手冊未涵蓋的問題，請透過以下方式聯繫：
- **📧 系統管理員**: [admin@company.com](mailto:admin@company.com)
- **📞 IT支援專線**: 分機 2345
- **💬 企業即時通**: #temp-spec-support
---
## 📝 版本資訊
- **文件版本**: V3.0.0
- **最後更新**: 2024年1月
- **適用系統**: 暫時規範管理系統 V3
---
**感謝您使用暫時規範管理系統 V3！**
希望這個操作手冊能幫助您更有效地使用系統功能。如有任何建議或回饋，歡迎與我們聯繫。