doc-ears

Formalize Layer-3 EARS requirements with WHEN-THE-SHALL-WITHIN syntax and traceability.

1|Updated Feb 9, 2026
One-click install
npx skills add https://github.com/blesstosam/trpc-fastify-starter --skill doc-ears-blesstosam
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-ears
Source: https://github.com/blesstosam/trpc-fastify-starter/tree/main/.agents/skills/doc-ears
Command: npx skills add https://github.com/blesstosam/trpc-fastify-starter --skill doc-ears-blesstosam

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Many product teams struggle with ambiguous requirements that hinder testing and traceability. This skill provides a standardized approach to create Layer-3 EARS documents that formally specify behavior using WHEN-THE-SHALL-WITHIN syntax, enabling precise verification and downstream artifact generation.

Core Features & Use Cases

  • Standardized structure for EARS Layer-3 documents, including Event-Driven, State-Driven, Unwanted Behavior, and Ubiquitous requirements.
  • Traceability support to upstream BRD/PRD artifacts and downstream BDD/ADR/SYS artifacts, with enforced metadata and thresholds.
  • Validation-ready templates that guide document control, syntax, and quality attributes, reducing miscommunication and rework.

Quick Start

Create a formal EARS Layer-3 document following the provided template and validation rules.

Frequently Asked Questions about doc-ears

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

FAQPage Schema
What is an EARS requirement and when do I need formal syntax for documentation?

An EARS requirement uses WHEN-THE-SHALL-WITHIN syntax to formally specify behavior, enabling precise testing. You need this format to resolve product ambiguity, ensure traceability, and generate downstream artifacts like BDD or ADR documents.

How do I write Layer-3 EARS requirements for state-driven and event-driven behavior?

To write Layer-3 EARS requirements, follow standardized templates for event-driven, state-driven, unwanted behavior, and ubiquitous patterns. This ensures your behavior specifications are testable and include strict traceability from upstream PRD artifacts.

How can I ensure traceability from BRD and PRD documents to downstream artifacts?

You can ensure traceability by using formal EARS Layer-3 documents with enforced frontmatter metadata and validation thresholds. This maintains strict links from upstream BRD/PRD sources to downstream BDD/ADR/SYS artifacts.

Does this EARS template approach support validation workflows for requirements?

Yes, the EARS template approach supports validation workflows by providing validation-ready templates that guide document control, syntax, and quality attributes. This reduces miscommunication and rework during artifact creation.

What is the best way to structure formal requirements to avoid ambiguous testing?

The best way to avoid ambiguous testing is adopting the EARS syntax with a standardized structure. This formalizes Layer-3 requirements into precise behavior specifications, satisfying frontmatter metadata and template conformance.

When should I not use EARS syntax for my software requirements?

You should not use EARS syntax if your project lacks upstream BRD/PRD artifacts or does not require strict behavior traceability. EARS is designed for formal Layer-3 specifications needing precise verification and downstream artifact generation.