plan-ears

Generate EARS specifications from feature descriptions and save them as .ears.md files.

1|Updated Nov 14, 2024
One-click install
npx skills add https://github.com/SangIlMo/.dotfiles --skill plan-ears
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: plan-ears
Source: https://github.com/SangIlMo/.dotfiles/tree/main/.claude/skills/plan-ears
Command: npx skills add https://github.com/SangIlMo/.dotfiles --skill plan-ears

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps engineers convert informal feature descriptions into formal EARS specifications and organizes them for later review by saving them as pending work.

Core Features & Use Cases

  • Analyze a user-provided feature description and survey the codebase for context to tailor requirements
  • Generate an EARS-formatted specification document that follows the template
  • Prepare the project-specific specs directory at ~/.claude/specs/$PROJECT/{pending,doing,done} with a timestamp-based SPEC-ID
  • Save the generated spec to the pending folder as a .ears.md file

Quick Start

Provide a feature description to generate an EARS specification and store it in the pending folder.

Frequently Asked Questions about plan-ears

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

FAQPage Schema
How do I convert a feature description into an EARS specification?

To convert a feature description into an EARS specification, provide the feature text to the skill. It analyzes the project codebase for context and generates a tailored EARS-formatted requirements document automatically.

What is the EARS format for software requirements?

The EARS format is a structured method for writing software requirements using specific syntax to formalize conditions and responses. This skill applies it to parse informal feature descriptions into clear, unambiguous specification documents.

How do I automate project management for pending requirement specs?

Automate project management for pending requirement specs by generating EARS documents directly into a structured directory. The skill creates timestamped SPEC-IDs and saves files into pending, doing, and done folders.

Can I generate EARS specs without manually setting up a project directory?

Yes, you can generate EARS specs without manual directory setup. The skill automatically prepares the ~/.claude/specs/$PROJECT/{pending,doing,done} folder structure and saves the generated .ears.md file using a timestamp-based SPEC-ID.

Does generating EARS specifications require external dependencies?

Generating EARS specifications with this skill requires no external dependencies. It operates independently to analyze your codebase, create the spec ID, and manage the file output within the local project environment.

What is the best way to organize requirement specifications for later review?

The best way to organize requirement specifications for review is using a pending, doing, and done directory workflow. This skill enforces that structure by saving generated EARS files with timestamped IDs in the pending folder.