document

Documentation

# Document Plugin

文件處理工具集，提供文件擴充、精簡和技術概念解釋功能。

## 功能概述

本 Plugin 提供三個主要的文件處理命令，協助你在不同情境下處理技術文件：

- **擴充文件**：將簡要文件透過互動式詢問擴充為完整文件
- **精簡文件**：精簡冗長文件，保留核心價值並減少冗餘
- **概念解釋**：使用視覺化優先的方式解釋技術概念和架構設計

## 提供的命令

### `/document:expand` - 文件擴充

將概要文件透過互動式詢問擴充為完整文件。

**使用時機：**
- 將簡要規格擴充為詳細文件
- 補充 API 文件的使用範例
- 完善安裝指南的故障排除
- 擴充配置文件的參數說明
- 豐富教學文件的實作細節

**執行流程：**
1. 初步分析與規劃：掃描現有文件結構，識別內容缺口
2. 互動式探索：主動提出澄清問題，收集實際案例
3. 智能擴充：根據回饋補充缺失內容，添加範例和最佳實踐

**使用範例：**
```bash
/document:expand
```

執行後，系統會分析指定文件並主動詢問細節，透過持續對話來擴充文件內容。

### `/document:compact` - 文件精簡

精簡文件內容，保留核心價值並減少冗餘。

**使用時機：**
- 技術文件過於冗長需要精簡
- API 文檔需要提升可讀性
- 使用手冊需要突出重點
- 規範文件需要去除重複內容
- 老舊文檔需要現代化整理

**精簡策略：**
- 保留核心概念、關鍵步驟、重要範例
- 移除重複說明、過度詳細的描述
- 合併相似章節，精簡範例
- 優化表格和列表結構

**使用範例：**
```bash
/document:compact
```

精簡後的文件將減少 20-40% 的內容長度，同時保持所有核心功能和概念的完整性。

### `/document:explain` - 視覺化解釋

使用視覺化優先的方式解釋技術概念、架構設計或流程。

**特色：**
- 不使用程式碼（除非明確要求）
- 大量使用圖表、流程圖、表格輔助說明
- 從高階概念逐步深入細節
- 用對比方式展示改進（現況 vs 建議）
- 提供實際案例和場景

**回答結構：**
1. 核心概念總覽：用簡單圖表展示全貌
2. 現況分析：用圖表呈現現有架構
3. 解決方案詳解：核心想法的視覺化呈現
4. 具體案例：用流程圖展示實際運作
5. 優劣對比：用表格展示優缺點
6. 實施建議：分階段實施圖

**使用範例：**
```bash
/document:explain
```

系統會使用 Unicode 框線圖表、樹狀結構、流程圖等視覺化工具來解釋概念。

## 安裝方式

將此 Plugin 加入你的 Claude Code 配置：

```json
{
  "plugins": {
    "document": {
      "source": "marketplace:document@mileschou-marketplace"
    }
  }
}
```

## 使用建議

- **擴充文件**時，請準備相關技術規格和案例，可透過多次詢問細節來達到最佳效果
- **精簡文件**前，建議先備份原始文件，精簡後請檢查技術準確性
- **概念解釋**適合用於學習新技術、理解複雜架構、或向團隊說明設計決策

## 版本記錄

請參閱 [CHANGELOG.md](./CHANGELOG.md) 查看詳細的版本變更記錄。

## 作者

Miles Chou ([@mileschou-marketplace](https://github.com/MilesChou))
Commands

Documentation
