doc-ears

EARS (Easy Approach to Requirements Syntax) formalizes requirements by structuring them as event-driven, state-driven, or ubiquitous statements using the WHEN-THE-SHALL-WITHIN pattern. This syntax clarifies system behavior: WHEN an event occurs, THE system SHALL respond with a specific action WITHIN a defined timeframe, creating precise, testable acceptance criteria and traceability links to BRD and PRD artifacts.

Creating EARS Layer 3 requirements documents requires existing upstream artifacts—BRD (Business Requirements Document) and PRD (Product Requirements Document)—with no placeholders. The Skill enforces template binding, schema validation, and creation rules, so source documents must be complete and properly formatted to translate into formal behavioral statements.

Yes. EARS Layer 3 requirements fit directly into SDD (Systems Design Document) workflows as formal acceptance criteria. The Skill produces downstream artifacts—BDD (Behavior-Driven Development), ADR (Architecture Decision Records), and SYS (system specifications)—while enforcing traceability and validation rules, ensuring requirements remain linked across the specification lifecycle.

EARS imposes formal syntax structure—WHEN-THE-SHALL-WITHIN templates—that eliminates ambiguity and makes requirements machine-validatable against schemas and rules. Informal writing lacks this rigor, making traceability, automated validation, and downstream artifact generation difficult. EARS ensures every requirement is testable and traceable to source artifacts.

Understanding EARS syntax—the WHEN-THE-SHALL-WITHIN pattern and event/state/ubiquitous categories—is essential; the Skill automates template binding and schema validation but requires you to structure requirements correctly. Familiarity with requirements traceability and acceptance criteria helps, though the syntax itself is designed for clarity and reduces learning overhead.

The Skill requires upstream artifacts with no placeholders and enforces validation rules that reject incomplete or malformed source documents. Placeholders will cause schema validation failures, preventing Layer 3 document creation. Ensure all BRD and PRD sections are finalized before translating them into EARS Layer 3 requirements.