---
document_type: "general_doc"
service: "MOMENTRY_CORE"
title: "docs_v1.0 整合與規範化計劃"
date: "2026-03-30"
version: "V1.0"
status: "active"
owner: "Warren"
created_by: "OpenCode"
tags:
  - "整合與規範化計劃"
ai_query_hints:
  - "查詢 docs_v1.0 整合與規範化計劃 的內容"
  - "docs_v1.0 整合與規範化計劃 的主要目的是什麼？"
  - "如何操作或實施 docs_v1.0 整合與規範化計劃？"
---

# docs_v1.0 整合與規範化計劃

| 項目 | 內容 |
|------|------|
| 建立者 | OpenCode |
| 建立時間 | 2026-03-30 |
| 文件版本 | V1.0 |
| 目的 | 整合 docs/ 文件到 docs_v1.0/，並進行 v1.0 規範和 AI Agent 友好化檢查 |

---

## 版本歷史

| 版本 | 日期 | 目的 | 操作人 |
|------|------|------|--------|
| V1.0 | 2026-03-30 | 創建整合計劃 | OpenCode |
| V1.1 | 2026-03-30 | 添加同義詞林安裝指南和多語系工具 | OpenCode |

---

## 概述

本文檔定義將 `docs/` 中的 INSTALL_*.md 和 API_*.md 文件整合到 `docs_v1.0/` 的執行計劃，並進行 v1.0 文件規範和 AI Agent 友好化檢查。

---

## 執行階段

### 階段 1: 整合文件到 docs_v1.0/

#### 任務 1.1: INSTALL_*.md → docs_v1.0/IMPLEMENTATION/

| 操作 | 文件 |
|------|------|
| 覆蓋並更新連結 | INSTALL_MOMENTRY_API.md |
| 覆蓋並更新連結 | INSTALL_REDIS.md |
| 複製 | INSTALL_CADDY.md |
| 複製 | INSTALL_GITEA.md |
| 複製 | INSTALL_GITEA_MCP.md |
| 複製 | INSTALL_MARIADB.md |
| 複製 | INSTALL_MONGODB.md |
| 複製 | INSTALL_N8N.md |
| 複製 | INSTALL_OLLAMA.md |
| 複製 | INSTALL_PHP.md |
| 覆蓋並更新連結 | INSTALL_POSTGRESQL.md |
| 複製 | INSTALL_QDRANT.md |
| 複製 | INSTALL_SFTPGO.md |
| 複製 | INSTALL_WORDPRESS.md |
| **新增** | **INSTALL_SYNONYM_FOREST.md** |

#### 任務 1.3: 多語系同義詞庫示例文件

| 操作 | 文件 | 用途 |
|------|------|------|
| **新增** | **docs_v1.0/examples/multilingual/multilingual_synonyms.json** | 跨語言同義詞庫示例 |
| **新增** | **docs_v1.0/examples/multilingual/unified_multilingual_synonyms.json** | 統一格式多語系同義詞庫示例 |
| **新增** | **docs_v1.0/examples/multilingual/language_routing.json** | 語言路由配置示例 |

#### 任務 1.4: 工具腳本

| 操作 | 文件 | 用途 |
|------|------|------|
| **新增** | **scripts/detect_language.py** | 語言檢測工具 |
| **新增** | **scripts/language_router.py** | 語言路由工具 |
| **新增** | **scripts/unified_synonym_processor.py** | 統一格式處理器 |
| **新增** | **scripts/test_multilingual.sh** | 多語系功能測試腳本 |

#### 任務 1.2: API_*.md → docs_v1.0/

**移動到 REFERENCE/ (12 個)**
- API_ACCESS.md
- API_CURL_EXAMPLES.md
- API_ENDPOINTS.md
- API_EXAMPLES.md
- API_INDEX.md
- API_KEY_ARCHITECTURE.md
- API_KEY_INTEGRATION_TESTS.md
- API_KEY_MANAGEMENT.md
- API_KEY_OPTIMIZATION.md
- API_QUICK_REFERENCE.md
- API_REFERENCE.md
- API_TRAINING_MARCOM.md

**移動到 IMPLEMENTATION/ (3 個)**
- API_N8N_GUIDE.md
- API_WORDPRESS_GUIDE.md
- API_WORKFLOW_WORDPRESS_N8N.md

#### 任務 1.3: 保留 docs/ 作為參考

- 不刪除任何 docs/ 中的文件
- 保留所有 INSTALL_*.md (14 個)
- 保留所有 API_*.md (17 個)
- 保留其他技術文檔 (~50 個)

---

### 階段 2: v1.0 文件規範檢查

根據 `docs_v1.0/STANDARDS/DOCS_STANDARD.md` 進行檢查：

#### 2.1 命名規範檢查

| 項目 | 標準 |
|------|------|
| 命名模式 | PascalCase |
| 服務名稱 | 全大寫 (POSTGRESQL, SFTPGO) |
| 分隔符 | 底線 `_ |
| 副檔名 | .md |

#### 2.2 結構模板檢查

**安裝指南結構:**
```
1. 概述
2. 當前狀態 (表格)
3. 安裝步驟
4. 卸載步驟
5. 故障排除
6. 檔案位置
7. 常用指令
8. 版本資訊
```

**版本歷史表格:**
```markdown
| 版本 | 日期 | 目的 | 操作人 |
|------|------|------|--------|
```

#### 2.3 Markdown 格式檢查

| 項目 | 標準 |
|------|------|
| 標題層級 | H1 → H2 → H3 |
| 水平線 | --- |
| 程式碼區塊 | ```bash,```json, ```rust |
| 表格 | \| 和 -\| 對齊 |
| 強調 | **粗體**, *斜體* |

---

### 階段 3: AI Agent 友好化優化

根據 `AGENTS.md` 和 `OPENCODE_GUIDE.md` 進行優化：

#### 3.1 必要元素檢查清單

```
□ 檔案開頭有 H1 標題
□ 有版本歷史表格
□ 有概述說明目的
□ 命令使用 ```bash 標註
□ 路徑使用絕對路徑
□ 有驗證命令確認成功
□ 有故障排除章節
□ 有相關文件連結
□ 表格有表頭對齊
□ 數字/版本號清晰
```

#### 3.2 AI Agent 友好原則

| 原則 | 說明 |
|------|------|
| 明確的任務描述 | 每個步驟要有明確的驗收標準 |
| 命令可執行 | 所有 bash 命令必須完整可執行 |
| 路徑精確 | 使用絕對路徑，避免歧義 |
| 依賴說明 | 明確標註前置條件和依賴 |
| 驗證方法 | 提供檢查命令確認成功 |
| 錯誤處理 | 包含常見錯誤和解決方案 |
| 代碼範例 | 完整可複製的代碼區塊 |

---

## 完成後的結構

```
docs_v1.0/
├── ARCHITECTURE/           (現有 15 個 + PROCESSING_PIPELINE.md)
├── IMPLEMENTATION/         (現有 20 個 + 新增 17 個)
│   ├── INSTALL_*.md      (14 個 from docs/)
│   └── API_*_GUIDE.md   (3 個 from docs/)
├── OPERATIONS/            (現有 6 個)
├── REFERENCE/             (現有 37 個 + 新增 12 個)
│   └── API_*.md         (12 個 from docs/)
├── STANDARDS/             (現有 2 個)
└── TEMPLATES/            (現有 0 個)

docs/                      (保留作為參考)
├── INSTALL_*.md          (14 個)
├── API_*.md              (17 個)
└── ...其他 50+ 個文件
```

---

## 預期結果

1. **docs_v1.0/ 完整性**: 所有重要安裝指南和 API 文檔已整合
2. **v1.0 規範符合**: 所有文件符合命名和結構標準
3. **AI Agent 友好**: 文件可供 OpenCode 等 AI Agent 使用
4. **docs/ 保留**: 保留原始文件作為參考
