新增研究模式功能,更新 README 和中文文檔以包含相關說明和使用指南。

This commit is contained in:
siage 2025-05-26 23:58:55 +08:00
parent 5267fa4490
commit 288bec9c14
2 changed files with 134 additions and 14 deletions

View File

@ -4,6 +4,7 @@
- [✨ Features](#features1)
- [🧭 Usage Guide](#usage-guide)
- [🔬 Research Mode](#research-mode)
- [🧠 Task Memory Function](#task-memory-function)
- [📋 Project Rules Initialization](#project-rules)
- [🌐 Web GUI](#web-gui)
@ -39,6 +40,7 @@ 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
- **Research Mode**: Systematic technical research capabilities with guided workflows for exploring technologies, best practices, and solution comparisons
- **Project Rules Initialization**: Define project standards and rules to maintain consistency across large projects
- **<a id="web-gui"></a>Web GUI**: Provides an optional web-based graphical user interface for task management. Enable by setting `ENABLE_GUI=true` in your `.env` file. When enabled, a `WebGUI.md` file containing the access address will be created in your `DATA_DIR`.
@ -50,6 +52,17 @@ Shrimp Task Manager offers a structured approach to AI-assisted programming thro
Shrimp is essentially a prompt template that guides AI Agents to better understand and work with your project. It uses a series of prompts to ensure the Agent aligns closely with your project's specific needs and conventions.
### Research Mode in Practice
Before diving into task planning, you can leverage the research mode for technical investigation and knowledge gathering. This is particularly useful when:
- You need to explore new technologies or frameworks
- You want to compare different solution approaches
- You're investigating best practices for your project
- You need to understand complex technical concepts
Simply tell the Agent "research [your topic]" or "enter research mode for [technology/problem]" to begin systematic investigation. The research findings will then inform your subsequent task planning and development decisions.
### First-Time Setup
When working with a new project, simply tell the Agent "init project rules". This will guide the Agent to generate a set of rules tailored to your project's specific requirements and structure.
@ -78,6 +91,52 @@ Due to LLM token limits, context may be lost during lengthy conversations. If th
You can switch the language of system prompts by setting the `TEMPLATES_USE` environment variable. It supports `en` (English) and `zh` (Traditional Chinese) by default. Furthermore, you can copy an existing template directory (e.g., `src/prompts/templates_en`) to the location specified by `DATA_DIR`, modify it, and then point `TEMPLATES_USE` to your custom template directory name. This allows for deeper prompt customization. For detailed instructions.
## 🔬 <a id="research-mode"></a>Research Mode
Shrimp Task Manager includes a specialized research mode designed for systematic technical investigation and knowledge gathering.
### What is Research Mode?
Research Mode is a guided workflow system that helps AI Agents conduct thorough and systematic technical research. It provides structured approaches to exploring technologies, comparing solutions, investigating best practices, and gathering comprehensive information for programming tasks.
### Key Features
- **Systematic Investigation**: Structured workflows ensure comprehensive coverage of research topics
- **Multi-Source Research**: Combines web search and codebase analysis for complete understanding
- **State Management**: Maintains research context and progress across multiple sessions
- **Guided Exploration**: Prevents research from becoming unfocused or going off-topic
- **Knowledge Integration**: Seamlessly integrates research findings with task planning and execution
### When to Use Research Mode
Research Mode is particularly valuable for:
- **Technology Exploration**: Investigating new frameworks, libraries, or tools
- **Best Practices Research**: Finding industry standards and recommended approaches
- **Solution Comparison**: Evaluating different technical approaches or architectures
- **Problem Investigation**: Deep-diving into complex technical challenges
- **Architecture Planning**: Researching design patterns and system architectures
### How to Use Research Mode
Simply tell the Agent to enter research mode with your topic:
- **Basic usage**: "Enter research mode for [your topic]"
- **Specific research**: "Research [specific technology/problem]"
- **Comparative analysis**: "Research and compare [options A vs B]"
The system will guide the Agent through structured research phases, ensuring thorough investigation while maintaining focus on your specific needs.
### Research Workflow
1. **Topic Definition**: Clearly define the research scope and objectives
2. **Information Gathering**: Systematic collection of relevant information
3. **Analysis and Synthesis**: Processing and organizing findings
4. **State Updates**: Regular progress tracking and context preservation
5. **Integration**: Applying research results to your project context
> **💡 Recommendation**: For the best research mode experience, we recommend using **Claude 4 Sonnet**, which provides exceptional analytical capabilities and comprehensive research synthesis.
## 🧠 <a id="task-memory-function"></a>Task Memory Function
Shrimp Task Manager has long-term memory capabilities, automatically saving task execution history and providing reference experiences when planning new tasks.
@ -321,20 +380,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 |
| | `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 |
| 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 |
| **Research & Investigation** | `research_mode` | Enter systematic technical research mode |
| **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 |
## 🔧 Technical Implementation

View File

@ -4,6 +4,7 @@
- [✨ 功能特點](#功能特點1)
- [📖 使用指南](#使用指南)
- [🔬 研究模式](#研究模式)
- [🧠 任務記憶功能](#任務記憶功能)
- [📋 專案規範初始化](#專案規範初始化)
- [🌐 網頁圖形介面](#網頁圖形介面)
@ -36,6 +37,7 @@
- **任務摘要自動更新**:完成任務時自動產生摘要,優化記憶效能
- **任務記憶功能**:自動備份任務歷史記錄,提供長期記憶和參考能力
- **思維鏈過程**:通過步驟化的推理系統性地分析複雜問題
- **研究模式**:系統性技術研究功能,提供引導式工作流程來探索技術、最佳實踐和解決方案比較
- **專案規範初始化**:定義專案標準和規則,維持大型專案的一致性
- **<a id="網頁圖形介面"></a>網頁圖形介面**:提供選用的網頁圖形化使用者介面來管理任務。透過在您的 `.env` 檔案中設定 `ENABLE_GUI=true` 來啟用。啟用後,將會在您的 `DATA_DIR` 中建立一個包含存取網址的 `WebGUI.md` 檔案。
@ -47,6 +49,17 @@
蝦米本質上是一個提示詞範本,通過一系列提示詞引導 AI Agent 更好地理解和適應您的專案。它確保 Agent 能夠更貼近您專案的特定需求和慣例。
### 實際應用中的研究模式
在深入任務規劃之前,您可以善用研究模式進行技術調查和知識收集。這在以下情況特別有用:
- 您需要探索新的技術或框架
- 您想要比較不同的解決方案方法
- 您正在調查專案的最佳實踐
- 您需要理解複雜的技術概念
只需告訴 Agent「研究 [您的主題]」或「進入研究模式研究 [技術/問題]」即可開始系統性調查。研究發現將為您後續的任務規劃和開發決策提供資訊基礎。
### 首次使用設置
在使用新專案時,只需對 Agent 說「init project rules」初始化專案規則。這將引導 Agent 生成一份符合您專案特定需求和結構的規則檔案。
@ -75,6 +88,52 @@
您可以透過設定 `TEMPLATES_USE` 環境變數來切換系統提示詞的語言。預設支援 `en`(英文)和 `zh`(繁體中文)。此外,您也可以複製現有的模板目錄(例如 `src/prompts/templates_en`)到 `DATA_DIR` 指定的位置,進行修改後,將 `TEMPLATES_USE` 指向您的客製化模板目錄名稱,以實現更深度的提示詞客製化
## 🔬 <a id="研究模式"></a>研究模式
蝦米任務管理器包含專門的研究模式,專為系統性技術調查和知識收集而設計。
### 什麼是研究模式?
研究模式是一個引導式工作流程系統,幫助 AI Agent 進行徹底且系統性的技術研究。它提供結構化的方法來探索技術、比較解決方案、調查最佳實踐,並為程式設計任務收集全面的資訊。
### 主要功能
- **系統性調查**:結構化工作流程確保研究主題的全面覆蓋
- **多源研究**:結合網路搜尋和程式碼庫分析,實現完整理解
- **狀態管理**:在多個會話中維護研究上下文和進度
- **引導式探索**:防止研究變得不專注或偏離主題
- **知識整合**:將研究發現與任務規劃和執行無縫整合
### 何時使用研究模式
研究模式特別適用於:
- **技術探索**:調查新的框架、函式庫或工具
- **最佳實踐研究**:尋找行業標準和推薦方法
- **解決方案比較**:評估不同的技術方法或架構
- **問題調查**:深入研究複雜的技術挑戰
- **架構規劃**:研究設計模式和系統架構
### 如何使用研究模式
只需告訴 Agent 進入研究模式並指定您的主題:
- **基本用法**:「進入研究模式研究 [您的主題]」
- **特定研究**:「研究 [特定技術/問題]」
- **比較分析**:「研究並比較 [選項 A 與選項 B]」
系統將引導 Agent 通過結構化的研究階段,確保徹底調查的同時保持對您特定需求的專注。
### 研究工作流程
1. **主題定義**:明確定義研究範圍和目標
2. **資訊收集**:系統性收集相關資訊
3. **分析與綜合**:處理和組織研究發現
4. **狀態更新**:定期進度追蹤和上下文保存
5. **整合應用**:將研究結果應用到您的專案上下文中
> **💡 建議**:為了獲得最佳的研究模式體驗,我們建議使用 **Claude 4 Sonnet**,它提供卓越的分析能力和全面的研究綜合功能。
## 🧠 <a id="任務記憶功能"></a>任務記憶功能
蝦米任務管理器具備長期記憶功能,可以自動保存任務執行的歷史記錄,並在規劃新任務時提供參考經驗。
@ -322,6 +381,7 @@ or
| **任務分析** | `analyze_task` | 深入分析任務需求 |
| | `process_thought` | 針對複雜問題進行步驟化推理 |
| **方案評估** | `reflect_task` | 反思與改進方案構想 |
| **研究調查** | `research_mode` | 進入系統性技術研究模式 |
| **專案管理** | `init_project_rules` | 初始化或更新專案標準與規則 |
| **任務管理** | `split_tasks` | 將任務拆分為子任務 |
| | `list_tasks` | 顯示所有任務及狀態 |