home / skills / bbeierle12 / skill-mcp-claude / writing-plans

writing-plans skill

/skills/writing-plans

This skill generates clear, executable implementation plans for developers, outlining tasks, tests, and verification to ensure rapid, reliable delivery.

npx playbooks add skill bbeierle12/skill-mcp-claude --skill writing-plans

Review the files below or copy the command above to add this skill to your agents.

Files (2)
SKILL.md
3.1 KB
---
name: writing-plans
description: Use after brainstorming/design phase to create detailed implementation plans. Creates step-by-step plans clear enough for execution by any developer.
---

# Writing Plans

## Core Principle

Write plans clear enough for **an enthusiastic junior engineer with poor taste, no judgement, no project context, and an aversion to testing** to follow.

## Plan Structure

Save plans to: `docs/plans/YYYY-MM-DD-<feature-name>.md`

```markdown
# [Feature Name] Implementation Plan

> **For Claude:** Use executing-plans skill to implement this plan task-by-task.

## Overview
Brief description of what we're building and why.

## Prerequisites
- [ ] Dependency 1 installed
- [ ] Service 2 running
- [ ] Access to X configured

## Tasks

### Task 1: [Descriptive Name]
**File:** `path/to/file.ts`
**Test:** `path/to/file.test.ts`

#### Test First (RED)
```typescript
// Exact test code to write
describe('FeatureName', () => {
  it('should do specific thing', () => {
    // Arrange
    // Act  
    // Assert
  });
});
```

#### Implementation (GREEN)
```typescript
// Exact implementation code
export function featureName() {
  // Implementation
}
```

#### Verification
```bash
npm test -- --grep "FeatureName"
# Expected: 1 passing
```

### Task 2: [Next Task]
...

## Integration Tests
After all tasks complete:
```bash
# Commands to run
npm run test:integration
```

## Manual Verification
Steps to manually verify the feature works:
1. Step 1
2. Step 2
3. Expected result

## Rollback Plan
If something goes wrong:
1. `git revert HEAD`
2. ...
```

## Plan Quality Checklist

### Every Task Must Have:
- [ ] Exact file paths
- [ ] Complete code (not "add validation")
- [ ] Test written BEFORE implementation
- [ ] Verification command with expected output
- [ ] Clear success criteria

### Plan Must Include:
- [ ] Prerequisites listed
- [ ] Tasks in dependency order
- [ ] Integration test at end
- [ ] Rollback instructions

## Writing Guidelines

### Be Explicit
❌ "Add error handling"
✅ "Wrap the API call in try/catch, log errors with context, return null on failure"

### Be Complete
❌ "Update the config"
✅ ```json
{
  "setting": "value",
  "newSetting": "newValue"
}
```

### Be Ordered
Tasks should be executable in sequence:
1. No forward dependencies
2. Each task builds on previous
3. Tests pass after each task

## Execution Handoff

After saving the plan, offer execution choice:

**"Plan complete and saved. Two execution options:**

**1. Subagent-Driven (this session)**
- Fresh subagent per task
- Review between tasks
- Fast iteration

**2. Parallel Session (separate)**
- Open new session with executing-plans skill
- Batch execution with checkpoints

**Which approach?"**

## DRY, YAGNI, TDD Reminders

Include at top of every plan:

```markdown
## Remember
- Exact file paths always
- Complete code in plan (not "add validation")
- Exact commands with expected output
- DRY, YAGNI, TDD, frequent commits
```

## Anti-Patterns

### Don't Do This
- Vague task descriptions
- Missing file paths
- Incomplete code snippets
- Implementation before tests
- No verification steps
- Assuming context

Overview

This skill creates detailed, executable implementation plans after the brainstorming or design phase. Plans are written so an enthusiastic junior developer with no context can follow them to completion, including tests, file paths, verification commands, and rollback steps.

How this skill works

The skill generates a structured markdown plan saved to a timestamped path and broken into prerequisites, ordered tasks, integration tests, manual verification, and rollback instructions. Each task includes exact file paths, a test-first code snippet, the implementation snippet, and the command to verify expected test output. It also appends a short execution handoff with options for in-session or parallel execution.

When to use it

  • After design or architecture decisions are finalized
  • When you need a plan that a junior developer can execute end-to-end
  • Before handing work to a subagent or another developer
  • When tests and verifiable steps are required for delivery
  • When you want reproducible rollback and integration steps

Best practices

  • Always include exact file paths and complete code for tests and implementation
  • Write tests first (RED) and provide the exact command and expected passing output
  • Order tasks so each builds on the previous with no forward dependencies
  • List prerequisites and environment setup explicitly
  • Keep plans DRY and avoid speculative changes — prefer minimal, test-driven changes

Example use cases

  • Implement a new API endpoint with unit and integration tests and manual verification steps
  • Add a feature toggle with tests, documentation file updates, and rollback instructions
  • Migrate a small module with step-by-step tests and verification commands
  • Onboard a contributor by giving them a complete, runnable implementation plan they can follow

FAQ

What file name and location does the plan use?

Plans are saved as docs/plans/YYYY-MM-DD-<feature-name>.md with a descriptive title and the Remember checklist at the top.

Do plans include test code and implementation code?

Yes — every task includes exact test-first code, the implementation snippet, and the verification command with expected output.

How do I hand off execution?

The plan ends with two execution options: subagent-driven sequential execution with reviews, or a parallel session for batch execution with checkpoints.