AgentSkillsCN

musubix-ears-validation

EARS 格式需求的验证与编写指南，适用于需求描述与语法校验。

SKILL.md
--- frontmatter
name: musubix-ears-validation
description: EARS形式要件の検証・作成ガイド。要件記述・構文検証に使用。
license: MIT

EARS Validation Skill

EARS (Easy Approach to Requirements Syntax) で要件を形式化・検証。

EARS Patterns

パターン構文用途
UbiquitousTHE [system] SHALL [requirement]常に満たす要件
Event-drivenWHEN [event], THE [system] SHALL [response]イベント発生時
State-drivenWHILE [state], THE [system] SHALL [behavior]特定状態中
UnwantedTHE [system] SHALL NOT [behavior]禁止事項
OptionalIF [cond], THEN THE [system] SHALL [response]条件付き

WHEN → DO

WHENDO
自然言語の要件EARS形式に変換
要件レビュー6項目チェックリスト実施
要件文書作成テンプレートに従って記述

Validation Checklist

  • • Pattern Compliance: 5パターンのいずれかに準拠
  • • System Name: システム名が明確
  • • SHALL Keyword: 必須要件に「SHALL」使用
  • • Measurable: テスト可能・測定可能
  • • Atomic: 単一の要件を記述
  • • No Ambiguity: 曖昧な表現がない

Conversion Examples

自然言語EARS形式
ユーザーがログインできるTHE AuthModule SHALL authenticate users with valid credentials.
パスワードが間違っている時エラー表示WHEN invalid credentials are provided, THE AuthModule SHALL display an error.
SQLインジェクションを許可しないTHE InputValidator SHALL NOT accept SQL injection patterns.

Priority Levels

優先度説明用途
P0必須リリースブロッカー
P1重要可能な限り実装
P2任意時間があれば

CLI

bash
npx musubix requirements validate <file>  # EARS検証
npx musubix requirements analyze <file>   # 自然言語→EARS変換
npx musubix requirements map <file>       # オントロジーマッピング

出力例

code
┌─────────────────────────────────────────┐
│ EARS Validation Result                  │
├─────────────────────────────────────────┤
│ Requirements: 5 validated               │
│ ✅ Ubiquitous:   2 passed               │
│ ✅ Event-driven: 2 passed               │
│ ✅ Unwanted:     1 passed               │
│ Issues: 0                               │
└─────────────────────────────────────────┘