Skip to content

Commit 63ec2a3

Browse files
committed
feat: update update-plan prompt draft
1 parent ac22302 commit 63ec2a3

3 files changed

Lines changed: 90 additions & 118 deletions

File tree

docs/SKILL.md

Lines changed: 58 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,38 @@
11
---
22
name: plan-and-execute
3-
description: Automatically plan and execute tasks from issue documents. Reads issue requirements, creates a task list at the end of the document, and systematically executes each task while updating progress. Use when working with issue documents, task planning, or when you need to break down and execute complex multi-step requirements.
3+
description: Automatically plan and execute requirements. Creates a markdown task list with the UpdatePlan tool, and systematically executes each task while updating progress. Use when working with task planning or when you need to break down and execute complex multi-step requirements.
44
---
55

66
# Plan and Execute
77

8-
This Skill helps you automatically plan and execute tasks based on issue documents. It reads your requirements, creates a structured task list directly in the document, and systematically works through each task while keeping the document updated with progress.
8+
This Skill helps you automatically plan and execute requirements. It creates a structured markdown task list with the UpdatePlan tool and systematically works through each task while keeping progress visible.
99

1010
## Quick Start
1111

12-
When you need to work through an issue document:
12+
When you need to work through a multi-step request:
1313

14-
1. The Skill will first ask you for the issue document path
15-
2. It reads the document to understand requirements
16-
3. Creates a task list at the end of the document
17-
4. Executes tasks one by one, updating status in real-time
14+
1. Understand the requirements
15+
2. Read referenced files only when they are needed for context
16+
3. Create a markdown task list by calling the UpdatePlan tool
17+
4. Execute tasks one by one, updating the tool plan in real time
1818

1919
## Instructions
2020

21-
### Step 1: Get the issue document path
21+
### Step 1: Gather the requirements
2222

23-
Ask the user for the path to their issue document:
23+
Identify the requirements from the available context. Do not require the requirements to be moved into a separate document.
24+
25+
If a required referenced file path is missing, ask for it:
2426

2527
```
26-
What is the path to your issue document?
28+
What is the path to the referenced file?
2729
```
2830

29-
The document can be in any text format (.md, .txt, etc.) that contains task requirements or feature descriptions.
31+
Referenced files can be in any text format (.md, .txt, etc.) that contains task requirements or feature descriptions. If no additional file is needed, continue from the available requirements.
3032

31-
### Step 2: Read and analyze the issue document
33+
### Step 2: Read and analyze the requirements
3234

33-
Use the Read tool to load the document content and analyze:
35+
Analyze the requirements and read any referenced files needed for context:
3436

3537
- What are the main requirements?
3638
- What tasks need to be completed?
@@ -39,35 +41,39 @@ Use the Read tool to load the document content and analyze:
3941

4042
### Step 3: Create the task list
4143

42-
Create a structured task list at the END of the issue document using this format:
44+
Create a structured markdown task list and pass it to the UpdatePlan tool as the `plan` string. The tool input must use this shape:
45+
46+
```json
47+
{
48+
"plan": "## Task List\n\n- [ ] Task 1 description\n- [ ] Task 2 description\n- [ ] Task 3 description"
49+
}
50+
```
51+
52+
Use this markdown format for the `plan` content:
4353

4454
```markdown
4555
## Task List
4656

4757
- [ ] Task 1 description
4858
- [ ] Task 2 description
4959
- [ ] Task 3 description
50-
51-
### Task Status Legend
52-
- [ ] Pending
53-
- [>] In Progress
54-
- [x] Completed
5560
```
5661

57-
Use the Edit tool to append this section to the document. Break down complex requirements into specific, actionable tasks.
62+
Do not append the task list to a source file. Break down complex requirements into specific, actionable tasks and call UpdatePlan with the full markdown task list.
5863

5964
### Step 4: Execute tasks systematically
6065

6166
For each task in the list:
6267

63-
1. **Mark as in progress**: Update the task in the document from `[ ]` to `[>]`
68+
1. **Mark as in progress**: Call UpdatePlan with the task changed from `[ ]` to `[>]`
6469
2. **Execute the task**: Use appropriate tools to complete the work
65-
3. **Mark as completed**: Update the task from `[>]` to `[x]` when finished
70+
3. **Mark as completed**: Call UpdatePlan with the task changed from `[>]` to `[x]` when finished
6671
4. **Move to next task**: Only ONE task should be in progress at a time
6772

6873
Important rules:
69-
- Always update the document BEFORE starting work on a task
70-
- Always update the document IMMEDIATELY after completing a task
74+
- Always call UpdatePlan BEFORE starting work on a task
75+
- Always call UpdatePlan IMMEDIATELY after completing a task
76+
- Always pass the complete current markdown task list, not a partial diff
7177
- Never work on multiple tasks simultaneously
7278
- If you encounter errors, keep the task as `[>]` and create new tasks to resolve blockers
7379

@@ -76,63 +82,54 @@ Important rules:
7682
If during execution you discover a task is more complex than expected:
7783

7884
1. Keep the current task as `[>]`
79-
2. Add new sub-tasks below it with indentation:
85+
2. Call UpdatePlan with new sub-tasks below it with indentation:
8086
```markdown
8187
- [>] Main task
8288
- [ ] Sub-task 1
8389
- [ ] Sub-task 2
8490
```
85-
3. Complete sub-tasks first, then mark the main task as complete
91+
3. Complete sub-tasks first, then mark the main task as complete with UpdatePlan
8692

8793
### Step 6: Final verification
8894

8995
After all tasks are completed (`[x]`):
9096

91-
1. Review the issue requirements to ensure everything is addressed
97+
1. Review the original requirements to ensure everything is addressed
9298
2. Run any final checks (tests, builds, linting)
93-
3. Add a completion summary at the end of the document
99+
3. Call UpdatePlan with every task marked `[x]`
100+
4. Provide a concise completion summary in the final response
94101

95102
## Task State Symbols
96103

97-
- `[ ]` - **Pending**: Not started yet
98-
- `[>]` - **In Progress**: Currently working on this
99-
- `[x]` - **Completed**: Finished successfully
100-
- `[!]` - **Blocked**: Cannot proceed (optional, for blocked tasks)
104+
- `[ ]` - Pending
105+
- `[>]` - In progress
106+
- `[x]` - Completed
107+
- `[!]` - Blocked
101108

102109
## Examples
103110

104111
### Example 1: Simple feature request
105112

106-
**Issue document (before):**
113+
**Example requirements:**
107114
```markdown
108115
# Feature: Add dark mode toggle
109116

110117
Users should be able to switch between light and dark themes.
111118
The toggle should be in the settings page.
112119
```
113120

114-
**Issue document (after task list added):**
121+
**UpdatePlan call after analysis:**
115122
```markdown
116-
# Feature: Add dark mode toggle
117-
118-
Users should be able to switch between light and dark themes.
119-
The toggle should be in the settings page.
120-
121123
## Task List
122124

123125
- [ ] Create dark mode toggle component in Settings page
124126
- [ ] Add dark mode state management (context/store)
125127
- [ ] Implement CSS-in-JS styles for dark theme
126128
- [ ] Update existing components to support theme switching
127129
- [ ] Run tests and verify functionality
128-
129-
### Task Status Legend
130-
- [ ] Pending
131-
- [>] In Progress
132-
- [x] Completed
133130
```
134131

135-
**During execution:**
132+
**UpdatePlan call during execution:**
136133
```markdown
137134
## Task List
138135

@@ -145,15 +142,15 @@ The toggle should be in the settings page.
145142

146143
### Example 2: Bug fix with investigation
147144

148-
**Issue document:**
145+
**Example requirements:**
149146
```markdown
150147
# Bug: Login form crashes on submit
151148

152149
When users click submit, the app crashes.
153150
Error message: "Cannot read property 'email' of undefined"
154151
```
155152

156-
**Task list created:**
153+
**UpdatePlan call after analysis:**
157154
```markdown
158155
## Task List
159156

@@ -164,23 +161,18 @@ Error message: "Cannot read property 'email' of undefined"
164161
- [ ] Add validation to prevent similar issues
165162
- [ ] Test the fix with various inputs
166163
- [ ] Update error handling
167-
168-
### Task Status Legend
169-
- [ ] Pending
170-
- [>] In Progress
171-
- [x] Completed
172164
```
173165

174166
## When to Use This Skill
175167

176168
Use this Skill when:
177169

178-
1. **Complex multi-step tasks** - Issue requires 3+ distinct steps
170+
1. **Complex multi-step tasks** - Request requires 3+ distinct steps
179171
2. **Feature implementation** - Building new functionality from requirements
180172
3. **Bug fixing** - Need to investigate, fix, and verify
181173
4. **Refactoring** - Multiple files or components need changes
182-
5. **User provides requirements** - Issue document contains specifications
183-
6. **Need progress tracking** - Want visible progress in the document itself
174+
5. **Detailed requirements** - Specifications need to be translated into concrete tasks
175+
6. **Need progress tracking** - Want visible progress without editing source files
184176

185177
## When NOT to Use This Skill
186178

@@ -189,7 +181,7 @@ Skip this Skill when:
189181
1. **Single simple task** - Just one straightforward action needed
190182
2. **Trivial changes** - Quick fixes that don't need planning
191183
3. **Informational requests** - User just wants explanation, not execution
192-
4. **No document provided** - User hasn't created an issue document
184+
4. **No execution requested** - User only wants brainstorming or a high-level explanation
193185

194186
## Best Practices
195187

@@ -236,24 +228,24 @@ Add implementation notes or findings:
236228

237229
## Requirements
238230

239-
This Skill uses standard Deep Code tools:
231+
This Skill uses standard tools:
240232

241-
- **Read**: To read the issue document
242-
- **Edit**: To update task status in the document
233+
- **Read**: To inspect referenced files when needed
234+
- **UpdatePlan**: To create and update the markdown task list
243235
- **Bash**: To run tests, builds, or other commands
244236
- **Write**: To create new files if needed
245237

246238
No additional dependencies required.
247239

248240
## Workflow Summary
249241

250-
1. Ask user for issue document path
251-
2. Read and analyze the document
252-
3. Append structured task list to document
242+
1. Analyze the requirements
243+
2. Read referenced files when needed
244+
3. Call UpdatePlan with the structured markdown task list
253245
4. For each task:
254-
- Update to `[>]` in document
246+
- Update to `[>]` with UpdatePlan
255247
- Execute the task
256-
- Update to `[x]` in document
257-
5. Add completion summary when done
248+
- Update to `[x]` with UpdatePlan
249+
5. Call UpdatePlan with all tasks completed and summarize the result
258250

259-
This approach keeps all planning and progress tracking in one place - the issue document itself - making it easy for users to see what's been done and what's remaining.
251+
This approach keeps planning and progress tracking in the UpdatePlan display, leaving source materials unchanged unless the actual task requires editing them.

0 commit comments

Comments
 (0)