yodogawa 2.1.3 → 2.2.0

package/templates/project/03-domain/02-ubiquitous-language.md

@@ -1,153 +1,32 @@
-# ユビキタス言語一覧
-
-<!--
-何を書くか: プロジェクト全体で共有される共通言語の定義集
-
-目的:
-  - 開発者とドメインエキスパート間の共通理解を構築
-  - 用語の曖昧さを排除し、コミュニケーションの齟齬を防ぐ
-  - コード、ドキュメント、会話で一貫した用語を使用
-  - 新しいチームメンバーのオンボーディングを支援
-
-ユビキタス言語とは:
-  - Domain-Driven Designの中核概念
-  - ビジネス用語と技術用語の橋渡し
-  - すべてのコミュニケーション（コード、会話、ドキュメント）で使用
-  - Bounded Contextごとに定義される（同じ用語でも異なるContextでは異なる意味を持つ場合がある）
-
-記載のポイント:
-  - ドメインエキスパートが使う言葉を優先
-  - 技術用語ではなく、ビジネス用語で記述
-  - クラス名、メソッド名、変数名にも反映
-  - 曖昧な用語は禁止用語として明記
-
-Living Document（生きたドキュメント）:
-  - ドメイン理解が深まるにつれて継続的に更新
-  - 新しい用語の追加、既存用語の洗練
-  - Git管理で変更履歴を追跡
-  - Wikiやconfluenceなど、チーム全員がアクセス可能な場所に配置
-
-更新頻度:
-  - ドメインモデリング時に初版作成
-  - Event Stormingやレビュー時に追加・修正
-  - 用語の混乱や不一致が見つかった時に即座に更新
--->
-
----
-
-## [Bounded Context名]: 用語定義
-
-<!--
-各Bounded Contextごとにセクションを分けて用語を定義
-同じ用語でも異なるContextでは異なる意味を持つ可能性があるため
-
-【Bounded Context共通】セクションを作成して、プロジェクト全体で共通の用語を記述することも推奨
-
-記載例:
-- [Bounded Context共通]
-- [ユーザー管理]
-- [注文処理]
-- [在庫管理]
--->
-
-<!--
-テーブル構成:
-
-【用語】
-  - ドメインエキスパートが使用する正式な用語
-  - 単数形・複数形を明確に（例: Order, Orders）
-  - 日本語の場合は表記ゆれに注意（例: 「ユーザ」か「ユーザー」か統一）
-  - 略語は避け、フルスペルで記載（略語を使う場合は別途定義）
-
-【定義】
-  - 1-3文で明確に定義
-  - そのBounded Context内での意味を正確に記述
-  - 曖昧さを排除した具体的な説明
-  - ドメインエキスパートと合意した定義
-  - 技術的な実装詳細ではなく、ビジネス的な意味を記述
-
-【使用例】
-  - コード例: クラス名、メソッド名、変数名での使用
-  - ドキュメント例: 仕様書やユーザーストーリーでの使用
-  - 会話例: チーム内での会話での使用
-  - 複数の例を記載する場合は改行して箇条書き
-
-記載のベストプラクティス:
-  - ドメインエキスパートとペアで作成
-  - コードに現れる用語は必ず定義
-  - 類似用語の違いを明確にする（例: Customer vs User）
-  - 動詞も含める（例: Order（注文する）, Ship（出荷する））
-  - 状態遷移に関わる用語も定義（例: Pending, Confirmed, Shipped）
--->
-
-| 用語 | 定義 | 使用例 |
-|------|------|--------|
-| <!-- 例: Order --> | <!-- 例: 顧客が商品を購入する意思を示した取引単位。確定後は変更不可 --> | <!-- 例: `class Order`, `createOrder()`, ユーザーストーリー「注文を確定する」 --> |
-| <!-- 例: Customer --> | <!-- 例: 商品を購入する個人または組織。アカウント登録の有無は問わない --> | <!-- 例: `class Customer`, `customer.placeOrder()` --> |
-
----
-
-## 禁止用語
-
-<!--
-使用を避けるべき曖昧な用語や誤解を招く用語
-
-目的:
-  - 用語の混乱を防ぐ
-  - 過去に問題を引き起こした用語を記録
-  - 新しいチームメンバーへの注意喚起
-  - コードレビュー時のチェックリスト
-
-記載すべき用語:
-  - 複数の意味を持つ曖昧な用語
-  - 技術用語とビジネス用語が混在する用語
-  - 過去に混乱を招いた用語
-  - 異なるBounded Contextで異なる意味を持つ用語（誤用を防ぐため）
-  - 略語で意味が不明瞭なもの
-
-記載のポイント:
-  - なぜ禁止なのか明確に説明
-  - 代替となる明確な用語を提示
-  - 必要に応じて複数の推奨用語を記載（文脈によって使い分け）
--->
-
-| 禁止用語 | 理由 | 推奨用語 |
-|----------|------|----------|
-| <!-- 例: Data --> | <!-- 例: 曖昧すぎて何を指すか不明。Order Data? Customer Data? --> | <!-- 例: Order, Customer, OrderDetails（具体的に指定） --> |
-| <!-- 例: Process --> | <!-- 例: 動詞なのか名詞なのか、どの処理なのか不明 --> | <!-- 例: PlaceOrder, ShipOrder, ConfirmPayment（具体的なアクション） --> |
-| <!-- 例: User --> | <!-- 例: このContextではCustomerとAdminを区別する必要がある --> | <!-- 例: Customer（顧客）, Admin（管理者） --> |
-
----
-
-## メモ
-
-<!--
-全体に関する補足情報
-
-記載すべき内容:
-  - 命名規則: クラス名、メソッド名、変数名の命名パターン
-  - 表記規則: 単数形/複数形、大文字/小文字の使い分け
-  - 言語の選択: 英語/日本語の使い分けルール
-  - 更新履歴: 重要な用語変更の記録（GitコミットログへのリンクでもOK）
-  - 参考資料: ドメインに関する参考書籍、業界標準、用語集へのリンク
-  - レビューサイクル: 定期的な用語見直しのスケジュール
-  - 承認プロセス: 新しい用語を追加する際の承認フロー
-
-コード実装との整合性:
-  - コードレビュー時にこのドキュメントを参照
-  - CI/CDでlintルールとして用語チェックを自動化（可能であれば）
-  - IDEのスニペットやテンプレートに用語を反映
-
-コミュニケーション:
-  - ドメインエキスパートとの会話で必ずこの用語を使用
-  - ドキュメントや仕様書でもこの用語を使用
-  - 新しいチームメンバーにはオンボーディング時にこのドキュメントを共有
-  - 用語の理解度を確認するための質問リストを作成することも有効
-
-ベストプラクティス:
-  - 用語の変更は慎重に（コード全体への影響が大きい）
-  - 用語変更時はリファクタリングタスクを作成
-  - 用語の進化を歓迎（ドメイン理解が深まる証）
-  - 図やダイアグラムを併用して理解を深める
-  - Event Stormingの成果物と連携させる
--->
+# ユビキタス言語一覧
+
+<!--
+何のドキュメントか: プロジェクト全体で共有する共通言語の定義集（DDD）。ビジネス用語と技術用語の橋渡し。
+使い方:
+  - ドメインエキスパートが使う言葉を優先し、ビジネス用語で記述する。クラス名・メソッド名にも反映する。
+  - Bounded Context ごとに用語を定義する（同じ語でも Context が違えば意味が異なる場合がある）。
+  - 記載のポイント・禁止用語の選び方・Living Document としての運用は
+    skills/a-004-define-domain-model/reference/ubiquitous-language-guide.md を参照。
+-->
+
+## [Bounded Context名]: 用語定義
+
+<!-- Context ごとに節を分ける。全体共通の用語は [Bounded Context共通] 節にまとめる。 -->
+
+| 用語 | 定義 | 使用例 |
+|------|------|--------|
+| <!-- 例: Order --> | <!-- 例: 顧客が商品を購入する意思を示した取引単位。確定後は変更不可 --> | <!-- 例: `class Order`, `createOrder()` --> |
+| <!-- 例: Customer --> | <!-- 例: 商品を購入する個人または組織。アカウント登録の有無は問わない --> | <!-- 例: `class Customer`, `customer.placeOrder()` --> |
+
+## 禁止用語
+
+<!-- 曖昧・誤解を招く用語と、その理由・推奨代替語を記録する。 -->
+
+| 禁止用語 | 理由 | 推奨用語 |
+|----------|------|----------|
+| <!-- 例: Data --> | <!-- 例: 何を指すか不明（Order Data? Customer Data?） --> | <!-- 例: Order, Customer, OrderDetails --> |
+| <!-- 例: User --> | <!-- 例: この Context では Customer と Admin を区別する必要がある --> | <!-- 例: Customer（顧客）, Admin（管理者） --> |
+
+## メモ
+
+<!-- 命名規則 / 表記規則（単複・大文字小文字）/ 英日の使い分け / 参考資料など。運用詳細は ubiquitous-language-guide.md 参照。 -->