From 6ba0b5f6d2fada0fb3f7415856b20f8fe2684478 Mon Sep 17 00:00:00 2001 From: tangsongdayo Date: Sun, 19 Jul 2026 13:06:54 +0800 Subject: [PATCH] docs: plan system documentation --- CHANGELOG.md | 2 ++ docs/DOCUMENTATION-PROGRESS.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+) create mode 100644 docs/DOCUMENTATION-PROGRESS.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 3088a1b..2b7c9f7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,8 @@ ## [Unreleased] +## [0.8.0] - 2026-07-19 + ### Added - Hardened incoming RSS/Atom sources with public-HTTPS validation, redirect checks, response-size limits, and safe XML declaration rejection. diff --git a/docs/DOCUMENTATION-PROGRESS.md b/docs/DOCUMENTATION-PROGRESS.md new file mode 100644 index 0000000..9ac47a7 --- /dev/null +++ b/docs/DOCUMENTATION-PROGRESS.md @@ -0,0 +1,33 @@ +# 系統文件 Progress + +此文件管理 Mebbling 對外與維運文件的章節規劃；它不取代版本變更紀錄，功能變更仍以 `CHANGELOG.md` 為準。 + +## 文件地圖 + +| 優先 | 章節 | 讀者 | 預計內容 | 狀態 | +| --- | --- | --- | --- | --- | +| P0 | 總覽與架構 | 所有使用者 | Mebbling 解決的問題、元件圖、資料流、權限邊界 | 規劃中 | +| P0 | 快速開始 | 自架管理者 | Docker／WSL 啟動、必要環境變數、首次管理員與第一個來源 | 現有 README，待拆分 | +| P0 | Memos 來源與同步 | Hub 使用者 | PAT、公開貼文規則、多使用者來源、附件策略、RSS 限制 | 規劃中 | +| P0 | Webhook 指南 | 來源建立者 | 自動簽章 webhook、手動模式、驗證、輪替與故障排查 | 規劃中 | +| P0 | 營運手冊 | 維運者 | health/metrics、告警、備份／還原、升級、事件處理 | 部分完成（OPERATIONS） | +| P1 | 安全與隱私 | 管理者／貢獻者 | Token 加密、存取控制、保存期限、帳號刪除、威脅模型與限制 | 規劃中 | +| P1 | 設定參考 | 維運者 | 所有環境變數、預設值、正式環境檢查與範例 | 規劃中 | +| P1 | API／資料參考 | 整合者 | 公開 RSS/Atom、health、metrics、資料表與 migration 策略 | 規劃中 | +| P1 | 發布與貢獻 | 維護者 | 測試、SBOM、版本、release、升級與容器簽章前置條件 | 部分完成（RELEASING） | +| P2 | 使用者操作手冊 | 一般使用者 | 搜尋、標籤、收藏、留言、邀請、匯出與發文 | 規劃中 | +| P2 | 疑難排解 | 所有使用者 | Token／同步／Webhook／附件／備份常見問題與診斷流程 | 規劃中 | + +## 撰寫順序 + +1. 將 README 的「快速啟動、架構、環境變數」拆成可獨立連結的入門文件。 +2. 寫出 Memos 同步、Webhook 與 RSS 三份整合指南，統一說明適用情境與限制。 +3. 擴充維運手冊的監控、告警、備份、升級與事故處理章節。 +4. 補上安全／隱私、設定與 API 參考；內容直接對應實際程式與 `.env.example`。 +5. 最後以操作手冊和疑難排解收斂成對一般使用者友善的文件。 + +## 完成標準 + +- 每個章節至少包含適用對象、前置條件、操作步驟、驗證方式與失敗處理。 +- 涉及安全或資料風險的章節要明確列出不可逆操作及備份需求。 +- 指令須可在 WSL／Docker 的實際環境重現；發布前以 `scripts/smoke-test.sh` 驗證文件中的服務狀態檢查。