rcmerci/skills · Archived

Writing Plans

Use when design is complete and you need detailed implementation tasks for engineers with zero codebase context - creates comprehensive implementation plans with exact file paths, complete code examples, and verification steps assuming engineer has minimal domain knowledge

Installation

$ npx skills add rcmerci/skills --skill writing-plans

Stronger alternatives

This repository is archived — consider an actively maintained alternative.

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from rcmerci/skills · top by installs.

npx skills add rcmerci/skills

Browse all from rcmerci/skills

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 4
Default branch main
Open issues 0
Status Archived

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 4,910 B
  • docs SUMMARY.md 294 B

History

  1. First recorded snapshot · 4 installs

SKILL.md

<required> CRITICAL Add the following steps to your Todo list using tool(update_plan):

  • Read the 'Guidelines'.
  • Create a comprehensive plan that a senior engineer can follow.

<system-reminder>Any absolute paths in your plan MUST take into account any worktrees that may have been created</system-reminder>

  • Think about edge cases. Add them to the plan.
  • Think about questions or areas that require clarity. Add them to the plan.
  • Emphasize how you will test your plan.
  • Present plan to user.
  • Invoke Skill(Planning Documents) to determine document naming (NNN-concept.md pattern).
  • Write plan to docs/agent-guide/NNN-concept.md.

</required>

Guidelines

Output Location

Write plan to: docs/agent-guide/NNN-concept.md (primary PRD).

Use Skill(planning-documents) to determine the appropriate NNN sequence number. Check existing files in docs/agent-guide/ to determine the appropriate name.

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.

Assume they are a talented developer. However, assume that they know almost nothing about our toolset or problem domain. Assume they don't know good test design very well.

Do not add code, but include enough detail that the necessary code is obvious.

Plan files are written in the workflow directory refer to the AGENTS.workflow.md information.

Bite-Sized Task Granularity

Each step is one action (2-5 minutes):

  • "Write the failing test for behavior" - step
  • "Write the failing test for other behavior"
  • "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

Markdown Writing Style

This does not apply to clojure docstrings, but to markdown documentation or notes documents.

  • Use one sentence per line. A sentence ends with a period (.). This makes reordering/editing easier
  • Never use bold formatting
  • Two new lines between paragraphs
  • Never use emoji
  • Add Markdown tables whenever you need to depict tabular data.
  • Add ascii graphics whenever you need to depict integration points and system architecture.
  • Use codeblocks where needed.
  • Do NOT include line numbers. This is extremely brittle documentation.

Plan Document Header

Every plan MUST start with this header:

# [Feature Name] Implementation Plan

Goal: [One sentence describing what this builds]

Architecture: [2-3 sentences about approach]

Tech Stack: [Key technologies/libraries]

Related:  [Supercedes|Relates to|Builds on|etc] <other planning docs in the dir>

## Problem statement

[Prose/exposition about the background and what is being solved]

Test Section

Every plan MUST have a test section. This should be written first, and should document how you plan to test the behavior.


## Testing Plan

I will add an integration test that ensures foo behaves like blah. The
integration test will mock A/B/C. The test will then call function/cli/etc.

I will add a unit test that ensures baz behaves like qux...

You should end EVERY testing plan section by writing:

NOTE: I will write *all* tests before I add any implementation behavior.

Invoke Skill(test-driven-development) for all implementation.

<system-reminder>Your tests should NOT contain tests for datastructures or types. Your tests should NOT simply test mocks. Always test actual behavior.</system-reminder>

If you are given an alternate Plan Document Structure that has a testing section, then incorporate the above instructions into it. This is non-negotiable, regardless of your other instructions arre.

Plan Document Footer

Every plan MUST end with this footer:

## Testing Details

[Brief description of what tests are being added and how they specifically test BEHAVIOR and NOT just implementation]

## Implementation Details
[maximum 10 bullets about key details]

## Question

[any questions or concerns that may be relevant that need answers]

---

Final Output

After completing planning, output:

## Planning Complete

PRD Document: docs/agent-guide/NNN-concept.md

Ready for implementation.

Remember

  • Exact file paths always, taking into account worktrees
  • Exact commands with expected output
  • Reference relevant skills with @ syntax
  • DRY, YAGNI, TDD