@k2works/claude-code-booster 6.3.1 → 6.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/assets/.claude/skills/creating-development-strategy/SKILL.md +64 -4
- package/lib/assets/.claude/skills/developing-backend/SKILL.md +39 -1
- package/lib/assets/.claude/skills/developing-frontend/SKILL.md +39 -1
- package/lib/assets/.claude/skills/orchestrating-development/SKILL.md +37 -1
- package/lib/assets/docs/article/index.md +1 -0
- package/lib/assets/docs/index.md +37 -37
- package/lib/assets/docs/log.md +28 -25
- package/lib/assets/docs/reference/BDD/345/260/216/345/205/245/343/202/254/343/202/244/343/203/211.md +766 -0
- package/lib/assets/docs/reference/LivingDocumentation/345/260/216/345/205/245/343/202/254/343/202/244/343/203/211.md +400 -0
- package/lib/assets/docs/reference/index.md +66 -61
- package/lib/assets/docs/reference//343/202/242/343/203/216/343/203/206/343/203/274/343/202/267/343/203/247/343/203/263/345/260/216/345/205/245/343/202/254/343/202/244/343/203/211.md +268 -0
- package/lib/assets/docs/reference//343/202/254/343/202/244/343/203/211/343/203/204/343/202/242/343/203/274/343/203/273/343/202/265/343/202/244/343/203/210/343/202/267/343/203/274/343/202/244/343/203/263/343/202/260/345/260/216/345/205/245/343/202/254/343/202/244/343/203/211.md +192 -0
- package/lib/assets/docs/reference//343/203/200/343/202/244/343/203/212/343/203/237/343/203/203/343/202/257/343/202/255/343/203/245/343/203/254/343/203/274/343/202/267/343/203/247/343/203/263/345/260/216/345/205/245/343/202/254/343/202/244/343/203/211.md +191 -0
- package/lib/assets/mkdocs.yml +13 -0
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: creating-development-strategy
|
|
3
|
-
description: 開発戦略ドキュメント(docs/development/development_strategy.md)の作成・更新を支援。イテレーション計画(planning-releases でのイテレーション作成)を前提に、イテレーション群を序盤・中盤・終盤の局面に分け、各局面で採用する TDD アプローチ(アウトサイドイン / インサイドアウト)、ウォーキングスケルトンの基盤化、イテレーションのデモ項目を受け入れ基準(E2E /
|
|
3
|
+
description: 開発戦略ドキュメント(docs/development/development_strategy.md)の作成・更新を支援。イテレーション計画(planning-releases でのイテレーション作成)を前提に、イテレーション群を序盤・中盤・終盤の局面に分け、各局面で採用する TDD アプローチ(アウトサイドイン / インサイドアウト)、ウォーキングスケルトンの基盤化、イテレーションのデモ項目を受け入れ基準(E2E / 受け入れテスト)とする方針、設計ドキュメント整合方針、Living Documentation によるドキュメントとコードの同期方針を定義する。「開発戦略を作りたい」「開発の進め方を局面ごとに決めたい」「アウトサイドインとインサイドアウトをどう使い分けるか整理したい」「ウォーキングスケルトンの方針を文書化したい」「デモ項目を受け入れ基準にする方針を決めたい」「デモ項目を BDD のシナリオにする方針を決めたい」「アウトサイドインで BDD を使うか決めたい」「イテレーションと設計ドキュメントの整合方針を決めたい」「Living Documentation を開発に組み込みたい」「ドキュメントをコードと同期させる方針を決めたい」「用語集や設計図をコードから生成する方針を決めたい」といった場面で必ず発動する。リリース計画・イテレーション計画を作成した後、開発フェーズに着手する前に開発戦略を定めておくことで、局面が変わってもアーキテクチャと品質の一貫性を保った開発を進められる。特定の言語・フレームワークに依存しない汎用スキルであり、参照元・コマンド・テスト構成は対象プロジェクトの実構成に合わせて解決する。
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# 開発戦略作成
|
|
@@ -19,7 +19,9 @@ description: 開発戦略ドキュメント(docs/development/development_strat
|
|
|
19
19
|
- **イテレーション × ユーザーストーリーのマクロ配分**: `docs/development/release_plan.md`(あれば SSoT。無ければ計画済みイテレーションから局面を導く)
|
|
20
20
|
- **TDD アプローチ・手順・品質基準**: 対象プロジェクトのコーディング/テストガイド(例: `docs/reference/コーディングとテストガイド.md`)
|
|
21
21
|
- **テスト種別・受け入れ/E2E 方針**: 対象プロジェクトのテスト戦略(例: `docs/design/test_strategy.md`)
|
|
22
|
+
- **受け入れテストの記述形式(BDD / Gherkin)**: `docs/reference/BDD導入ガイド.md`(アウトサイドインの入口をシナリオで定義する場合)
|
|
22
23
|
- **画面遷移・ナビゲーション**(UI を持つ場合): UI 設計(例: `docs/design/ui_design.md`)
|
|
24
|
+
- **ドキュメントとコードの同期方針(Living Documentation)**: `docs/reference/LivingDocumentation導入ガイド.md`。個別の手法は `アノテーション導入ガイド.md`・`ダイナミックキュレーション導入ガイド.md`・`ガイドツアー・サイトシーイング導入ガイド.md`(いずれも `docs/reference/`)
|
|
23
25
|
|
|
24
26
|
## 前提: イテレーション計画
|
|
25
27
|
|
|
@@ -56,13 +58,67 @@ description: 開発戦略ドキュメント(docs/development/development_strat
|
|
|
56
58
|
- **中盤・終盤**: 各 `iteration_plan-N.md` の **デモ項目をそのままパスする受け入れ/E2E テスト** を追加し、当該 IT の受け入れ基準とする。デモ項目を「操作/リクエストの系列」に翻訳してテスト化する。
|
|
57
59
|
- **判定**: 当該 IT のデモ項目テストがすべて green であることを DoD に含める。green でなければイテレーションはクローズしない。追加したテストは以降も実行し、既存デモ項目の回帰を防ぐ。
|
|
58
60
|
|
|
61
|
+
### アウトサイドインの入口を BDD で定義する
|
|
62
|
+
|
|
63
|
+
アウトサイドインは「一番外側のテストから内へ向かう」アプローチなので、その最外殻をどう書くかで戦略の質が決まる。デモ項目を自然言語のまま人が実演するだけにせず、**BDD のシナリオ(Gherkin)として書いて実行可能にする**と、デモ項目・受け入れテスト・ドキュメントが 1 つの成果物に収束する。記法・処理系・実装手順は `docs/reference/BDD導入ガイド.md` に従う。
|
|
64
|
+
|
|
65
|
+
BDD を採用するかはプロジェクトの判断だが、採用する場合は開発戦略に次を明記する。
|
|
66
|
+
|
|
67
|
+
- **どの局面で使うか** — 序盤・終盤のアウトサイドイン局面で使う。中盤のインサイドアウト局面ではドメイン層の単体テストが主役になるため、BDD シナリオは既存分の回帰実行にとどめる
|
|
68
|
+
- **誰が書くか** — デモ項目の元になるシナリオは、実装前にスリーアミーゴ(Biz / Dev / Tester)で合意する。AI-DLC ではこの合意が Mob Elaboration に相当し、シナリオが人と AI の契約になる
|
|
69
|
+
- **記述言語** — 対象プロジェクトのユビキタス言語に合わせる。日本語で業務を語るなら `# language: ja` の日本語 Gherkin で書き、プロジェクト内で言語を混在させない
|
|
70
|
+
- **処理系と配置** — 採用する Cucumber 系処理系(Cucumber-JS / Cucumber-JVM / Reqnroll など)、フィーチャーファイルとステップ定義のディレクトリ、実行コマンドを実構成に合わせて記載する
|
|
71
|
+
- **ステップ定義の責務** — ステップ定義は薄く保ち、業務ロジックを持ち込まない。アウトサイドインでは、ステップ定義から呼ぶインターフェースが「まだ無い内側」の設計を駆動する
|
|
72
|
+
|
|
73
|
+
BDD を使う場合、アウトサイドインの各サイクルは次の順に進む。
|
|
74
|
+
|
|
75
|
+
1. デモ項目を Gherkin のシナリオに翻訳し、スリーアミーゴで合意する
|
|
76
|
+
2. シナリオを実行する。ステップ定義が無いので **Undefined** になる
|
|
77
|
+
3. ステップ定義を書き、まだ無い内側のインターフェースを呼ぶ。**Red** を確認する
|
|
78
|
+
4. 内側へ一段下りて(UI → アプリケーション → ドメイン → データ)、各層を TDD で実装し **Green** にする
|
|
79
|
+
5. リファクタリングする。シナリオは業務語彙のまま変えない
|
|
80
|
+
|
|
81
|
+
BDD を採用しない場合でも、デモ項目を「操作/リクエストの系列」へ翻訳して受け入れテスト化する方針そのものは変わらない。開発戦略には、採用・不採用のどちらであるかとその理由を書く。
|
|
82
|
+
|
|
83
|
+
## ドキュメントをコードと同期させる(Living Documentation・局面横断)
|
|
84
|
+
|
|
85
|
+
局面が変わるたびに設計の理解がずれる最大の原因は、手書きのドキュメントがコードより遅れることである。Living Documentation は「知識の大半はすでにコード・テスト・コミット履歴にある。それを取り出し、足りない意図と根拠だけを補い、システムと同じ速さで更新する」という考え方で、局面移行時の一貫性維持を支える。原則と手法は `docs/reference/LivingDocumentation導入ガイド.md` に従う。
|
|
86
|
+
|
|
87
|
+
採用するかはプロジェクトの判断だが、開発戦略には採用・不採用とその理由を書く。採用する場合は、全イテレーションに一度に広げず、**これから書くコードから適用する**(既存コードへの一括適用はしない)。
|
|
88
|
+
|
|
89
|
+
### 局面ごとの重点
|
|
90
|
+
|
|
91
|
+
局面のアプローチと、そこで生まれる知識の種類に合わせて重点を変える。
|
|
92
|
+
|
|
93
|
+
| 局面 | 生まれる主な知識 | Living Documentation の重点 | 参照ガイド |
|
|
94
|
+
| :--- | :--- | :--- | :--- |
|
|
95
|
+
| 序盤(アウトサイドイン) | アーキテクチャ・レイヤー・外部アクター | アノテーション語彙(ステレオタイプ・レイヤー)を決める。レイヤー依存をアーキテクチャテストで検証し、アーキテクチャ図・コンテキスト図をコードから生成する仕組みをスケルトンに含める | アノテーション導入ガイド |
|
|
96
|
+
| 中盤(インサイドアウト) | ドメインの概念・集約・業務ルール | コア概念のハイライトと、ドメインモデルから生成する用語集(Living Glossary)でユビキタス言語をコードに一本化する。判断の根拠は ADR に残す。模範となる集約を示す | ダイナミックキュレーション導入ガイド |
|
|
97
|
+
| 終盤(アウトサイドイン) | 業務シナリオ・処理の流れ | デモ項目の処理チェーンをガイドツアーとして案内し、見どころをサイトシーイング・マップにまとめる。BDD を採用していればタグでシナリオダイジェストを作る | ガイドツアー・サイトシーイング導入ガイド |
|
|
98
|
+
|
|
99
|
+
### 開発戦略に明記すること
|
|
100
|
+
|
|
101
|
+
- **何をコードに持たせ、何を文書に残すか** — コードで表せる知識(構造・用語・依存関係)は生成し、`docs/design/` に手で複製しない。`docs/design/` にはコードから読み取れない意図・判断・却下した代替案を残す。「イテレーションごとの設計ドキュメント整合」の方針と矛盾しないよう、生成物と手書きの境界を書く
|
|
102
|
+
- **重複させた知識の検証方法** — やむを得ず重複する知識(公開 API の契約、シナリオとコードなど)は、不一致を検出するテストで守る。どのテストが整合性検証を担うかを書く
|
|
103
|
+
- **アノテーション語彙** — 採用する語彙(例: `ValueObject`・`CoreConcept`・`GuidedTour`)と置き場所。言語に合わせてアノテーション・属性・デコレータ・命名規約のいずれで表すかを決め、本質的な知識だけを付ける
|
|
104
|
+
- **生成と公開の自動化** — 用語集・図・ツアーの生成を、ビルドまたは CI のどの段階で実行し、どこに公開するか(対象プロジェクトの実構成に合わせる)。手作業で更新する一覧は作らない
|
|
105
|
+
- **根拠の記録先** — 設計判断は ADR(`creating-adr`)、変更ごとの意図はコミットメッセージ(`git-commit`)に残す
|
|
106
|
+
|
|
107
|
+
### 完了条件への組み込み
|
|
108
|
+
|
|
109
|
+
採用する場合、各イテレーションの完了条件に次を加える。
|
|
110
|
+
|
|
111
|
+
- 生成するドキュメント(用語集・図・ツアーなど)の生成がビルドまたは CI で成功している
|
|
112
|
+
- その IT で下した設計判断が ADR に記録され、コードで表せない根拠だけが `docs/design/` に反映されている
|
|
113
|
+
- 手書きでコードの内容を複製した一覧・図が新たに増えていない
|
|
114
|
+
|
|
59
115
|
## 作成の進め方
|
|
60
116
|
|
|
61
117
|
1. **参照元を読む**: コーディング/テストガイド(アプローチのシーケンス・品質基準・コミット規約)、計画済みの各 `iteration_plan-N.md`(対象 US・デモ項目)、あれば `release_plan.md`(マクロ配分)を読み込む。
|
|
62
118
|
2. **局面を割り当てる**: 計画済みイテレーションを局面へ振り分ける。基盤・入口の IT を序盤、複雑ドメイン中核の IT を中盤、例外・仕上げの IT を終盤とする。未計画分は暫定案とする。
|
|
63
119
|
3. **共通の TDD サイクル節を書く**: Red-Green-Refactor と品質チェック(対象プロジェクトの実ビルド/テストコマンド)、テスト種別とレイヤーの対応表を、実構成を確認して記載する。
|
|
64
|
-
4. **各局面の節を書く**: 目的・対象ユーザーストーリー・ワークフロー(アウトサイドイン/インサイドアウトのシーケンスに基づく PlantUML/Mermaid)・手順・完了条件を記述する。完了条件には該当 IT のデモ項目受け入れテスト green
|
|
65
|
-
5. **横断方針を書く**:
|
|
120
|
+
4. **各局面の節を書く**: 目的・対象ユーザーストーリー・ワークフロー(アウトサイドイン/インサイドアウトのシーケンスに基づく PlantUML/Mermaid)・手順・完了条件を記述する。完了条件には該当 IT のデモ項目受け入れテスト green を含める。アウトサイドイン局面で BDD を採用する場合は、シナリオの記述言語・処理系・配置・ステップ定義の責務を明記する(`docs/reference/BDD導入ガイド.md` 参照)。
|
|
121
|
+
5. **横断方針を書く**: デモ項目を受け入れ基準とする方針、Living Documentation の採用可否と局面ごとの重点(`docs/reference/LivingDocumentation導入ガイド.md` 参照)、局面移行時の一貫性維持、アプローチが変わっても不変な規律(サイクル 3 原則・コミット単位・品質基準・アーキテクチャテスト常時グリーン)を明記する。
|
|
66
122
|
6. **インデックスを同期する**: `operating-docs --update` で `docs/development/index.md` と `mkdocs.yml` に開発戦略を追加する。
|
|
67
123
|
7. コミットは `git-commit`(ユーザー指示があるまでコミットしない)。
|
|
68
124
|
|
|
@@ -74,7 +130,8 @@ description: 開発戦略ドキュメント(docs/development/development_strat
|
|
|
74
130
|
## 概要(参照元と Single Source of Truth の明記・イテレーション計画前提)
|
|
75
131
|
## 戦略の全体像(局面 → アプローチの対応表・図)
|
|
76
132
|
## 共通の TDD サイクル(Red-Green-Refactor・テスト種別対応・品質チェック)
|
|
77
|
-
## デモ項目を受け入れ基準とする(受け入れ/E2E
|
|
133
|
+
## デモ項目を受け入れ基準とする(受け入れ/E2E 方針・BDD 採用可否)
|
|
134
|
+
## ドキュメントをコードと同期させる(Living Documentation 採用可否・局面ごとの重点・生成と公開)
|
|
78
135
|
## 序盤: アウトサイドイン(目的 / 対象 US / ワークフロー / 手順 / 完了条件)
|
|
79
136
|
## 中盤: インサイドアウト(同上。中核が単純なら省略可)
|
|
80
137
|
## 終盤: アウトサイドイン(同上)
|
|
@@ -114,6 +171,8 @@ description: 開発戦略ドキュメント(docs/development/development_strat
|
|
|
114
171
|
- 本スキルは **イテレーション計画を前提** とする。イテレーションが未計画なら先に `planning-releases` で計画する。少なくとも序盤の IT に対象 US とデモ項目が定義されていること。
|
|
115
172
|
- アプローチ選択は必ず対象プロジェクトのコーディング/テストガイドの選択フローに理由づける。「なぜこの局面でこのアプローチか」を書かないと、単なる区切り表になり戦略の価値が失われる。
|
|
116
173
|
- `ALWAYS`/`MUST` の羅列でなく、各局面の狙い(why)を説明する文体にする。局面が変わっても不変な規律(Red-Green-Refactor 3 原則・1 コミット 1 変更・品質基準・アーキテクチャテスト常時グリーン)は明記する。
|
|
174
|
+
- BDD を採用する場合、シナリオの記述形式・処理系・実装手順は `docs/reference/BDD導入ガイド.md` を正とし、本スキルでは「どの局面でどう使うか」という戦略判断だけを書く。記法の解説を開発戦略ドキュメントに複製しない。
|
|
175
|
+
- Living Documentation を採用する場合も同様に、手法の解説は `docs/reference/LivingDocumentation導入ガイド.md` と個別の導入ガイドを正とし、開発戦略には「どの局面で何を生成・記録するか」という判断だけを書く。開発戦略ドキュメント自体も、イテレーション計画や設計ドキュメントの内容を複製せず参照する。
|
|
117
176
|
- 品質チェックコマンド・テスト構成は対象プロジェクトの実構成を確認して合わせる(憶測で書かない。ビルド設定ファイル・テストディレクトリ・タスクランナー設定を実際に確認する)。
|
|
118
177
|
- 新規作成後は `docs/development/index.md` と `mkdocs.yml` を必ず同期する。ユーザーの指示があるまでコミットしない。
|
|
119
178
|
|
|
@@ -123,5 +182,6 @@ description: 開発戦略ドキュメント(docs/development/development_strat
|
|
|
123
182
|
- `orchestrating-development` — 開発フェーズ全体の TDD ワークフロー(本戦略の実行フェーズ)
|
|
124
183
|
- `validating-iteration-plan` — イテレーション計画と設計ドキュメントの整合検証
|
|
125
184
|
- `developing-backend` / `developing-frontend` — 各局面での TDD 実装
|
|
185
|
+
- `creating-adr` — 局面ごとの設計判断の根拠の記録(Living Documentation の根拠の記録先)
|
|
126
186
|
- `operating-docs` — インデックス同期(`--update`)
|
|
127
187
|
- `git-commit` — 作成後のコミット
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: developing-backend
|
|
3
|
-
description: バックエンド開発の TDD ワークフローを支援。Red-Green-Refactor サイクルとインサイドアウトアプローチで品質の高いバックエンドを実装する。「バックエンドを実装したい」「API
|
|
3
|
+
description: バックエンド開発の TDD ワークフローを支援。Red-Green-Refactor サイクルとインサイドアウトアプローチで品質の高いバックエンドを実装する。「バックエンドを実装したい」「API を作りたい」「サーバーサイドの機能を追加したい」「バックエンドのテストを書きたい」「ドメインモデルに役割や根拠を残したい」「API ドキュメントや用語集をコードから生成したい」といった場面で発動する。層ごとの知識を Living Documentation としてコードに持たせる実践も案内する。TDD で開発することで、リファクタリングの安全網を確保し、変更を楽に安全にできるコードを維持する。
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# バックエンド開発
|
|
@@ -19,6 +19,8 @@ TDD サイクルに従いバックエンドを開発する。インサイドア
|
|
|
19
19
|
| ドメインモデル | @docs/design/domain-model.md |
|
|
20
20
|
| 技術スタック | @docs/design/tech_stack.md |
|
|
21
21
|
| テスト戦略 | @docs/design/test_strategy.md |
|
|
22
|
+
| 開発戦略 | @docs/development/development_strategy.md(Living Documentation の採用可否・語彙・局面ごとの重点) |
|
|
23
|
+
| Living Documentation | @docs/reference/LivingDocumentation導入ガイド.md、@docs/reference/アノテーション導入ガイド.md |
|
|
22
24
|
|
|
23
25
|
## TDD サイクル
|
|
24
26
|
|
|
@@ -33,6 +35,35 @@ TDD サイクルに従いバックエンドを開発する。インサイドア
|
|
|
33
35
|
- **インサイドアウト**(推奨): データ層から開始し上位層へ展開する
|
|
34
36
|
- **アウトサイドイン**: API から開始しドメインロジックを段階的に実装する
|
|
35
37
|
|
|
38
|
+
## Living Documentation の実践
|
|
39
|
+
|
|
40
|
+
バックエンドの知識の大半は、スキーマ・ドメインモデル・API 定義・テストの中にある。それを設計ドキュメントに書き写すのではなく、**権威ある情報源をコードに置き、そこから生成し、足りない意図と根拠だけを補う**。採用するかどうかとアノテーションの語彙は開発戦略に従う。ここではインサイドアウトの層ごとに、何をどこに持たせるかを示す。
|
|
41
|
+
|
|
42
|
+
### 層ごとの知識の持たせ方
|
|
43
|
+
|
|
44
|
+
| 層 | 権威ある情報源 | 生成・検証するもの | 補う知識 |
|
|
45
|
+
| :--- | :--- | :--- | :--- |
|
|
46
|
+
| データ層 | マイグレーション・スキーマ定義 | ER 図・テーブル定義をスキーマから生成する。`docs/design/` のデータモデルに列定義を手で複製しない | 正規化を崩した理由などの判断は ADR に残す |
|
|
47
|
+
| ドメイン層 | エンティティ・値オブジェクト・集約のコード | ドメインのクラス名・メソッド名・列挙型から用語集(Living Glossary)を生成する | 役割(`@Entity`・`@ValueObject`・`@DomainService` など)とコア概念(`@CoreConcept`)をアノテーションで補う |
|
|
48
|
+
| API 層 | コントローラとリクエスト/レスポンスの型 | OpenAPI をコードから生成して公開する。外部に公開した契約は、変更を検出するテストで守る | 外部システムとの境界(連携先・方向)を宣言し、コンテキスト図の元にする |
|
|
49
|
+
| 層をまたぐ構造 | パッケージ構成・レイヤー宣言 | 層の依存方向をアーキテクチャテスト(ArchUnit など)で検証し、アーキテクチャ図をコードから生成する | パッケージ単位の宣言(`package-info.java` のレイヤー・境界づけられたコンテキスト)で補う |
|
|
50
|
+
|
|
51
|
+
### ドメイン層で守ること
|
|
52
|
+
|
|
53
|
+
インサイドアウトで最初に固めるドメイン層は、用語集と図の出来を左右する。
|
|
54
|
+
|
|
55
|
+
- **宣言的に書く**: クラス名・メソッド名・列挙型の定数名をドメインの用語にする。生成した用語集が読みにくければ、用語集ではなく名前を直す
|
|
56
|
+
- **本質的な知識だけを付ける**: 不変である、副作用がない、値で同一性を判定するといった、要素を消せば一緒に消える性質だけをアノテーションにする。所有者や使われ方などの外在的な知識は付けない
|
|
57
|
+
- **デフォルトを決めて例外に付ける**: 値オブジェクトを不変とする方針なら、全クラスに `@Immutable` を付けず、可変なものだけを明示する
|
|
58
|
+
- **フレームワークの注釈を流用しない**: JPA の `@Entity` などの技術的な注釈はドメインの意味を表さない。ドメインの役割は独自の語彙で表す
|
|
59
|
+
- **テストをシナリオとして読めるようにする**: テスト名は業務の言葉で書く。イベントソーシングを使う場合は「Given 過去のイベント / When コマンド / Then 新しいイベント」の形にし、コマンドは命令形、イベントは過去形で命名する
|
|
60
|
+
|
|
61
|
+
### TDD サイクルでのタイミング
|
|
62
|
+
|
|
63
|
+
- **Red**: テスト名とテストデータにドメインの用語を使う
|
|
64
|
+
- **Refactor**: 名前を用語に揃え、役割と性質のアノテーションを付ける。付ける数は最小にする
|
|
65
|
+
- **コミット**: 変更の意図を書く(`git-commit`)。代替案を比べて選んだ設計判断は ADR に残す(`creating-adr`)
|
|
66
|
+
|
|
36
67
|
## テストコマンド
|
|
37
68
|
|
|
38
69
|
```bash
|
|
@@ -55,6 +86,8 @@ cd apps/backend && ./gradlew bootRun
|
|
|
55
86
|
# OpenAPI JSON: http://localhost:8080/v3/api-docs
|
|
56
87
|
```
|
|
57
88
|
|
|
89
|
+
API ドキュメントはコードから生成されるので、別文書に API 仕様を手で書かない。エンドポイントの意図や制約など、コードに無い説明はアノテーションの説明文に書き、生成物に含める。
|
|
90
|
+
|
|
58
91
|
## 品質チェックリスト
|
|
59
92
|
|
|
60
93
|
コミット前に必ず確認する。
|
|
@@ -64,6 +97,8 @@ cd apps/backend && ./gradlew bootRun
|
|
|
64
97
|
- [ ] テストカバレッジが目標を満たしている
|
|
65
98
|
- [ ] 単一の論理的作業単位を表現
|
|
66
99
|
- [ ] コミットメッセージが変更内容を明確に説明
|
|
100
|
+
- [ ] (Living Documentation 採用時)ドメインの名前が用語に揃い、開発戦略で決めたアノテーションが付いている
|
|
101
|
+
- [ ] (Living Documentation 採用時)アーキテクチャテストと公開契約のテストがパスし、生成するドキュメントがビルドで生成できる
|
|
67
102
|
|
|
68
103
|
## 途中から再開
|
|
69
104
|
|
|
@@ -92,9 +127,12 @@ cd apps/backend && ./gradlew bootRun
|
|
|
92
127
|
- コミット前に必ず品質チェックリストを実行する
|
|
93
128
|
- 作業完了後に対象の @docs/development/iteration_plan-N.md の進捗を更新する
|
|
94
129
|
- TODO 駆動開発でタスクを細かく分割し、Rule of Three で 3 回同じコードが現れたらリファクタリングする
|
|
130
|
+
- スキーマ・クラス一覧・API 仕様など、コードから取り出せる知識を `docs/design/` に手で書き写さない。書くのはコードに無い意図と根拠だけにする
|
|
95
131
|
|
|
96
132
|
## 関連スキル
|
|
97
133
|
|
|
98
134
|
- `developing-frontend` — フロントエンド TDD 開発
|
|
99
135
|
- `orchestrating-development` — 開発フェーズ全体のワークフロー
|
|
100
136
|
- `git-commit` — Conventional Commits 準拠のコミット
|
|
137
|
+
- `creating-adr` — 設計判断の根拠の記録
|
|
138
|
+
- `creating-development-strategy` — Living Documentation の採用可否・語彙・局面ごとの重点
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: developing-frontend
|
|
3
|
-
description: フロントエンド開発の TDD ワークフローを支援。Red-Green-Refactor サイクルとアウトサイドインアプローチで品質の高い UI
|
|
3
|
+
description: フロントエンド開発の TDD ワークフローを支援。Red-Green-Refactor サイクルとアウトサイドインアプローチで品質の高い UI を実装する。「フロントエンドを実装したい」「画面を作りたい」「コンポーネントを追加したい」「フロントエンドのテストを書きたい」「画面遷移やコンポーネントの一覧をコードと同期させたい」「API の型をバックエンドと揃えたい」といった場面で発動する。画面とシナリオの知識を Living Documentation としてコードに持たせる実践も案内する。TDD で開発することで、UI の振る舞いを自動テストで保証し、安全なリファクタリングを可能にする。
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# フロントエンド開発
|
|
@@ -18,6 +18,9 @@ TDD サイクルに従いフロントエンドを開発する。アウトサイ
|
|
|
18
18
|
| UI 設計 | @docs/design/ui-design.md |
|
|
19
19
|
| 技術スタック | @docs/design/tech_stack.md |
|
|
20
20
|
| テスト戦略 | @docs/design/test_strategy.md |
|
|
21
|
+
| 開発戦略 | @docs/development/development_strategy.md(Living Documentation の採用可否・語彙・局面ごとの重点) |
|
|
22
|
+
| Living Documentation | @docs/reference/LivingDocumentation導入ガイド.md、@docs/reference/ダイナミックキュレーション導入ガイド.md |
|
|
23
|
+
| 受け入れシナリオ(BDD 採用時) | @docs/reference/BDD導入ガイド.md |
|
|
21
24
|
|
|
22
25
|
## TDD サイクル
|
|
23
26
|
|
|
@@ -32,6 +35,35 @@ TDD サイクルに従いフロントエンドを開発する。アウトサイ
|
|
|
32
35
|
- **アウトサイドイン**(推奨): UI から開始しロジックを段階的に実装する
|
|
33
36
|
- **インサイドアウト**: ユーティリティ/hooks から開始し上位層へ展開する
|
|
34
37
|
|
|
38
|
+
## Living Documentation の実践
|
|
39
|
+
|
|
40
|
+
フロントエンドの知識は、ルート定義・コンポーネント・API の型・E2E テストの中にある。画面一覧や遷移図、API の型を別文書に書き写すと、画面を 1 つ足すたびに古くなる。**権威ある情報源をコードに置き、そこから生成し、足りない意図だけを補う**。採用するかどうかと語彙は開発戦略に従う。
|
|
41
|
+
|
|
42
|
+
### 層ごとの知識の持たせ方
|
|
43
|
+
|
|
44
|
+
アウトサイドインで外側から下りる順に並べる。
|
|
45
|
+
|
|
46
|
+
| 層 | 権威ある情報源 | 生成・検証するもの | 補う知識 |
|
|
47
|
+
| :--- | :--- | :--- | :--- |
|
|
48
|
+
| 受け入れ(最外殻) | E2E テスト・BDD シナリオ | デモ項目をシナリオとして実行し、そのまま振る舞いの仕様として公開する | シナリオの意図(誰が何のために操作するか)をシナリオの冒頭に書く |
|
|
49
|
+
| 画面・ルーティング | ルート定義 | 画面一覧と画面遷移図をルート定義から生成する。`docs/design/` の UI 設計にルート一覧を手で複製しない | 遷移の理由やロールによる制御の意図を UI 設計に残す |
|
|
50
|
+
| コンポーネント | コンポーネントとその使用例 | コンポーネントカタログ(Storybook など、採用している場合)を使用例から生成する | 模範とするコンポーネントを JSDoc タグ(例: `@exemplar`)や命名規約で示す |
|
|
51
|
+
| ロジック・データ | API クライアントと型 | API の型はバックエンドが公開する OpenAPI から生成し、手で書かない。生成した型とのずれは型チェックで検出する | 画面固有の状態の持ち方など、型に表れない判断を ADR に残す |
|
|
52
|
+
|
|
53
|
+
### フロントエンドで守ること
|
|
54
|
+
|
|
55
|
+
- **ユビキタス言語を画面に通す**: コンポーネント名・画面の文言・テスト名をバックエンドのドメイン用語と揃える。同じ概念を画面ごとに別の名前で呼ばない
|
|
56
|
+
- **テストを利用者の言葉で書く**: テスト名とテスト内の操作は「ユーザーが何をするか」で書く。実装の詳細(DOM 構造やクラス名)に依存したテストは、仕様として読めない
|
|
57
|
+
- **注釈は軽く保つ**: TypeScript/JavaScript は実行時に読めるアノテーションが一般にないため、JSDoc のタグ・フォルダ構成・命名規約で役割を表す。付けるのは例外と本質的な知識だけにする
|
|
58
|
+
- **重複させた知識には検証を付ける**: バックエンドと共有する型・定数・ルートの権限設定は、生成するか、不一致を検出するテストで守る
|
|
59
|
+
- **画面キャプチャは生成する**: マニュアル用の画面キャプチャは E2E ツールで再生成する(`creating-manual`)。手で撮り直す運用にすると画面の変更に追従しなくなる
|
|
60
|
+
|
|
61
|
+
### TDD サイクルでのタイミング
|
|
62
|
+
|
|
63
|
+
- **Red**: 最外殻のテスト(E2E・シナリオ)を業務の言葉で書き、そこから内側のテストへ下りる
|
|
64
|
+
- **Refactor**: コンポーネント名と文言を用語に揃える。模範例や見どころの印は、付ける数を最小にする
|
|
65
|
+
- **コミット**: 変更の意図を書く(`git-commit`)。状態管理やルーティングの方式など、代替案を比べて選んだ判断は ADR に残す(`creating-adr`)
|
|
66
|
+
|
|
35
67
|
## テストコマンド
|
|
36
68
|
|
|
37
69
|
```bash
|
|
@@ -57,6 +89,8 @@ cd apps/frontend && npm run test:e2e
|
|
|
57
89
|
- [ ] テストカバレッジが目標を満たしている
|
|
58
90
|
- [ ] 単一の論理的作業単位を表現
|
|
59
91
|
- [ ] コミットメッセージが変更内容を明確に説明
|
|
92
|
+
- [ ] (Living Documentation 採用時)コンポーネント名・文言・テスト名がドメインの用語に揃っている
|
|
93
|
+
- [ ] (Living Documentation 採用時)API の型が生成物と一致し、画面一覧・遷移図などの生成物がビルドで生成できる
|
|
60
94
|
|
|
61
95
|
## 途中から再開
|
|
62
96
|
|
|
@@ -85,9 +119,13 @@ cd apps/frontend && npm run test:e2e
|
|
|
85
119
|
- コミット前に必ず品質チェックリストを実行する
|
|
86
120
|
- 作業完了後に対象の @docs/development/iteration_plan-N.md の進捗を更新する
|
|
87
121
|
- コンポーネントは単一責任の原則に従い小さく保つ。TODO 駆動で分割し、Rule of Three でリファクタリングする
|
|
122
|
+
- ルート一覧・コンポーネント一覧・API の型など、コードから取り出せる知識を `docs/design/` に手で書き写さない。書くのはコードに無い意図と根拠だけにする
|
|
88
123
|
|
|
89
124
|
## 関連スキル
|
|
90
125
|
|
|
91
126
|
- `developing-backend` — バックエンド TDD 開発
|
|
92
127
|
- `orchestrating-development` — 開発フェーズ全体のワークフロー
|
|
93
128
|
- `git-commit` — Conventional Commits 準拠のコミット
|
|
129
|
+
- `creating-adr` — 設計判断の根拠の記録
|
|
130
|
+
- `creating-manual` — E2E ツールによる画面キャプチャの再生成
|
|
131
|
+
- `creating-development-strategy` — Living Documentation の採用可否・語彙・局面ごとの重点
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: orchestrating-development
|
|
3
|
-
description: 開発フェーズ全体の TDD ワークフローをオーケストレーション。バックエンド・フロントエンドの開発順序と TDD サイクルの実践方法を案内し、Codex
|
|
3
|
+
description: 開発フェーズ全体の TDD ワークフローをオーケストレーション。バックエンド・フロントエンドの開発順序と TDD サイクルの実践方法を案内し、Codex 分業体制もサポートする。開発中に生まれる知識を Living Documentation としてコードと同期させる実践も案内する。「開発を始めたい」「TDD の進め方を知りたい」「Codex と分業で開発したい」「開発フェーズの全体像を把握したい」「開発しながらドキュメントをコードと同期させたい」といった場面で発動する。開発フローを標準化することで、品質のブレを防ぎチーム全体の生産性を底上げする。
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# 開発フェーズオーケストレーション
|
|
@@ -32,6 +32,8 @@ description: 開発フェーズ全体の TDD ワークフローをオーケス
|
|
|
32
32
|
| イテレーション完了時(ユーザーレビュー) | `analyzing-review` | 受け入れフェーズでユーザー視点・プロダクト視点からの成果物レビュー |
|
|
33
33
|
| 設計ドキュメント新規作成の直前 | `apply-docs-structure` | 開発中に設計ドキュメント・ADR を新規に書く前に配置先(プロジェクト別カテゴリの `<project>/` 配下)を判断する。配置を誤ると docs と apps のトレーサビリティが壊れ、後からの移動は索引・リンク・来歴すべての修正になる |
|
|
34
34
|
| 設計ドキュメント更新時 | `apply-okf` | 開発中に `docs/design/` や ADR を更新したら OKF フロントマター(`generated`)と `log.md` を追従させる。実装で設計が変わったのに文書の来歴が古いままだと、次のイテレーションで古い設計を信頼してしまう |
|
|
35
|
+
| 設計判断を下したとき | `creating-adr` | 代替案を比較して選んだ判断は、その場で文脈・理由・却下した代替案を ADR に残す。後から思い出して書くと根拠が失われる |
|
|
36
|
+
| イテレーション完了時(生きたドキュメントの確認) | — | Living Documentation を採用している場合、生成するドキュメント(用語集・図・ガイドツアー)がビルドで生成できること、手書きでコードを複製した一覧・図が増えていないことを確認する(下記「Living Documentation の実践」) |
|
|
35
37
|
|
|
36
38
|
## TDD サイクル
|
|
37
39
|
|
|
@@ -42,10 +44,38 @@ TDD は「テストを書いてからコードを書く」手順ではなく、
|
|
|
42
44
|
3. **Refactor**: 重複を除去し設計を改善する
|
|
43
45
|
4. @docs/reference/コーディングとテストガイド.md のワークフローに従う
|
|
44
46
|
|
|
47
|
+
## Living Documentation の実践
|
|
48
|
+
|
|
49
|
+
開発中に生まれる知識(用語・構造・判断の理由)を、別文書に書き写すのではなくコードとテストに持たせ、足りない意図と根拠だけを補う。採用するかどうかと局面ごとの重点は開発戦略(@docs/development/development_strategy.md、`creating-development-strategy`)で決まっているので、ここではそれを TDD サイクルの中で実行する。原則と手法は @docs/reference/LivingDocumentation導入ガイド.md を参照する。
|
|
50
|
+
|
|
51
|
+
### TDD サイクルへの組み込み
|
|
52
|
+
|
|
53
|
+
新しい作業は増やさず、既存のステップの中で知識を残す。
|
|
54
|
+
|
|
55
|
+
| ステップ | 知識の残し方 |
|
|
56
|
+
| :--- | :--- |
|
|
57
|
+
| Red | テスト名とシナリオをユビキタス言語で書く。テストは「振る舞いの仕様」として読まれるドキュメントになる |
|
|
58
|
+
| Green | 最小限の実装に集中する。この段階ではドキュメントのことは考えない |
|
|
59
|
+
| Refactor | 名前をドメインの用語に揃える(用語集の元になる)。開発戦略で決めた語彙に従い、役割・性質などの本質的な知識だけをアノテーション(言語によっては属性・デコレータ・命名規約)で補う |
|
|
60
|
+
| コミット | 変更の意図をコミットメッセージに書く(`git-commit`)。コードの差分から読み取れる「何を」ではなく「なぜ」を書く |
|
|
61
|
+
| 設計判断 | 代替案を比較した判断は ADR に残す(`creating-adr`) |
|
|
62
|
+
|
|
63
|
+
アノテーションの付け方は @docs/reference/アノテーション導入ガイド.md、コア概念・模範例の選び方は @docs/reference/ダイナミックキュレーション導入ガイド.md、処理の流れの案内は @docs/reference/ガイドツアー・サイトシーイング導入ガイド.md に従う。
|
|
64
|
+
|
|
65
|
+
### 守ること
|
|
66
|
+
|
|
67
|
+
- **書く前に探す**: 知識がすでにコード・テスト・ADR・コミット履歴にあれば、ドキュメントに書き写さずリンクするか生成する
|
|
68
|
+
- **手で複製しない**: クラス一覧・依存関係図・用語一覧など、コードから取り出せるものを `docs/design/` に手で書き写さない。`docs/design/` にはコードから読み取れない意図・判断・却下した代替案を書く
|
|
69
|
+
- **重複には検証を付ける**: やむを得ず重複させた知識(公開 API の契約、シナリオとコード)は、不一致を検出するテストで守る
|
|
70
|
+
- **付けすぎない**: アノテーションは例外と本質的な知識にだけ付ける。すべてのクラスに同じアノテーションを付けるとノイズになる
|
|
71
|
+
- **書きにくさを設計のシグナルにする**: 名前が決まらない、図が交差だらけになるといった場合は、ドキュメントではなく設計を直す
|
|
72
|
+
|
|
45
73
|
## 参照ドキュメント
|
|
46
74
|
|
|
47
75
|
- @docs/reference/コーディングとテストガイド.md — TDD ワークフロー詳細
|
|
48
76
|
- @docs/reference/CodexCLIMCPアプリケーション開発フロー.md — Codex 連携フロー
|
|
77
|
+
- @docs/reference/LivingDocumentation導入ガイド.md — 開発中の知識をコードと同期させる原則と手法
|
|
78
|
+
- @docs/development/development_strategy.md — 局面ごとの TDD アプローチと Living Documentation の重点(あれば)
|
|
49
79
|
- @docs/design/architecture.md, @docs/design/architecture_backend.md, @docs/design/architecture_frontend.md
|
|
50
80
|
- @docs/design/data-model.md, @docs/design/domain-model.md, @docs/design/tech_stack.md
|
|
51
81
|
- @docs/design/ui-design.md, @docs/design/test_strategy.md
|
|
@@ -98,6 +128,7 @@ graph LR
|
|
|
98
128
|
2. **コード全文を渡す**: 自然言語の説明より、作成すべきファイルの完全なコードを指示に含める
|
|
99
129
|
3. **「既存コードは変更しないでください」を明記**: 追記指示時に Codex が他の箇所を無断で書き換えるのを防ぐ
|
|
100
130
|
4. **`--write` フラグを含める**: 書き込みが必要な場合は prompt 冒頭に `--write` を付ける
|
|
131
|
+
5. **知識の残し方も指示に含める**: Living Documentation を採用している場合、渡すコード全文に規定のアノテーションとユビキタス言語の命名を含める。Codex に任せると語彙が揺れ、生成する用語集や図が崩れる
|
|
101
132
|
|
|
102
133
|
### Codex への指示例
|
|
103
134
|
|
|
@@ -116,6 +147,7 @@ codex:codex-rescue に以下を委譲:
|
|
|
116
147
|
- [ ] 既存テストが壊れていない(Codex の変更で `localStorage` → `sessionStorage` 等の無断変更がないか)
|
|
117
148
|
- [ ] E2E テストがすべてパス
|
|
118
149
|
- [ ] ESLint / Prettier / 品質チェックがパス
|
|
150
|
+
- [ ] (Living Documentation 採用時)規定のアノテーションと命名が守られ、生成するドキュメントがビルドで生成できる
|
|
119
151
|
|
|
120
152
|
### Codex の既知の問題と対策
|
|
121
153
|
|
|
@@ -159,9 +191,11 @@ codex:codex-rescue に以下を委譲:
|
|
|
159
191
|
- コミット前に必ず品質チェックリストを実行する
|
|
160
192
|
- TODO 駆動開発でタスクを細かく分割してから実装を開始する
|
|
161
193
|
- Rule of Three: 同じコードが 3 回現れたらリファクタリングする
|
|
194
|
+
- コードから取り出せる知識を設計ドキュメントに手で書き写さない。書くのはコードに無い意図と根拠だけにする
|
|
162
195
|
|
|
163
196
|
## 関連スキル
|
|
164
197
|
|
|
198
|
+
- `creating-development-strategy` — 局面ごとの TDD アプローチと Living Documentation の重点を定める開発戦略
|
|
165
199
|
- `developing-backend` — バックエンド TDD 開発
|
|
166
200
|
- `developing-frontend` — フロントエンド TDD 開発
|
|
167
201
|
- `developing-review` — 開発成果物のマルチパースペクティブレビュー(TODO 完了時のコードレビュー)
|
|
@@ -170,3 +204,5 @@ codex:codex-rescue に以下を委譲:
|
|
|
170
204
|
- `developing-release` — リリースワークフロー(品質ゲート・バージョン管理・CHANGELOG)
|
|
171
205
|
- `apply-docs-structure` — 設計ドキュメント・ADR を新規に書く直前の配置先判断(プロジェクト別カテゴリ)
|
|
172
206
|
- `apply-okf` — 開発中に更新した設計ドキュメント・ADR への OKF 規約適用
|
|
207
|
+
- `creating-adr` — 開発中に下した設計判断の根拠の記録
|
|
208
|
+
- `git-commit` — 変更の意図を残すコミット
|
|
@@ -13,5 +13,6 @@
|
|
|
13
13
|
| [Grokking Concurrency](https://k2works.github.io/grokking-concurrency-exercise/) | 並行処理プログラミング | スレッド、同期、非同期、ノンブロッキング I/O、分散並列処理を多言語で比較できます。 |
|
|
14
14
|
| [Grokking Machine Learning](https://k2works.github.io/grokking-machine-learning-excersice/) | 機械学習 | 線形回帰から決定木、ニューラルネットワーク、SVM、アンサンブル学習まで、機械学習アルゴリズムを Python・Kotlin・F# で自前実装しながら学べます。 |
|
|
15
15
|
| [関数型デザイン - 原則、パターン、実践](https://k2works.github.io/functional-desgin-ppp/) | 関数型デザインパターン | OOP のデザインパターンを関数型パラダイムでどう表現するかを実践的に学べます。 |
|
|
16
|
+
| [From Objects to Functions 演習](https://k2works.github.io/from-objects-to-functions-excersice/) | 関数型アーキテクチャ | To-Do アプリ Zettai を題材に、HTTP、ドメインモデリング、イベントソーシング、関数型エラーハンドリング、ファンクタ・モナドによる射影と永続化までを Kotlin・なでしこ3・Rust で実装しながら学べます。 |
|
|
16
17
|
| [実践データベース設計:基幹業務システム編](https://k2works.github.io/practical-database-design/) | データベース設計 | 販売管理・財務会計・生産管理の基幹業務システムを題材に、業務フローとデータモデルを体系的に学べます。 |
|
|
17
18
|
| [Docker/Kubernetes 実践コンテナ解説](https://k2works.github.io/getting-started-docker-kubernetes/) | コンテナ・オーケストレーション | コンテナの基礎から複数コンテナ構成、Kubernetes、継続的デリバリー、ケーススタディまで実践的に学べます。 |
|
package/lib/assets/docs/index.md
CHANGED
|
@@ -1,37 +1,37 @@
|
|
|
1
|
-
---
|
|
2
|
-
okf_version: "0.2"
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
# プロジェクトドキュメント
|
|
6
|
-
|
|
7
|
-
プロジェクトで管理しているドキュメントの入口です。
|
|
8
|
-
|
|
9
|
-
## まずこれを読もうリスト
|
|
10
|
-
|
|
11
|
-
- [戦略](./strategy/index.md) - ビジネス構造やプロジェクトの方向性を整理します。
|
|
12
|
-
- [要件](./requirements/index.md) - RDRA 2.0 ベースで要件を定義します。
|
|
13
|
-
- [設計](./design/index.md) - アーキテクチャ、モデル、品質方針を整理します。
|
|
14
|
-
- [開発](./development/index.md) - リリース計画とイテレーション管理の入口です。
|
|
15
|
-
- [運用](./operation/index.md) - 環境構築、デプロイ、運用関連の入口です。
|
|
16
|
-
- [記事](./article/index.md) - 学習用の記事シリーズの入口です。
|
|
17
|
-
|
|
18
|
-
## ドキュメント構成
|
|
19
|
-
|
|
20
|
-
| カテゴリ | 概要 | 状況 |
|
|
21
|
-
| :--- |:------------------------------------| :--- |
|
|
22
|
-
| [戦略](./strategy/index.md) | 企業分析、経営戦略、ビジネスアーキテクチャ、インセプションデッキの整理 | `index.md` を整備済み |
|
|
23
|
-
| [要件](./requirements/index.md) | RDRA 2.0 とユースケース整理の入口 | `index.md` を整備済み |
|
|
24
|
-
| [設計](./design/index.md) | アーキテクチャ、モデル、テスト、非機能の整理 | `index.md` を整備済み |
|
|
25
|
-
| [開発](./development/index.md) | リリース計画、イテレーション計画、進捗管理 | `index.md` を整備済み |
|
|
26
|
-
| [運用](./operation/index.md) | 環境構築、デプロイ、運用手順の整理 | `index.md` を整備済み |
|
|
27
|
-
| [レビュー](./review/index.md) | 分析・開発レビュー結果の記録 | `index.md` を整備済み |
|
|
28
|
-
| [ADR](./adr/index.md) | Architecture Decision Records の管理 | `index.md` を整備済み |
|
|
29
|
-
| [記事](./article/index.md) | 学習用の記事シリーズ一覧 | 公開サイトへのリンク集 |
|
|
30
|
-
| [リファレンス](./reference/index.md) | 開発ガイドラインやベストプラクティス |
|
|
31
|
-
| [テンプレート](./template/index.md) | 各種ドキュメントの作成テンプレート | 18 件のテンプレートを配置 |
|
|
32
|
-
|
|
33
|
-
## 補足
|
|
34
|
-
|
|
35
|
-
- `strategy/`、`requirements/`、`design/`、`development/`、`operation/` は現時点ではカテゴリ索引が中心です。
|
|
36
|
-
- `journal/` は作業ログ用の予約ディレクトリです。
|
|
37
|
-
- `assets/` は MkDocs 用のスタイル・スクリプトを格納しています。
|
|
1
|
+
---
|
|
2
|
+
okf_version: "0.2"
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# プロジェクトドキュメント
|
|
6
|
+
|
|
7
|
+
プロジェクトで管理しているドキュメントの入口です。
|
|
8
|
+
|
|
9
|
+
## まずこれを読もうリスト
|
|
10
|
+
|
|
11
|
+
- [戦略](./strategy/index.md) - ビジネス構造やプロジェクトの方向性を整理します。
|
|
12
|
+
- [要件](./requirements/index.md) - RDRA 2.0 ベースで要件を定義します。
|
|
13
|
+
- [設計](./design/index.md) - アーキテクチャ、モデル、品質方針を整理します。
|
|
14
|
+
- [開発](./development/index.md) - リリース計画とイテレーション管理の入口です。
|
|
15
|
+
- [運用](./operation/index.md) - 環境構築、デプロイ、運用関連の入口です。
|
|
16
|
+
- [記事](./article/index.md) - 学習用の記事シリーズの入口です。
|
|
17
|
+
|
|
18
|
+
## ドキュメント構成
|
|
19
|
+
|
|
20
|
+
| カテゴリ | 概要 | 状況 |
|
|
21
|
+
| :--- |:------------------------------------| :--- |
|
|
22
|
+
| [戦略](./strategy/index.md) | 企業分析、経営戦略、ビジネスアーキテクチャ、インセプションデッキの整理 | `index.md` を整備済み |
|
|
23
|
+
| [要件](./requirements/index.md) | RDRA 2.0 とユースケース整理の入口 | `index.md` を整備済み |
|
|
24
|
+
| [設計](./design/index.md) | アーキテクチャ、モデル、テスト、非機能の整理 | `index.md` を整備済み |
|
|
25
|
+
| [開発](./development/index.md) | リリース計画、イテレーション計画、進捗管理 | `index.md` を整備済み |
|
|
26
|
+
| [運用](./operation/index.md) | 環境構築、デプロイ、運用手順の整理 | `index.md` を整備済み |
|
|
27
|
+
| [レビュー](./review/index.md) | 分析・開発レビュー結果の記録 | `index.md` を整備済み |
|
|
28
|
+
| [ADR](./adr/index.md) | Architecture Decision Records の管理 | `index.md` を整備済み |
|
|
29
|
+
| [記事](./article/index.md) | 学習用の記事シリーズ一覧 | 公開サイトへのリンク集 |
|
|
30
|
+
| [リファレンス](./reference/index.md) | 開発ガイドラインやベストプラクティス | 39 件のドキュメントを配置 |
|
|
31
|
+
| [テンプレート](./template/index.md) | 各種ドキュメントの作成テンプレート | 18 件のテンプレートを配置 |
|
|
32
|
+
|
|
33
|
+
## 補足
|
|
34
|
+
|
|
35
|
+
- `strategy/`、`requirements/`、`design/`、`development/`、`operation/` は現時点ではカテゴリ索引が中心です。
|
|
36
|
+
- `journal/` は作業ログ用の予約ディレクトリです。
|
|
37
|
+
- `assets/` は MkDocs 用のスタイル・スクリプトを格納しています。
|
package/lib/assets/docs/log.md
CHANGED
|
@@ -1,25 +1,28 @@
|
|
|
1
|
-
# Docs Update Log
|
|
2
|
-
|
|
3
|
-
## 2026-09-
|
|
4
|
-
* **
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
* **Verification**: [
|
|
8
|
-
* **Verification**: [
|
|
9
|
-
* **Verification**: [
|
|
10
|
-
* **
|
|
11
|
-
* **
|
|
12
|
-
* **
|
|
13
|
-
* **Creation**: [
|
|
14
|
-
* **Creation**: [
|
|
15
|
-
* **
|
|
16
|
-
* **Creation**: [AI-DLC
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
* **
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
* **
|
|
25
|
-
|
|
1
|
+
# Docs Update Log
|
|
2
|
+
|
|
3
|
+
## 2026-09-26
|
|
4
|
+
* **Creation**: [BDD導入ガイド](/reference/BDD導入ガイド.md) を作成(claude-code/claude-opus-5)
|
|
5
|
+
|
|
6
|
+
## 2026-09-12
|
|
7
|
+
* **Verification**: [AI-DLC用語集](/reference/AI-DLC用語集.md) を human:kakimomokuri が検証
|
|
8
|
+
* **Verification**: [コーディングとテストガイド_AI-DLC版](/reference/コーディングとテストガイド_AI-DLC版.md) を human:kakimomokuri が検証
|
|
9
|
+
* **Verification**: [ユースケース作成ガイド_AI-DLC版](/reference/ユースケース作成ガイド_AI-DLC版.md) を human:kakimomokuri が検証
|
|
10
|
+
* **Verification**: [リリース・イテレーション計画ガイド_AI-DLC版](/reference/リリース・イテレーション計画ガイド_AI-DLC版.md) を human:kakimomokuri が検証
|
|
11
|
+
* **Verification**: [開発ガイド_AI-DLC版](/reference/開発ガイド_AI-DLC版.md) を human:kakimomokuri が検証
|
|
12
|
+
* **Verification**: [AI-DLC導入ガイド](/reference/AI-DLC導入ガイド.md) を human:kakimomokuri が検証
|
|
13
|
+
* **Creation**: [AI-DLC 用語集](/reference/AI-DLC用語集.md) を新規作成。論文・参照実装・本プロジェクトの AI-DLC 版ガイドの用語を 6 区分で定義し、XP・Scrum との対応表と参照先を追加。`CLAUDE.md` の参照表にも登録。
|
|
14
|
+
* **Creation**: [開発ガイド(AI-DLC 版)](/reference/開発ガイド_AI-DLC版.md) を新規作成。XP 版の開発ライフサイクル(分析・開発・運用・構築・配置)を AI-DLC の 3 フェーズで読み替え、各活動で AI が生成し人が検証するものを定義。AI-DLC 版ガイド 4 本と XP 版ガイドの対応表を追加。あわせて `CLAUDE.md` に AI-DLC を採用する旨と守るべき 6 原則を明記し、ペルソナの参照先を開発ガイド(AI-DLC 版)に変更。
|
|
15
|
+
* **Creation**: [コーディングとテストガイド(AI-DLC 版)](/reference/コーディングとテストガイド_AI-DLC版.md) を新規作成。XP 版の章構成を保ちながら、TDD の三原則を AI に守らせる Bolt 開発フロー、承認ゲートの密度選択、AI 向けのアプローチ指示、ステップ計画、Red/Green/Refactor 各フェーズの人の検証観点、AI 生成コード固有の品質観点、ソース束縛レビュー、テスト戦略の水準、ガードレール化、quick-cement としての技術的負債、開発スキルの読み替え表を定義。
|
|
16
|
+
* **Creation**: [ユースケース作成ガイド(AI-DLC 版)](/reference/ユースケース作成ガイド_AI-DLC版.md) を新規作成。XP 版の章構成を保ちながら、Mob Elaboration によるユースケース作成手順、12 ステップの AI と人の分担、トレーサビリティ項目を加えたテンプレート、セマンティクス密度、AI 生成ユースケースの検証観点、ブラウンフィールドのリバースエンジニアリング、プロンプトパターン、分析スキルの読み替え表を定義。
|
|
17
|
+
* **Creation**: [リリース・イテレーション計画ガイド(AI-DLC 版)](/reference/リリース・イテレーション計画ガイド_AI-DLC版.md) を新規作成。XP 版の章構成を保ちながら、Intent → Unit → Bolt の計画階層、承認駆動の Bolt 計画、エントロピー評価による見積もり、完了 Unit 数・ゲート通過数・リードタイムによる進捗管理、リスク台帳、Bolt 終了報告テンプレート、計画スキルの読み替え表を定義。
|
|
18
|
+
* **Update**: [AI-DLC 導入ガイド](/reference/AI-DLC導入ガイド.md) を一次情報(Method Definition Paper・aidlc-workflows ユーザーガイド)で精査し拡充。10 の基本原則、成果物定義(Intent・Unit・Bolt・Domain/Logical Design・Deployment Unit)、Inception の 6 成果物、グリーンフィールド/ブラウンフィールド実践例、付録 A のプロンプトパターン、参照実装の 5 フェーズ 33 ステージ・スコープ・エージェント・承認ゲート・監査ログ、33 ステージと Skills の対応表を追加。
|
|
19
|
+
* **Creation**: [AI-DLC 導入ガイド](/reference/AI-DLC導入ガイド.md) を新規作成。AI-DLC の概要・コア原則・3 フェーズ・ベストプラクティスを整理し、XP と Skills 体系への対応表と段階的な導入ステップを定義。
|
|
20
|
+
|
|
21
|
+
## 2026-08-26
|
|
22
|
+
* **Verification**: [ドキュメント構成ガイド](/reference/ドキュメント構成ガイド.md) を human:kakimomokuri が検証
|
|
23
|
+
* **Update**: ドキュメント構成ガイドを更新。docs/review を共通からプロジェクト別カテゴリに変更(プロジェクト別は 7 カテゴリに)。
|
|
24
|
+
* **Creation**: ドキュメント構成ガイドを新規作成。単一企業・統合戦略・複数プロジェクトのコンセプトと apps/ との対応規約を定義。
|
|
25
|
+
|
|
26
|
+
## 2026-08-25
|
|
27
|
+
* **Update**: リンク切れ 53 件を修正。`grokking-concurrency` のサンプルコード参照をインラインコード表記に統一、`functional-desgin-ppp/elixir` の目次 6〜10 章を実際の章構成に合わせて書き直し、[Codex CLI MCP アプリケーション開発フロー](/reference/CodexCLIMCPアプリケーション開発フロー.md) の関連ドキュメントを実在ガイドに付け替え、未執筆の付録は「未作成」と明記。`template/まずこれを読もうリスト.md` の 10 件はコピー先基準のパスのため据え置き。
|
|
28
|
+
* **Migration**: `docs/` を OKF v0.2 の知識バンドルに移行。601 件のコンセプト(Article 552 件・Reference 31 件・Template 18 件)に `type`・`title`・`description`・`tags`・`generated` を付与し、ルート `index.md` に `okf_version: "0.2"` を宣言。本文は変更していない。Wiki.js 由来のフロントマターは OKF 形式に併合した。
|