From 94152980342fa87d2f8bcd42a205987fe33634f6 Mon Sep 17 00:00:00 2001 From: Zhongwei Li Date: Sun, 30 Nov 2025 08:40:27 +0800 Subject: [PATCH] Initial commit --- .claude-plugin/plugin.json | 11 ++++ README.md | 3 ++ commands/compact.md | 84 ++++++++++++++++++++++++++++++ commands/expand.md | 102 +++++++++++++++++++++++++++++++++++++ commands/explain.md | 98 +++++++++++++++++++++++++++++++++++ plugin.lock.json | 53 +++++++++++++++++++ 6 files changed, 351 insertions(+) create mode 100644 .claude-plugin/plugin.json create mode 100644 README.md create mode 100644 commands/compact.md create mode 100644 commands/expand.md create mode 100644 commands/explain.md create mode 100644 plugin.lock.json diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json new file mode 100644 index 0000000..6470ca9 --- /dev/null +++ b/.claude-plugin/plugin.json @@ -0,0 +1,11 @@ +{ + "name": "document", + "description": "Document tools", + "version": "1.0.0", + "author": { + "name": "Miles Chou" + }, + "commands": [ + "./commands" + ] +} \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..6c5405c --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# document + +Document tools diff --git a/commands/compact.md b/commands/compact.md new file mode 100644 index 0000000..89beb4c --- /dev/null +++ b/commands/compact.md @@ -0,0 +1,84 @@ +--- +description: Document compact +model: claude-sonnet-4-5 +--- + +精簡文件內容，保留核心價值並減少冗餘。 + +仔細分析指定文件的內容，識別重複、冗餘或可以精簡的部分，在保持核心資訊完整的前提下適度減少內容長度。 + +## 執行流程 + +1. **深度分析文件結構** + - 識別章節層次和邏輯關係 + - 分析內容重複性和必要性 + - 評估資訊密度和價值 + +2. **精簡策略應用** + - 合併相似或重複的內容 + - 簡化冗長的描述和範例 + - 移除過度詳細的說明 + - 優化表格和列表結構 + +3. **品質保證** + - 確保核心資訊完整保留 + - 維持文件的邏輯連貫性 + - 保持技術準確性 + - 確保可讀性和實用性 + +## 精簡原則 + +### 保留內容 +- 核心概念和定義 +- 關鍵步驟和流程 +- 重要的範例和用法 +- 必要的注意事項和警告 +- 核心配置和參數 + +### ✂️ 精簡內容 +- 重複的說明和範例 +- 過度詳細的背景描述 +- 冗長的介紹段落 +- 類似功能的重複說明 +- 過多的修飾性文字 + +### 🎯 優化策略 +- **合併相似章節**: 將功能相近的內容整合 +- **精簡範例**: 保留最具代表性的範例 +- **簡化表格**: 移除非必要的欄位和行 +- **優化格式**: 使用更緊湊的結構化格式 + +## 品質標準 + +精簡後的文件應該達到以下標準： + +- **完整性**: 所有核心功能和概念都有涵蓋 +- **準確性**: 技術內容保持正確和最新 +- **實用性**: 讀者能夠快速找到需要的資訊 +- **簡潔性**: 內容長度減少 20-40% +- **清晰性**: 結構邏輯清楚，易於理解 + +## 使用場景 + +- 技術文件過於冗長需要精簡 +- API 文檔需要提升可讀性 +- 使用手冊需要突出重點 +- 規範文件需要去除重複內容 +- 老舊文檔需要現代化整理 + +## 注意事項 + +**重要提醒** +- 精簡過程中會保留所有關鍵資訊 +- 建議在執行前備份原始文件 +- 精簡後請檢查技術準確性 +- 考慮目標讀者的需求層次 +- 必須仔細分析思考，有時內容太少反而會造成誤會 + +## 輸出格式 + +精簡後的文件將： +1. 保持原有的文件格式（Markdown/文本） +2. 維持章節結構的邏輯性 +3. 標註精簡的主要變更點 +4. 提供精簡統計摘要 diff --git a/commands/expand.md b/commands/expand.md new file mode 100644 index 0000000..550b223 --- /dev/null +++ b/commands/expand.md @@ -0,0 +1,102 @@ +--- +description: Document expand +model: claude-sonnet-4-5 +--- + +將概要文件透過互動式詢問擴充為完整文件。 + +分析指定文件的大綱或概要內容，識別需要補充的細節，透過主動詢問和探索來擴充文件深度與廣度。 + +## 執行流程 + +1. **初步分析與規劃** + - 掃描現有文件結構 + - 識別內容缺口和不明確處 + - 制定擴充策略和優先順序 + +2. **互動式探索** + - 主動提出澄清問題 + - 詢問具體使用場景 + - 確認技術細節和邊界條件 + - 收集實際案例和最佳實踐 + +3. **智能擴充** + - 根據回饋補充缺失內容 + - 添加範例程式碼和配置 + - 增加故障排除指南 + - 補充相關參考資源 + +## 擴充策略 + +### 探索領域 +- **概念定義**: 什麼是？為什麼重要？ +- **使用場景**: 何時使用？誰會使用？ +- **實作細節**: 如何運作？有哪些選項？ +- **最佳實踐**: 推薦做法？常見陷阱？ +- **相關資源**: 延伸閱讀？相關工具？ + +### 互動問題範例 +- "這個功能的主要使用者是誰？" +- "有哪些常見的錯誤配置？" +- "能否提供實際的使用案例？" +- "這個流程的異常處理如何進行？" +- "是否有性能或安全考量？" + +### 內容補充重點 +- **前置條件**: 環境需求、相依性 +- **詳細步驟**: 完整操作流程 +- **程式範例**: 實際可執行的程式碼 +- **配置說明**: 參數詳解、預設值 +- **故障排除**: 常見問題與解法 +- **進階用法**: 客製化、整合方案 + +## 品質標準 + +擴充後的文件應達到： + +- **完整性**: 涵蓋從入門到進階的完整知識 +- **實用性**: 包含可直接使用的範例 +- **可讀性**: 循序漸進的結構安排 +- **準確性**: 經過驗證的技術內容 +- **深度性**: 提供深入的技術洞察 + +## 使用場景 + +- 將簡要規格擴充為詳細文件 +- 補充 API 文件的使用範例 +- 完善安裝指南的故障排除 +- 擴充配置文件的參數說明 +- 豐富教學文件的實作細節 + +## 互動流程範例 + +``` +AI Assistant: 我注意到文件提到了「快取策略」但缺少具體實作。 + 請問： + 1. 快取的過期時間是多久？ + 2. 是否支援手動清除快取？ + 3. 快取失效時的降級策略為何？ + +User: 快取24小時過期，支援 --no-cache 參數，失效時直接呼叫 API + +AI Assistant: 了解！我會補充以下內容： + - 快取生命週期管理 + - 清除快取的指令範例 + - API 降級的錯誤處理機制 +``` + +## 注意事項 + +**重要提醒** +- 擴充過程可以多次詢問細節 +- 請準備相關技術規格和案例 +- 可隨時中斷並保存進度 +- 建議分階段進行大型文件擴充 +- 透過持續對話來確保文件的完整性和準確性 + +## 輸出格式 + +擴充後的文件將： +1. 保持原始架構並新增章節 +2. 標註新增內容的來源依據 +3. 提供版本變更記錄 diff --git a/commands/explain.md b/commands/explain.md new file mode 100644 index 0000000..33970fd --- /dev/null +++ b/commands/explain.md @@ -0,0 +1,98 @@ +--- +description: 完整解釋技術概念、架構設計或流程 +model: claude-sonnet-4-5 +--- + +# 視覺化優先解釋模式 + +當我請你解釋技術概念、架構設計或流程時，請使用「視覺化優先」的解釋方式： + +1. 不使用程式碼（除非我明確要求） +2. 大量使用圖表、流程圖、表格來輔助說明 +3. 從高階概念逐步深入細節 +4. 用對比方式展示改進（現況 vs 建議） +5. 提供實際案例和場景 + +請按照以下結構組織回答： + +## 一、核心概念總覽 + +- 用一段話說明本質 +- 用簡單的圖表展示全貌 + +## 二、現況分析（如適用） + +- 目前的做法/問題 +- 用圖表呈現現有架構 + +## 三、解決方案/概念詳解 + +- 核心想法的視覺化呈現 +- 各組件關係圖 +- 資料/流程走向 + +## 四、具體案例 + +- 用時間軸或流程圖展示實際運作 +- 標註關鍵決策點 + +## 五、優劣對比 + +- 用表格或對比圖展示優缺點 +- 說明適用場景 + +## 六、實施建議 + +- 分階段實施圖 +- 風險與注意事項 + +【視覺化工具】 +優先使用這些方式呈現： + +1. **表格（最穩定）**：適合中文內容對比 + ``` + ┌──────┬──────┬──────┐ + │ 標題 │ 標題 │ 標題 │ + ├──────┼──────┼──────┤ + │ 內容 │ 內容 │ 內容 │ + └──────┴──────┴──────┘ + ``` + +2. **層級結構**：適合流程說明 + ``` + 主題 + ├─ 子項目一 + │ └─ 細節 + └─ 子項目二 + └─ 細節 + ``` + +3. **流程圖**：使用框線確保對齊 + ``` + ┌────┐ ┌────┐ + │開始│ ──→ │結束│ + └────┘ └────┘ + ``` + +4. **對比圖**：使用分欄表格 +5. **關係圖**：簡化連線，重點在結構 +6. **時間軸**：垂直排列較穩定 + +圖表風格使用 Unicode 框線圖表，優先考慮排版穩定性： +- 框線：┌─┬─┐ │ ├─┼─┤ └─┴─┘ +- 雙線框：╔═╦═╗ ║ ╠═╬═╣ ╚═╩═╝ +- 圓角框：╭─╮ │ ╰─╯ +- 箭頭：→ ← ↑ ↓ ⇒ ⇐ +- 分隔線：───── ═════ ━━━━━ +- 項目符號：• ▸ ▪ ◆ + +說明風格： +- 每個圖表前後都要有文字說明 +- 複雜概念要分解成多個簡單部分 +- 用類比幫助理解（如適用） +- 標註「為什麼」而不只是「是什麼」 + +記住： +1. 目標是讓讀者快速理解概念和架構，而不是展示技術細節 + +think hard diff --git a/plugin.lock.json b/plugin.lock.json new file mode 100644 index 0000000..e544a08 --- /dev/null +++ b/plugin.lock.json @@ -0,0 +1,53 @@ +{ + "$schema": "internal://schemas/plugin.lock.v1.json", + "pluginId": "gh:MilesChou/claude-marketplace:plugins/document", + "normalized": { + "repo": null, + "ref": "refs/tags/v20251128.0", + "commit": "39b980b8afac2a166747ca0a7f2b752e7137768e", + "treeHash": "ee1d64172253f71ded0aa0298fbd82d52c0656ea11f2647163ff2b1fff717d64", + "generatedAt": "2025-11-28T10:12:07.344381Z", + "toolVersion": "publish_plugins.py@0.2.0" + }, + "origin": { + "remote": "git@github.com:zhongweili/42plugin-data.git", + "branch": "master", + "commit": "aa1497ed0949fd50e99e70d6324a29c5b34f9390", + "repoRoot": "/Users/zhongweili/projects/openmind/42plugin-data" + }, + "manifest": { + "name": "document", + "description": "Document tools", + "version": "1.0.0" + }, + "content": { + "files": [ + { + "path": "README.md", + "sha256": "34cc2bab28d876df2563154d70935116206f150b999564b4f9b145d7aefd9141" + }, + { + "path": ".claude-plugin/plugin.json", + "sha256": "70b58615889beae3a8a9a3783b775a0f4662b6146b76892d5938f70fb6f8b80e" + }, + { + "path": "commands/expand.md", + "sha256": "ef219d8cb66d63ebaa2d21eea4e8328802859f4dc249ce23ae640a9478f9179c" + }, + { + "path": "commands/explain.md", + "sha256": "36014f7b7af8d7c9bad66fac7234b47a6c59cce56c8a4512d4f5e7b8884244d8" + }, + { + "path": "commands/compact.md", + "sha256": "27c303baa9b26203537735aa1dfd6a0ad9b01c8466a972e6d257ff9eae0ebbd8" + } + ], + "dirSha256": "ee1d64172253f71ded0aa0298fbd82d52c0656ea11f2647163ff2b1fff717d64" + }, + "security": { + "scannedAt": null, + "scannerVersion": null, + "flags": [] + } +} \ No newline at end of file