---

name: doc-organizer description: 根據輸入的文檔資料整理成繁體中文的說明文件。會自動搜尋相關資料、整合資訊,並重新撰寫完整的文件。

文檔整理與重寫技能 (Document Organizer)

此 skill 用於將原始文檔資料整理成結構完整、易讀的繁體中文說明文件。會自動進行網路搜尋以補充相關資訊,並重新組織內容。

何時使用此 skill

• 當需要將雜亂的文檔資料整理成正式說明文件時
• 當需要將英文或其他語言文檔轉換為繁體中文時
• 當需要補充文檔中缺失的背景資訊或技術細節時
• 當需要重新組織文檔結構以提升可讀性時
• 當需要標準化文檔格式時

工作流程

1. 分析輸入文檔

首先,仔細閱讀並分析輸入的文檔內容:

• 識別主題: 確定文檔的核心主題和目的
• 提取關鍵資訊: 找出重要的概念、術語、步驟、數據等
• 評估完整性: 判斷文檔是否有缺失或不清楚的部分
• 確定目標讀者: 了解文檔的預期讀者群

2. 網路搜尋補充資料

使用 search_web 工具搜尋相關資訊:

• 背景知識: 搜尋主題的基本概念和背景
• 技術細節: 查找技術規格、API 文檔、最佳實踐等
• 相關範例: 尋找實際應用案例或程式碼範例
• 最新資訊: 確認是否有更新的版本或資訊
• 繁體中文資源: 優先搜尋繁體中文的參考資料

搜尋策略:

Copy1. 使用核心關鍵字進行初步搜尋
2. 針對不清楚的術語進行專項搜尋
3. 搜尋相關的官方文檔或權威來源
4. 查找繁體中文的技術社群討論

3. 整合與組織資訊

將原始文檔和搜尋到的資料進行整合:

• 去除重複: 刪除重複或冗餘的內容
• 補充缺失: 填補原文檔中缺少的重要資訊
• 邏輯排序: 按照邏輯順序重新組織內容
• 分類歸納: 將相關內容歸類到適當的章節

4. 撰寫繁體中文說明文件

按照以下結構重新撰寫文件:

標準文檔結構

Copy# [文檔標題]

## 概述
- 簡要說明文檔主題和目的
- 適用對象和使用場景

## 背景資訊
- 相關技術背景
- 重要概念說明
- 術語定義

## 主要內容
- 詳細說明或操作步驟
- 技術細節和規格
- 配置說明或參數解釋

## 範例
- 實際應用範例
- 程式碼示例(如適用)
- 使用案例

## 注意事項
- 重要提醒
- 常見問題
- 疑難排解

## 參考資料
- 相關連結
- 延伸閱讀
- 資料來源

5. 文檔品質檢查

完成撰寫後,進行品質檢查:

• 語言檢查: 確保使用正確的繁體中文用詞
• 結構檢查: 確認章節結構清晰合理
• 完整性檢查: 確保所有重要資訊都已包含
• 可讀性檢查: 確保內容易於理解
• 格式檢查: 確保 Markdown 格式正確

撰寫規範

語言風格

• 使用繁體中文: 所有內容必須使用繁體中文撰寫
• 專業術語: 技術術語保留英文,並在首次出現時提供中文說明
• 清晰簡潔: 使用簡單明瞭的語句,避免過於複雜的表達
• 一致性: 保持術語翻譯和用詞的一致性

格式規範

• 使用 Markdown: 採用標準 Markdown 格式
• 標題層級: 合理使用 H1-H6 標題
• 程式碼區塊: 使用適當的語言標記
• 列表: 適當使用有序和無序列表
• 強調: 使用粗體或斜體強調重點

內容規範

• 準確性: 確保技術資訊準確無誤
• 完整性: 涵蓋所有重要面向
• 實用性: 提供可操作的資訊和範例
• 時效性: 確保資訊是最新的

輸出格式

最終文檔應該:

1. 檔案命名: 使用描述性的檔案名稱,例如 [主題]_說明文件.md
2. 編碼格式: UTF-8 編碼
3. 儲存位置: 儲存在適當的專案目錄中
4. 版本資訊: 在文檔開頭或結尾註明撰寫日期和版本

範例工作流程

假設要整理一份關於 Python 套件的文檔:

Copy1. 讀取原始文檔 (可能是英文 README 或零散筆記)
2. 搜尋該套件的官方文檔、GitHub、PyPI 等資源
3. 搜尋繁體中文的教學文章或討論
4. 整合資訊,建立文檔大綱
5. 撰寫各章節內容:
   - 概述: 套件用途和特色
   - 安裝: 安裝步驟和相依套件
   - 使用方法: 基本用法和 API 說明
   - 範例: 實際程式碼範例
   - 注意事項: 版本相容性、已知問題等
6. 檢查並優化文檔
7. 儲存為 `[套件名稱]_使用說明.md`

注意事項

• 尊重原始資料: 不要曲解或改變原始文檔的核心意思
• 標註來源: 如果引用外部資料,應適當標註來源
• 保持客觀: 以客觀、中立的方式呈現資訊
• 定期更新: 技術文檔應定期檢查並更新
• 使用者導向: 始終以使用者的需求為中心撰寫

工具使用

在執行此 skill 時,會使用以下工具:

• view_file: 讀取原始文檔
• search_web: 搜尋相關資料
• read_url_content: 讀取網路資源內容
• write_to_file: 建立新的說明文件
• grep_search: 在專案中搜尋相關資訊
• find_by_name: 尋找相關檔案

品質標準

完成的文檔應達到以下標準:

✅ 使用正確的繁體中文 ✅ 結構清晰,易於導航 ✅ 資訊完整且準確 ✅ 包含實用的範例 ✅ 格式統一,排版美觀 ✅ 適合目標讀者閱讀