ears-documenter

Convert ToT decision records into EARS-based requirements with five patterns.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This EARS Documenter Skill converts ToT decision records into clear, testable requirements by mapping interpretations to the 5 EARS patterns and providing structured templates for traceability and validation.

Core Features & Use Cases

  • EARS mapping and classification: Automatically categorize decisions into Ubiquitous, Event-Driven, Unwanted, State-Driven, and Optional patterns.
  • Template-driven output: Generate ready-to-review requirement statements with IDs, references, and concise acceptance criteria.
  • Quality & traceability guidance: Provide validation checks, tracking matrices, and guidance to ensure completeness and consistency across documentation workflows.

Quick Start

Feed a ToT decision record into the ears-documenter and generate an EARS-compliant requirements document suitable for design handoff and QA verification.

Frequently Asked Questions about ears-documenter

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

FAQPage Schema
What are the EARS patterns for requirements engineering?

The EARS approach structures requirements into five patterns: Ubiquitous, Event-Driven, Unwanted, State-Driven, and Optional. It categorizes decisions to generate testable requirement statements with references and concise acceptance criteria.

Does EARS documentation support validation and traceability tracking?

Yes, EARS patterns ensure traceability by applying validation checks and tracking matrices. This enforces unique IDs and structured output, maintaining completeness and consistency across design and testing workflows.

How to generate EARS-compliant requirements for design handoff?

You generate EARS-compliant requirements for design handoff by processing decision records through template-driven classification. This produces ready-to-review statements with unique IDs and acceptance criteria suitable for QA verification.

What is the best way to structure requirements for QA verification?

The best way to structure requirements for QA verification is using template-driven EARS patterns. This provides structured output with unique IDs, references, and concise acceptance criteria to ensure testable mappings from decisions.