EARS Notation

Included with Lifetime

$97 forever

This skill should be used when the user asks about "EARS syntax", "EARS notation", "acceptance criteria format", "SHALL patterns", "formal requirements", "WHEN THE SHALL", or needs guidance on writing testable requirements using EARS (Easy Approach to Requirements Syntax).

Writing & Docs

What this skill does


# EARS Notation for Requirements Engineering

EARS (Easy Approach to Requirements Syntax) is a formal notation for writing unambiguous, testable acceptance criteria.

## Core Principle

Every acceptance criterion follows a strict pattern with uppercase keywords. The keyword **SHALL** is mandatory - never use "should", "must", "will", "can", or "may".

## The Six EARS Patterns

### 1. Ubiquitous (Always True)
```
THE [System] SHALL [behavior]
```
Use for requirements that are always active, with no preconditions.

**Example:** THE System SHALL encrypt all passwords using bcrypt

### 2. Event-Driven (Triggered by Action)
```
WHEN [event] THE [System] SHALL [response]
```
Use when a specific trigger causes behavior.

**Example:** WHEN a user submits the login form THE System SHALL validate credentials

### 3. State-Driven (Ongoing Condition)
```
WHILE [state] THE [System] SHALL [behavior]
```
Use for behavior that continues as long as a condition is true.

**Example:** WHILE the user is authenticated THE System SHALL display the dashboard

### 4. Optional Feature
```
WHERE [feature is present] THE [System] SHALL [behavior]
```
Use for behavior dependent on a feature flag or configuration.

**Example:** WHERE two-factor authentication is enabled THE System SHALL require a verification code

### 5. Error Handling / Unwanted Behavior
```
IF [condition] THEN THE [System] SHALL [response]
```
Use for error cases, edge cases, and exception handling.

**Example:** IF the password is incorrect THEN THE System SHALL display an error message

### 6. Complex (Combined Conditions)
```
WHILE [state] WHEN [event] THE [System] SHALL [response]
```
Use when both a state and an event trigger behavior.

**Example:** WHILE the cart is not empty WHEN the user clicks checkout THE System SHALL navigate to payment

## Strict Rules

1. **Keywords MUST be UPPERCASE**: WHEN, THE, SHALL, IF, THEN, WHILE, WHERE
2. **Always use "THE [System]"** - never lowercase "the system"
3. **Only use SHALL** - reject "should", "must", "will", "can", "may"
4. **Be specific** - avoid vague terms like "appropriate", "quickly", "properly"
5. **Make it testable** - each criterion should be verifiable

## Pattern Selection Guide

| Scenario | Pattern | Keywords |
|----------|---------|----------|
| Always happens | Ubiquitous | THE...SHALL |
| User action triggers | Event-Driven | WHEN...THE...SHALL |
| During a state | State-Driven | WHILE...THE...SHALL |
| Feature-dependent | Optional | WHERE...THE...SHALL |
| Error/edge case | Error Handling | IF...THEN THE...SHALL |
| State + action | Complex | WHILE...WHEN...THE...SHALL |

## Common Mistakes

| Wrong | Right |
|-------|-------|
| "The system should..." | "THE System SHALL..." |
| "When clicking..." | "WHEN the user clicks... THE System SHALL..." |
| "Must validate..." | "THE System SHALL validate..." |
| "Handle errors appropriately" | "IF validation fails THEN THE System SHALL display..." |

## Additional Resources

For detailed patterns and examples:
- **`references/patterns.md`** - Comprehensive pattern documentation with edge cases
- **`examples/good-requirements.md`** - Complete example requirements document

## Validation

To validate EARS syntax, use the ears-validator script:
```bash
node scripts/ears-validator.js .specs/<feature>/requirements.md
```

Files: 3

Size: 13.2 KB

Complexity: 33/100

Category: Writing & Docs

Source: https://github.com/ibutters/claudecodeplugins/tree/main/plugins/spec-driven-workflow/skills/ears-notation

Related in Writing & Docs

jax-development

Included

Use this skill when the user is writing, debugging, profiling, refactoring, reviewing, benchmarking, parallelising, exporting, or explaining JAX code, or when they mention JAX, jax.numpy, jit, grad, value_and_grad, vmap, scan, lax, random keys, pytrees, jax.Array, sharding, Mesh, PartitionSpec, NamedSharding, pmap, shard_map, Pallas, XLA, StableHLO, checkify, profiler, or the JAX repo. It helps turn NumPy or PyTorch-style code into pure functional JAX, fix tracer/control-flow/shape/PRNG bugs, remove recompiles and host-device syncs, choose transforms and sharding strategies, inspect jaxpr/lowering/IR, and benchmark compiled code correctly.

Writing & Docsscripts

nature-article-writer

Included

Drafts, rewrites, diagnostically critiques, and style-calibrates primary research manuscripts for Nature and Nature Portfolio journals. Use when the user wants a Nature-style title, summary paragraph or abstract, introduction, results, discussion, methods, figure legends, presubmission enquiry, cover letter, reviewer response, or when a scientific draft sounds generic, jargon-heavy, structurally weak, or AI-ish and needs precise, broad-reader-friendly prose without inventing data, analyses, or references. Best for primary research articles and letters rather than reviews or press releases unless explicitly adapting one.

Writing & Docsscripts

deckrd

Included

Document-driven framework that derives requirements, specifications, implementation plans, and executable tasks from goals through structured AI dialogue. Use when user says "write requirements", "create spec", "plan implementation", "derive tasks", "structure this feature", "break down into tasks", or "document this module". Also use for reverse engineering existing code into docs (/deckrd rev). Do NOT use for direct code writing — use /deckrd-coder after tasks are generated. Do NOT use when the user only wants to run or fix existing code without planning.

Writing & Docsscripts

clinical-decision-support

Included

Generate professional clinical decision support (CDS) documents for pharmaceutical and clinical research settings, including patient cohort analyses (biomarker-stratified with outcomes) and treatment recommendation reports (evidence-based guidelines with decision algorithms). Supports GRADE evidence grading, statistical analysis (hazard ratios, survival curves, waterfall plots), biomarker integration, and regulatory compliance. Outputs publication-ready LaTeX/PDF format optimized for drug development, clinical research, and evidence synthesis.

Writing & Docsscripts

handling-sf-data

Included

Salesforce data operations with 130-point scoring. Use this skill to create, update, delete, bulk import/export, generate test data, and clean up org records using sf CLI and anonymous Apex. TRIGGER when: user creates test data, performs bulk import/export, uses sf data CLI commands, needs data factory patterns for Apex tests, or needs to seed/clean records in a Salesforce org. DO NOT TRIGGER when: SOQL query writing only (use querying-soql), Apex test execution (use running-apex-tests), or metadata deployment (use deploying-metadata).

Writing & Docsscripts

accelint-ac-to-playwright

Included

Convert and validate acceptance criteria for Playwright test automation. Use when user asks to (1) review/evaluate/check if AC are ready for automation, (2) assess if AC can be converted as-is, (3) validate AC quality for Playwright, (4) turn AC into tests, (5) generate tests from acceptance criteria, (6) convert .md bullets or .feature Gherkin files to Playwright specs, (7) create test automation from requirements. Handles both bullet-style markdown and Gherkin syntax with JSON test plan generation and validation.

Writing & Docsscripts