Use when you have a spec or requirements for a multi-step task, before touching code
View on GitHubSelect agents to install to:
npx add-skill https://github.com/lgbarn/shipyard/blob/main/skills/shipyard-writing-plans/SKILL.md -a claude-code --skill shipyard-writing-plansInstallation paths:
.claude/skills/shipyard-writing-plans/<!-- TOKEN BUDGET: 170 lines / ~510 tokens -->
# 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:** This should be run in a dedicated worktree (created by brainstorming skill).
**Save plans to:** `docs/plans/YYYY-MM-DD-<feature-name>.md`
## Shipyard Plan Format
Shipyard plans use XML-structured tasks with verification criteria. Each task includes:
```xml
<task id="1" name="Component Name">
<description>What this task accomplishes</description>
<files>
<create>exact/path/to/file.py</create>
<modify>exact/path/to/existing.py:123-145</modify>
<test>tests/exact/path/to/test.py</test>
</files>
<steps>
<step>Write the failing test</step>
<step>Run test to verify it fails</step>
<step>Write minimal implementation</step>
<step>Run test to verify it passes</step>
<step>Commit</step>
</steps>
<verification>
<command>pytest tests/path/test.py::test_name -v</command>
<expected>PASS</expected>
</verification>
</task>
```
This structured format enables `/shipyard:build` to parse and execute tasks systematically, and `/shipyard:status` to track progress.
## 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
**Ever