writing-plans

Create Markdown implementation plans with files, tests, commands, and commit steps.

16|9|Updated Nov 6, 2013
One-click install
npx skills add https://github.com/erikstmartin/dotfiles --skill writing-plans-erikstmartin
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-plans
Source: https://github.com/erikstmartin/dotfiles/tree/main/skills/global/.agents/skills/writing-plans
Command: npx skills add https://github.com/erikstmartin/dotfiles --skill writing-plans-erikstmartin

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

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. Frequent commits.

Core Features & Use Cases

  • Announce at start: clearly label the plan as a plan and include structured task blocks.
  • Save plans to docs/plans/YYYY-MM-DD-<feature-name>.md
  • Include a detailed Task Structure with files, steps, and commit commands.
  • Provide an explicit execution handoff and optional sub-skill integration.

Quick Start

Use the writing-plans skill to create the implementation plan.

Frequently Asked Questions about writing-plans

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a step-by-step implementation plan for a new software feature?

Generate a comprehensive implementation plan by breaking the feature into bite-sized tasks. Specify which files to touch, testing procedures, and commit commands, saving the final output as a Markdown file.

What is an implementation plan in software engineering and what should it include?

An implementation plan is a detailed document guiding engineers with zero codebase context. It includes structured task blocks detailing specific files to modify, code steps, testing procedures, documentation, and explicit git commit commands.

How do I document implementation tasks for engineers unfamiliar with my codebase?

Document implementation tasks by providing exhaustive context for each step. Include exact file paths, required code changes, testing instructions, relevant documentation, and commit commands, applying DRY and YAGNI principles.

Can I save implementation plans as Markdown files within my project repository?

Yes, implementation plans are saved directly in the repository as Markdown files. They are stored in the docs/plans/ directory using a YYYY-MM-DD-<feature-name>.md naming convention for chronological tracking.

Does the generated implementation plan support execution handoff for automated workflows?

Yes, the plan provides an explicit execution handoff workflow with optional sub-skill integration. This allows downstream automation to execute the structured task blocks sequentially using the documented steps and commands.

What is the best way to structure technical planning for frequent git commits?

Structure technical planning by breaking features into bite-sized tasks ending with explicit commit commands. This approach ensures engineers can make frequent commits, adhering to DRY and YAGNI principles while maintaining codebase stability.