Yaoyorozu System Core

Yaoyorozu System Core は、REQ、UI契約、階層化テスト、証跡、判定をつなぐ再利用可能なフレームワーク面です。

利用者プロジェクトには、アプリ側のREQと実装だけを育ててもらいます。このモジュールは、そのREQが満たされたかを確認するためのコマンド、契約、文書だけを提供します。

bin/mihashira
tools/ 配下の公開検証・同期ツール
docs/examples/ 配下のJSONスキーマと例
docs/ 配下のフレームワーク文書と公開運用チェックリスト

Install

composer require --dev yaoyorozu-system/core

アプリ側の契約ディレクトリは .yaoyorozu です。これはフレームワークのデータ配置で使う正規のオンディスク名です。

Composer で取り込んだ利用者プロジェクトでは、vendor/bin/yaorozu を入口にします。

vendor/bin/yaorozu guide --ai
vendor/bin/yaorozu verify-req REQ-APP-001
vendor/bin/yaorozu test-layers L6
vendor/bin/yaorozu mihashira REQ-APP-001
vendor/bin/yaorozu list-reqs

AI に共通仕様を読ませる場合は、vendor/bin/yaorozu guide --ai と .ai/README.md を入口にします。利用者プロジェクト固有のREQは docs/req/ と .yaoyorozu/req/ を読みます。

はじめに

利用者プロジェクトで最初に見る入口は、次の3つです。

やりたいこと	入口
1件のREQを日常確認する	`bin/ci-l1 <REQ>`
UI契約だけを確認する	`tools/verify-req.* <REQ>`
公開証跡として判定を残す	`bin/mihashira <REQ>`
Composer 経由で使う	`vendor/bin/yaorozu <command>`

bin/ci-l1 は日常確認のまとめ入口です。tools/verify-req.* は .yaoyorozu/req/<REQ>/ui_contract/pages.json とテンプレートの対応だけを軽く確認します。bin/mihashira は .yaoyorozu/req/<REQ>/evidence/latest/ を更新するため、採用する判定証跡を残すときに使います。

これらのコマンドは、利用者プロジェクト直下から実行します。

利用者が管理するもの

利用者プロジェクト側で育てるものは、主に次のファイル群です。

docs/req/: REQ文書の正本。
.yaoyorozu/req/<REQ>/ui_contract/pages.json: REQごとのUI契約。
src/、templates/、tests/: アプリ実装と検証。
.yaoyorozu/req/<REQ>/evidence/latest/: 採用済みの最新判定証跡。