agentleFS
roundpilotroundpilot/superpowers-antigravity/skills/writing-plans/SKILL.md

writing-plans

Skill80 starsChanged 8 days agoMITView on GitHub

Use when you have a spec or requirements for a multi-step task, before touching code

187 other projects use a version of this, 143 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use chinese-code-review, chinese-commit-conventions and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • Leodorareluctant259Skill

    chinese-code-review

    中文代码审查规范——在保持专业严谨的同时,用符合国内团队文化的方式给出有效反馈

    Also in 8 projects that use this

  • Leodorareluctant259Skill

    chinese-commit-conventions

    中文 Git 提交规范 — 适配国内团队的 commit message 规范和 changelog 自动化

    Also in 8 projects that use this

  • ryanportfolioSkill

    addskill

    Create, import, update, or install repo or personal skills: runtime ownership, resources, discovery checks.

    Also in 6 projects that use this

  • ryanportfolioSkill

    apply-firmware

    Bring current folder (plain folder, existing repo, old or partial firmware copy) up to full Harness Firmware in place. Mirror external repo → adopt-repo.

    Also in 6 projects that use this

  • +2 more from Leodorareluctant259
  • +6 more from ryanportfolio

The file

Show its rules and text

We split this skill into the rules it gives an agent

17 rules. 1 is common, 11 are distinctive, and 5 are very specific to this project.

  • 1

    Common

    Most of the 169 edited versions we read keep these.

  • 11

    Distinctive

    This author's own choices. Worth a look.

  • 5

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Context: If working in an isolated worktree, it should have been created via the superpowers:using-git-worktrees skill at execution time.

    line 14
  2. Distinctive:

    If the spec covers multiple independent subsystems, it should have been broken into sub-project specs during brainstorming.

    line 26
  3. Distinctive:

    Before defining tasks, map out which files will be created or modified and what each one is responsible for.

    line 30
  4. Very specific:

    When integrating with external APIs or libraries, use search_web and read_url_content to fetch current documentation before locking in the …

    line 36
  5. Distinctive:

    Use Antigravity's artifact formatting to make plans scannable:

    line 182
  6. Very specific:

    File links: Always use clickable links: filename or function

    line 184
  7. Distinctive:

    Diff blocks: when a step fixes exact copy in an existing file (prose, or a value the spec pins), show that change as a diff:

    line 185
  8. Distinctive:

    Mermaid diagrams: Use in the architecture section and for complex data flows within tasks

    line 195
  9. Distinctive:

    After writing the complete plan, look at the spec with fresh eyes and check the plan against it.

    line 199
  10. Distinctive:

    2. Step scan: Every step must let the implementer write exactly one reasonable thing, and no step may carry more than that: a line that …

    line 203
  11. Very specific:

    3. Type consistency: Do the types, method signatures, and property names you used in later tasks match what you defined in earlier tasks?

    line 205
  12. Distinctive:

    If you find issues, fix them inline.

    line 211
  13. Distinctive:

    After saving and self-reviewing the plan, link it for your human partner to read.

    line 215
  14. Very specific:

    Ask with ask_question: one single-select question whose text is the message below, with short options, the recommended method first.

    line 223
  15. Distinctive:

    Whichever question you asked: ask it even when your partner already pressed Proceed.

    line 247
  16. Common:

    REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development

    line 254
  17. Distinctive:

    REQUIRED SUB-SKILL: Use superpowers:executing-plans

    line 257

“Common” is measured: kept by at least 6 in 10 of the 169 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Writing Plans

Overview

Write implementation plans for an engineer who has not seen this codebase or this spec. Assume they write idiomatic code in the project's language once they know the exact interface and the exact test, and that they will make a reasonable choice wherever the plan leaves one open. What they cannot know is what you decided: which files, which names and signatures, which values from the spec, which tests prove each task. Document those. Give them the whole plan as bite-sized tasks. DRY. YAGNI. TDD. Frequent commits.

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)

If your human partner started with /plan, or the CLI is in plan mode: that mode asks for an implementation plan, and this skill writes it. Write one plan — this skill's format, at this skill's save path — and finish with this skill's handoff. Never draft a second, built-in plan beside it.

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.
  • When integrating with external APIs or libraries, use search_web and read_url_content to fetch current documentation before locking in the file structure

This structure informs the task decomposition. Each task should produce self-contained changes that make sense independently.

Task Right-Sizing

A task is the smallest unit that carries its own test cycle and is worth a fresh reviewer's gate. When drawing task boundaries: fold setup, configuration, scaffolding, and documentation steps into the task whose deliverable needs them; split only where a reviewer could meaningfully reject one task while approving its neighbor. Each task ends with an independently testable deliverable.

Step Granularity

Each step is one action with a checkable result:

  • "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]

**Architecture Diagram:**

```mermaid
graph TD
    subgraph "Component Name"
        A[Module A] --> B[Module B]
    end

Include a Mermaid diagram showing component relationships and data flow. This diagram should match the architecture description above.

Tech Stack: [Key technologies/libraries]

Spec: [path to the spec/design doc this plan implements — the plan argues from the spec, so the spec travels with it; executors read both]

Global Constraints

[The spec's project-wide requirements — version floors, dependency limits, naming and copy rules, platform requirements — one line each, with exact values copied verbatim from the spec. Every task's requirements implicitly include this section.]

Review Focus

[The five input classes or failure modes the spec implies but no task's tests exercise that are most likely to bite a person using this software — one line each, naming the input or condition and the behavior a reasonable person would expect, most likely first. The spec is a vision document: it says what the software must do, not everything it will meet, and its silence on an input is not permission for that input to break the program. Write the list here, once, with the spec in front of you. Then, for each line, add the test that pins it to the task that owns the code, in that task's own step style.]



## Task Structure

````markdown
### 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`

**Interfaces:**
- Consumes: [what this task uses from earlier tasks — exact signatures]
- Produces: [what later tasks rely on — exact function names, parameter
  and return types. A task's implementer sees only their own task; this
  block is how they learn the names and types neighboring tasks use.]

- [ ] **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: Implement function(input: InputType) -> ResultType in exact/path/to/file.py

One line on the approach when the signature and the test leave a choice (which library call, which data structure); a code block only for an algorithm they do not determine.

  • Step 4: Run test to verify it passes

Run: pytest tests/path/test.py::test_name -v Expected: PASS

  • Step 5: Commit
git add tests/path/test.py src/path/file.py
git commit -m "feat: add specific feature"

## What a Step Contains

A step is done when the implementer can write exactly one reasonable thing
from it. That is the whole requirement: unambiguous, not complete. Each kind
of step carries what makes it unambiguous and nothing more:

- **A test step:** the test's name and its assertions, as code, with the
  spec's exact values in them.
- **A code step:** the exact signature (name, parameters, return type), the
  file it lives in, and the specific values the spec pins. The implementer
  writes the body. A body appears only for an algorithm the signature and
  tests do not determine, or for exact copy the spec fixes.
- **A verification step:** the command to run and the output that means it
  passed.
- **A reference to another task:** that task's Interfaces block says what
  to use; the plan does not repeat that task's code.

A plan is the set of decisions the implementer cannot make alone. A plan
longer than the code it describes has written the code instead. Lines that
decide nothing ("TBD", "handle edge cases", "add appropriate validation",
"write tests for the above", a type or function no task defines) are the
opposite failure, and the self-review catches both.

## Rich Formatting

Use Antigravity's artifact formatting to make plans scannable:

- **File links:** Always use clickable links: `[filename](file:///absolute/path/to/file)` or `[function](file:///path/to/file#L10-L20)`
- **Diff blocks:** when a step fixes exact copy in an existing file (prose, or a value the spec pins), show that change as a diff:
  ```diff
  -old_function_name()
  +new_function_name()
   unchanged_line()
  ```
- **GitHub alerts:** Flag critical requirements and breaking changes:
  > [!IMPORTANT]
  > This change requires a database migration

- **Mermaid diagrams:** Use in the architecture section and for complex data flows within tasks

## 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. Step scan:** Every step must let the implementer write exactly one reasonable thing, and no step may carry more than that: a line that decides nothing is a gap, a function body the signature and tests already determine is a transcript. Fix both.

**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.

**4. Review Focus:** For each input class or failure mode the spec implies, is there a task whose tests exercise it? The five uncovered ones most likely to bite a person go in the Review Focus section, and each line there gets its test added to the owning task. An empty section means you checked and found none, not that you skipped the check.

**5. Proportion:** Compare the plan's length to the spec's. A plan several times longer than the spec it implements is a transcript of the program, not a plan. If code blocks are most of the document, replace bodies with signatures, test names and assertions, and check that each step is still unambiguous.

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 and self-reviewing the plan, link it for your human partner
to read. If they have already explicitly supplied an execution method, ask
them to review the plan and confirm it captures what they want; wait for that
review before implementation, then use the preserved method. Otherwise, ask
them to review the plan and choose an execution method before implementation.

**Linking it:** save the plan as a plain repository file — a whole-file `write_to_file` with no `IsArtifact` and no `ArtifactMetadata`, because artifact writes are refused outside the conversation folder. Ask the question below after the write returns.

Ask with `ask_question`: one single-select question whose text is the message below, with short
options, the recommended method first. Choosing a method answers "does the plan capture what you
want?" with yes.

**When no execution method has already been supplied:**

**"Plan complete and saved to `docs/superpowers/plans/<filename>.md`. Please review the plan. Which execution approach would you prefer?**

- **Subagent-driven** - A fresh subagent implements each task and a fresh reviewer checks it before the next one starts, then a whole-branch review at the end. Most thorough; costs a fresh context per task and per review.
- **Native** - I implement every task myself in this session, the way this harness runs work, then one fresh reviewer at the Pro model tier — which model that is, is not documented — checks the whole branch. Cheapest and fastest; no independent review until the end. Runs well with a mid-tier session model, since the plan carries the design.

**For this plan I recommend <one of the two>, because <one sentence from the plan: how much the tasks depend on each other's interfaces, how many there are, what a shipped mistake would cost>. Does the plan capture what you want, and which approach should we use?"**

Options: "<recommended method> (recommended)", "<the other method>",
"The plan needs changes — I'll comment on it or tell you". If you cannot dispatch subagents in
this session, recommend Native and say that is why — and say that the final review is then your
own review of the whole branch, not a fresh reviewer's.

**When an execution method has already been supplied:**

**"Plan complete and saved to `docs/superpowers/plans/<filename>.md`. Please review the plan. Does it capture what you want?"**

Options: "Yes — go ahead with <method>", "The plan needs changes — I'll comment on it or tell you".

**Whichever question you asked:** ask it even when your partner already pressed Proceed. A
cancelled question is no answer: wait for their message, and never fall back to your
recommendation. Comments on the plan, a submitted review, a rejected write, or "The plan needs
changes" are change requests: read their comments or reply, revise that section, re-run the
self-review, save again the same way, and ask again.

**If Subagent-driven chosen:**
- **REQUIRED SUB-SKILL:** Use superpowers:subagent-driven-development

**If Native chosen:**
- **REQUIRED SUB-SKILL:** Use superpowers:executing-plans

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.