diff --git a/README.md b/README.md index 6053a41..2043a1d 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,8 @@ Shrimp Task Manager guides Agents through structured workflows for systematic pr - **Task Complexity Assessment**: Automatically evaluate task complexity and provide optimal handling suggestions - **Automatic Task Summary Updates**: Automatically generate summaries upon task completion, optimizing memory performance - **Task Memory Function**: Automatically backup task history, providing long-term memory and reference capabilities +- **Thought Chain Process**: Step-by-step reasoning to analyze complex problems systematically +- **Project Rules Initialization**: Define project standards and rules to maintain consistency across large projects ## 🔄 Task Management Workflow @@ -38,6 +40,8 @@ The system provides a complete task management lifecycle: 9. **Task Management** `delete_task`: Manage incomplete tasks (completed tasks remain in the system) 10. **Query Tasks** `query_task`: Search for related tasks in past memories using keywords 11. **Display Task** `get_task_detail`: Display complete task guidance +12. **Process Thought** `process_thought`: Conduct step-by-step reasoning for complex problem analysis +13. **Initialize Project Rules** `init_project_rules`: Set up and maintain project standards and conventions ## 🧠 Task Memory Function @@ -58,6 +62,43 @@ Shrimp Task Manager has long-term memory capabilities, automatically saving task Through effective use of the task memory function, the system can continuously accumulate experience, with intelligence level and work efficiency continuously improving. +## 🤔 Thought Chain Process + +The Thought Chain feature enhances problem-solving through structured thinking: + +- **Systematic Reasoning**: Break down complex problems into logical steps +- **Assumption Testing**: Challenge assumptions to validate solution approaches +- **Critical Analysis**: Evaluate solution options with rigorous criteria +- **Improved Decision Making**: Reach more reliable conclusions through deliberate thinking + +When enabled (default setting), the system guides the Agent through step-by-step reasoning using the `process_thought` tool, ensuring thorough problem analysis before implementation. + +## 📋 Project Rules Initialization + +The Project Rules feature helps maintain consistency across your codebase: + +- **Standardize Development**: Establish consistent coding patterns and practices +- **Onboard New Developers**: Provide clear guidelines for project contributions +- **Maintain Quality**: Ensure all code meets established project standards + +> **⚠️ Recommendation**: Initialize project rules when your project grows larger or undergoes significant changes. This helps maintain consistency and quality as complexity increases. + +Use the `init_project_rules` tool to set up or update project standards when: + +- Starting a new large-scale project +- Onboarding new team members +- Implementing major architectural changes +- Adopting new development conventions + +### Usage Examples + +You can easily access this feature with simple natural language commands: + +- **For initial setup**: Simply tell the Agent "init rules" or "init project rules" +- **For updates**: When your project evolves, tell the Agent "Update rules" or "Update project rules" + +This tool is particularly valuable when your codebase expands or undergoes significant structural changes, helping maintain consistent development practices throughout the project lifecycle. + ## 📚 Documentation Resources - [System Architecture](docs/en/architecture.md): Detailed system design and data flow explanation @@ -247,19 +288,21 @@ If your tool doesn't support Custom modes, you can: After configuration, you can use the following tools: -| Category | Tool Name | Description | -| ----------------------- | ----------------- | -------------------------------------- | -| **Task Planning** | `plan_task` | Start planning tasks | -| **Task Analysis** | `analyze_task` | In-depth analysis of task requirements | -| **Solution Assessment** | `reflect_task` | Reflect and improve solution concepts | -| **Task Management** | `split_tasks` | Break tasks into subtasks | -| | `list_tasks` | Display all tasks and status | -| | `query_task` | Search and list tasks | -| | `get_task_detail` | Display complete task details | -| | `delete_task` | Delete incomplete tasks | -| **Task Execution** | `execute_task` | Execute specific tasks | -| | `verify_task` | Verify task completion | -| | `complete_task` | Mark tasks as completed | +| Category | Tool Name | Description | +| ----------------------- | -------------------- | ------------------------------------------------ | +| **Task Planning** | `plan_task` | Start planning tasks | +| **Task Analysis** | `analyze_task` | In-depth analysis of task requirements | +| | `process_thought` | Step-by-step reasoning for complex problems | +| **Solution Assessment** | `reflect_task` | Reflect and improve solution concepts | +| **Project Management** | `init_project_rules` | Initialize or update project standards and rules | +| **Task Management** | `split_tasks` | Break tasks into subtasks | +| | `list_tasks` | Display all tasks and status | +| | `query_task` | Search and list tasks | +| | `get_task_detail` | Display complete task details | +| | `delete_task` | Delete incomplete tasks | +| **Task Execution** | `execute_task` | Execute specific tasks | +| | `verify_task` | Verify task completion | +| | `complete_task` | Mark tasks as completed | ## 🔧 Technical Implementation diff --git a/docs/zh/README.md b/docs/zh/README.md index df29773..b42feae 100644 --- a/docs/zh/README.md +++ b/docs/zh/README.md @@ -18,6 +18,8 @@ - **任務複雜度評估**：自動評估任務複雜度並提供最佳處理建議 - **任務摘要自動更新**：完成任務時自動產生摘要，優化記憶效能 - **任務記憶功能**：自動備份任務歷史記錄，提供長期記憶和參考能力 +- **思維鏈過程**：通過步驟化的推理系統性地分析複雜問題 +- **專案規範初始化**：定義專案標準和規則，維持大型專案的一致性 ## 🔄 任務管理工作流程 @@ -34,6 +36,8 @@ 9. **任務管理** `delete_task`：管理未完成的任務（已完成任務將保留在系統中） 10. **查詢任務** `query_task`：透過關鍵字查詢以往記憶是否有相關任務 11. **顯示任務** `get_task_detail`：顯示完整任務指導 +12. **思維處理** `process_thought`：進行步驟化推理，系統性分析複雜問題 +13. **初始化專案規範** `init_project_rules`：建立和維護專案標準與規範 ## 🧠 任務記憶功能 @@ -54,6 +58,43 @@ 通過有效利用任務記憶功能，系統能夠不斷積累經驗，智能化程度和工作效率將持續提升。 +## 🤔 思維鏈過程 + +思維鏈功能通過結構化思考增強問題解決能力： + +- **系統化推理**：將複雜問題分解為邏輯步驟 +- **假設測試**：挑戰假設以驗證解決方案的可行性 +- **批判性分析**：使用嚴格標準評估各種解決方案選項 +- **改進決策過程**：通過深思熟慮達成更可靠的結論 + +當啟用此功能（預設設定）時，系統會引導 Agent 使用 `process_thought` 工具進行逐步推理，確保在實施前進行徹底的問題分析。 + +## 📋 專案規範初始化 + +專案規範功能有助於維持代碼庫的一致性： + +- **標準化開發**：建立一致的編碼模式和實踐 +- **新開發者引導**：為專案貢獻提供明確的指南 +- **維持品質**：確保所有代碼符合既定的專案標準 + +> **⚠️ 建議**：當專案規模不斷擴大或發生重大變更時，請初始化專案規範。這有助於在複雜度增加時維持一致性和品質。 + +在以下情況使用 `init_project_rules` 工具設置或更新專案標準： + +- 啟動新的大型專案 +- 有新團隊成員加入 +- 實施重大架構變更 +- 採用新的開發慣例 + +### 使用範例 + +您可以透過簡單的自然語言指令輕鬆使用此功能： + +- **首次設定時**：只需對 Agent 說「初始化規則」或「初始化專案規則」 +- **需要更新時**：當專案發展變化時，對 Agent 說「更新規則」或「更新專案規則」 + +當您的代碼庫擴展或經歷重大結構變化時，此工具特別有價值，有助於在整個專案生命週期中保持一致的開發實踐。 + ## 📚 文件資源 - [系統架構](architecture.md)：詳細的系統設計與數據流說明 @@ -241,19 +282,21 @@ or 配置完成後，您可使用以下工具： -| 功能分類 | 工具名稱 | 功能描述 | -| ------------ | ----------------- | ------------------ | -| **任務規劃** | `plan_task` | 開始規劃任務 | -| **任務分析** | `analyze_task` | 深入分析任務需求 | -| **方案評估** | `reflect_task` | 反思與改進方案構想 | -| **任務管理** | `split_tasks` | 將任務拆分為子任務 | -| | `list_tasks` | 顯示所有任務及狀態 | -| | `query_task` | 搜尋並列出任務 | -| | `get_task_detail` | 顯示完整任務詳情 | -| | `delete_task` | 刪除未完成的任務 | -| **任務執行** | `execute_task` | 執行特定任務 | -| | `verify_task` | 檢驗任務完成情況 | -| | `complete_task` | 標記任務為已完成 | +| 功能分類 | 工具名稱 | 功能描述 | +| ------------ | -------------------- | -------------------------- | +| **任務規劃** | `plan_task` | 開始規劃任務 | +| **任務分析** | `analyze_task` | 深入分析任務需求 | +| | `process_thought` | 針對複雜問題進行步驟化推理 | +| **方案評估** | `reflect_task` | 反思與改進方案構想 | +| **專案管理** | `init_project_rules` | 初始化或更新專案標準與規則 | +| **任務管理** | `split_tasks` | 將任務拆分為子任務 | +| | `list_tasks` | 顯示所有任務及狀態 | +| | `query_task` | 搜尋並列出任務 | +| | `get_task_detail` | 顯示完整任務詳情 | +| | `delete_task` | 刪除未完成的任務 | +| **任務執行** | `execute_task` | 執行特定任務 | +| | `verify_task` | 檢驗任務完成情況 | +| | `complete_task` | 標記任務為已完成 | ## 🔧 技術實現