writing-plans
- 信任分
- 88/100
- 兼容 Agent
- 1
- 领域
- 文档
- 兼容 Agent
- Claude Code
- 信任分
- 88 / 100 · 社区维护
- 作者 / 版本 / 许可
- @obra · 未声明 license
- 安装命令数
- 1 条
需要注意: 未限定 allowed-tools,默认拥有全部工具权限。
想读作者英文原文? ↓ 滚到正文区切换 · 在 GitHub 查看 ↗
writing-plans 写的是实施计划——目标读者是「假设对你的代码库零上下文、品味也未必好」的工程师。计划要明确:每条任务碰哪些文件、给到代码、列要看的测试与文档、说怎么验。整体走 DRY / YAGNI / TDD / 频繁 commit 的旗帜。
设计思路
作者把计划当成写给陌生人的合同:技能扎实但不熟你这套 toolset / problem domain,也不太懂好的测试设计——所以把上下文 + 拆任务 + 验证手段全塞进去。同时认知到计划者推理力受限于一次能 hold 在脑里的代码量——所以「文件分解」是第一等大事。
文件存放
默认 docs/superpowers/plans/YYYY-MM-DD-<feature-name>.md(用户偏好可覆盖)。Scope Check:如果 spec 跨多个独立子系统,应该在 brainstorming 阶段就拆成 sub-project spec;没拆就建议拆——每份计划都应能独立产出可工作可测试的软件。
File Structure 必须先定
定 task 之前先画文件清单:哪些文件被新建 / 修改、各自负责什么——这步把「分解决策」钉死。原则:每个文件单一明确职责;改在一起的文件放在一起——按职责拆而非按技术层;已有 codebase 用大文件就别擅自重组,但你正在改的文件长得不像样子时把"拆"也写进计划是合理的。
Bite-Sized Task Granularity
每一步是 2–5 分钟的单个动作:「写失败测试」是一步、「跑一遍确认它失败」是一步、「写让它过的最小代码」是一步、「跑测试确认通过」是一步、「commit」是一步——不要把它们合成一行。这样整张计划是 RED→GREEN 节奏的真实 step list,不是模糊的目标列表。
Plan Document Header
顶部要有 frontmatter / header 说明 scope、文件结构、参考资料——让接管的人一眼知道在哪儿能找到上下文。No placeholders:不要写 TODO: figure out X——计划阶段就要解决,留 TODO 等于把决策推给执行者。
Self-Review & Execution Handoff
写完自检一遍:每条任务自包含可独立验吗?文件分解能 hold 进同一个上下文窗口吗?测试覆盖了关键 behavior 吗?最后 handoff 时明确「执行者用什么 skill」(多半 subagent-driven-development / executing-plans)。
适合谁
- 多人 / 多 agent 协作的中大型 feature / refactor
- 想把「思考阶段」与「执行阶段」彻底分开
- 让 subagent 接力执行的工程节奏
何时不要用
- 改动只有一两个 commit:直接做更省
- 还没和用户对齐就着急写 plan:先
writing-fragments/ 讨论
配套
request-refactor-plan(重构 RFC)、to-prd(PRD)、to-issues(计划落 issue)、subagent-driven-development / executing-plans(执行)、using-git-worktrees(隔离工作区)、tdd / test-driven-development(执行时的红绿循环)。
Writing Plans
Overview
Write comprehensive implementation plans assuming the engineer has zero context for our codebase and questionable taste. Document everything they need to know: which files to touch for each task, code, testing, docs they might need to check, how to test it. Give them the whole plan as bite-sized tasks. DRY. YAGNI. TDD. Frequent commits.
Assume they are a skilled developer, but know almost nothing about our toolset or problem domain. Assume they don't know good test design very well.
Announce at start: "I'm using the writing-plans skill to create the implementation plan."
Context: If working in an isolated worktree, it should have been created via the superpowers:using-git-worktrees skill at execution time.
Save plans to: docs/superpowers/plans/YYYY-MM-DD-<feature-name>.md
- (User preferences for plan location override this default)
Scope Check
If the spec covers multiple independent subsystems, it should have been broken into sub-project specs during brainstorming. If it wasn't, suggest breaking this into separate plans — one per subsystem. Each plan should produce working, testable software on its own.
File Structure
Before defining tasks, map out which files will be created or modified and what each one is responsible for. This is where decomposition decisions get locked in.
- Design units with clear boundaries and well-defined interfaces. Each file should have one clear responsibility.
- You reason best about code you can hold in context at once, and your edits are more reliable when files are focused. Prefer smaller, focused files over large ones that do too much.
- Files that change together should live together. Split by responsibility, not by technical layer.
- In existing codebases, follow established patterns. If the codebase uses large files, don't unilaterally restructure - but if a file you're modifying has grown unwieldy, including a split in the plan is reasonable.
This structure informs the task decomposition. Each task should produce self-contained changes that make sense independently.
Bite-Sized Task Granularity
Each step is one action (2-5 minutes):
- "Write the failing test" - step
- "Run it to make sure it fails" - step
- "Implement the minimal code to make the test pass" - step
- "Run the tests and make sure they pass" - step
- "Commit" - step
Plan Document Header
Every plan MUST start with this header:
# [Feature Name] Implementation Plan
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
**Goal:** [One sentence describing what this builds]
**Architecture:** [2-3 sentences about approach]
**Tech Stack:** [Key technologies/libraries]
---
Task Structure
### Task N: [Component Name]
**Files:**
- Create: `exact/path/to/file.py`
- Modify: `exact/path/to/existing.py:123-145`
- Test: `tests/exact/path/to/test.py`
- [ ] **Step 1: Write the failing test**
```python
def test_specific_behavior():
result = function(input)
assert result == expected
```
- [ ] **Step 2: Run test to verify it fails**
Run: `pytest tests/path/test.py::test_name -v`
Expected: FAIL with "function not defined"
- [ ] **Step 3: Write minimal implementation**
```python
def function(input):
return expected
```
- [ ] **Step 4: Run test to verify it passes**
Run: `pytest tests/path/test.py::test_name -v`
Expected: PASS
- [ ] **Step 5: Commit**
```bash
git add tests/path/test.py src/path/file.py
git commit -m "feat: add specific feature"
```
No Placeholders
Every step must contain the actual content an engineer needs. These are plan failures — never write them:
- "TBD", "TODO", "implement later", "fill in details"
- "Add appropriate error handling" / "add validation" / "handle edge cases"
- "Write tests for the above" (without actual test code)
- "Similar to Task N" (repeat the code — the engineer may be reading tasks out of order)
- Steps that describe what to do without showing how (code blocks required for code steps)
- References to types, functions, or methods not defined in any task
Remember
- Exact file paths always
- Complete code in every step — if a step changes code, show the code
- Exact commands with expected output
- DRY, YAGNI, TDD, frequent commits
Self-Review
After writing the complete plan, look at the spec with fresh eyes and check the plan against it. This is a checklist you run yourself — not a subagent dispatch.
1. Spec coverage: Skim each section/requirement in the spec. Can you point to a task that implements it? List any gaps.
2. Placeholder scan: Search your plan for red flags — any of the patterns from the "No Placeholders" section above. Fix them.
3. Type consistency: Do the types, method signatures, and property names you used in later tasks match what you defined in earlier tasks? A function called clearLayers() in Task 3 but clearFullLayers() in Task 7 is a bug.
If you find issues, fix them inline. No need to re-review — just fix and move on. If you find a spec requirement with no task, add the task.
Execution Handoff
After saving the plan, offer execution choice:
"Plan complete and saved to docs/superpowers/plans/<filename>.md. Two execution options:
1. Subagent-Driven (recommended) - I dispatch a fresh subagent per task, review between tasks, fast iteration
2. Inline Execution - Execute tasks in this session using executing-plans, batch execution with checkpoints
Which approach?"
If Subagent-Driven chosen:
- REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development
- Fresh subagent per task + two-stage review
If Inline Execution chosen:
- REQUIRED SUB-SKILL: Use superpowers:executing-plans
- Batch execution with checkpoints for review