yodogawa 2.1.3 → 2.2.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/CHANGELOG.md +134 -94
- package/LICENSE +1 -1
- package/README.md +351 -263
- package/bin/checks/id-trace.js +137 -0
- package/bin/checks/links.js +59 -0
- package/bin/checks/placeholder.js +132 -0
- package/bin/checks/structure.js +127 -0
- package/bin/cli.js +51 -67
- package/bin/commands/doctor.js +128 -0
- package/bin/commands/install.js +58 -0
- package/bin/commands/new-task.js +117 -0
- package/bin/lib/check-cli.js +19 -0
- package/bin/lib/findings.js +31 -0
- package/bin/lib/markdown.js +103 -0
- package/bin/lib/project-spec.js +138 -0
- package/bin/lib/walk-md.js +23 -0
- package/package.json +68 -55
- package/skills/a-001-setup-doc-structure/SKILL.md +68 -68
- package/skills/a-001-setup-doc-structure/reference/directory-structure.md +75 -75
- package/skills/a-002-initialize-project/SKILL.md +145 -118
- package/skills/a-002-initialize-project/reference/hearing-questions.md +91 -41
- package/skills/a-002-initialize-project/reference/structure-check.md +12 -22
- package/skills/a-002a-slice-mvp-scope/SKILL.md +105 -0
- package/skills/a-002b-define-user-stories/SKILL.md +80 -0
- package/skills/a-002b-define-user-stories/reference/user-stories-guide.md +78 -0
- package/skills/a-003-create-scenarios/SKILL.md +97 -96
- package/{templates/project/02-behavior/01-scenarios.md → skills/a-003-create-scenarios/reference/detailed-gherkin-template.md} +413 -406
- package/skills/a-003-create-scenarios/reference/structure-check.md +20 -17
- package/skills/a-004-define-domain-model/SKILL.md +107 -98
- package/skills/a-004-define-domain-model/reference/event-storming-guide.md +33 -7
- package/skills/a-004-define-domain-model/reference/ubiquitous-language-guide.md +49 -0
- package/skills/a-005-create-domain-diagram/SKILL.md +18 -17
- package/skills/a-006-review-requirements-domain/SKILL.md +59 -22
- package/skills/a-006-review-requirements-domain/examples/review-report-template.md +27 -7
- package/skills/a-006-review-requirements-domain/reference/consistency-checks.md +53 -18
- package/skills/a-007-define-tech-stack/SKILL.md +99 -99
- package/skills/a-008-define-repository-structure/SKILL.md +96 -96
- package/skills/a-009-define-screen-design/SKILL.md +103 -103
- package/skills/a-010-define-design-system/SKILL.md +130 -130
- package/skills/a-011-define-data-model/SKILL.md +118 -118
- package/skills/a-012-define-api-spec/SKILL.md +105 -105
- package/skills/a-013-define-architecture/SKILL.md +98 -98
- package/skills/a-014-define-infrastructure/SKILL.md +118 -110
- package/skills/{a-002-initialize-project → a-014-define-infrastructure}/examples/nfr-baseline.md +2 -1
- package/{templates/project/01-requirements/04-non-functional-requirements.md → skills/a-014-define-infrastructure/examples/non-functional-requirements.md} +120 -115
- package/skills/a-015-review-design/reference/consistency-checks.md +1 -1
- package/skills/b-001-create-task-directory/SKILL.md +68 -68
- package/skills/b-002-create-task-definition/SKILL.md +114 -114
- package/skills/b-003-create-task-research/SKILL.md +128 -128
- package/skills/b-004-create-task-implementation/SKILL.md +98 -98
- package/skills/b-005-review-task/reference/assessment-criteria.md +79 -79
- package/skills/c-001-implement-task/SKILL.md +186 -186
- package/skills/c-001-implement-task/reference/implementation-loop.md +65 -65
- package/skills/c-002-update-documentation/SKILL.md +159 -159
- package/skills/c-002-update-documentation/examples/project-doc-updates.md +4 -4
- package/skills/c-002-update-documentation/reference/doc-structure-and-checks.md +99 -97
- package/templates/project/01-requirements/01-product-brief.md +186 -0
- package/templates/project/01-requirements/02-mvp-scope.md +64 -0
- package/templates/project/01-requirements/03-parking-lot.md +29 -0
- package/templates/project/01-requirements/05-user-stories.md +28 -124
- package/templates/project/01-requirements/{02-features-implemented.md → 06-features-implemented.md} +77 -73
- package/templates/project/02-behavior/01-core-scenarios.md +80 -0
- package/templates/project/03-domain/01-domain-model.md +120 -339
- package/templates/project/03-domain/01-domain-sketch.md +90 -0
- package/templates/project/03-domain/02-ubiquitous-language.md +32 -153
- package/templates/project/04-design/01-tech-stack.md +367 -367
- package/templates/project/04-design/02-repository-structure.md +391 -391
- package/templates/project/04-design/03-screen-design.md +596 -596
- package/templates/project/04-design/04-design-system.md +261 -261
- package/templates/project/04-design/05-data-model.md +211 -211
- package/templates/project/04-design/06-api-spec.md +226 -226
- package/templates/project/04-design/07-architecture.md +183 -183
- package/templates/project/04-design/08-infrastructure.md +180 -180
- package/templates/project/AI_CONTEXT.md +55 -0
- package/templates/project/STAKEHOLDER-SUMMARY.md +66 -0
- package/templates/tasks/task-template/a-definition.md +143 -143
- package/templates/tasks/task-template/b-research.md +185 -185
- package/templates/tasks/task-template/c-implementation.md +200 -200
- package/templates/project/01-requirements/01-system-overview.md +0 -49
- package/templates/project/01-requirements/03-features-planned.md +0 -75
package/package.json
CHANGED
|
@@ -1,55 +1,68 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "yodogawa",
|
|
3
|
-
"version": "2.
|
|
4
|
-
"description": "
|
|
5
|
-
"
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
"
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
"
|
|
18
|
-
"
|
|
19
|
-
"
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
"
|
|
25
|
-
"
|
|
26
|
-
"
|
|
27
|
-
"
|
|
28
|
-
"
|
|
29
|
-
"
|
|
30
|
-
"
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
"
|
|
34
|
-
"
|
|
35
|
-
"
|
|
36
|
-
"
|
|
37
|
-
"
|
|
38
|
-
"
|
|
39
|
-
"
|
|
40
|
-
"
|
|
41
|
-
"
|
|
42
|
-
"
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
"
|
|
48
|
-
"
|
|
49
|
-
"
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
"
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
1
|
+
{
|
|
2
|
+
"name": "yodogawa",
|
|
3
|
+
"version": "2.2.0",
|
|
4
|
+
"description": "AIネイティブIDE向け仕様駆動開発スキル集",
|
|
5
|
+
"homepage": "https://github.com/tkysi-mi/Yodogawa#readme",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "git+https://github.com/tkysi-mi/Yodogawa.git"
|
|
9
|
+
},
|
|
10
|
+
"bugs": {
|
|
11
|
+
"url": "https://github.com/tkysi-mi/Yodogawa/issues"
|
|
12
|
+
},
|
|
13
|
+
"bin": {
|
|
14
|
+
"yodogawa": "bin/cli.js"
|
|
15
|
+
},
|
|
16
|
+
"files": [
|
|
17
|
+
"bin",
|
|
18
|
+
"skills",
|
|
19
|
+
"templates",
|
|
20
|
+
"README.md",
|
|
21
|
+
"CHANGELOG.md"
|
|
22
|
+
],
|
|
23
|
+
"scripts": {
|
|
24
|
+
"test": "node --test \"test/**/*.test.js\"",
|
|
25
|
+
"lint:md": "markdownlint-cli2 \"**/*.md\" \"#node_modules\" \"#test/fixtures\"",
|
|
26
|
+
"lint:md:fix": "markdownlint-cli2 --fix \"**/*.md\" \"#node_modules\" \"#test/fixtures\"",
|
|
27
|
+
"check:repo": "node scripts/repo-check.mjs",
|
|
28
|
+
"sync:manifests": "node scripts/sync-plugin-manifests.mjs",
|
|
29
|
+
"version": "node scripts/sync-plugin-manifests.mjs && git add .claude-plugin/plugin.json .claude-plugin/marketplace.json",
|
|
30
|
+
"prepare": "husky"
|
|
31
|
+
},
|
|
32
|
+
"keywords": [
|
|
33
|
+
"antigravity",
|
|
34
|
+
"cursor",
|
|
35
|
+
"claude-code",
|
|
36
|
+
"codex",
|
|
37
|
+
"skills",
|
|
38
|
+
"spec-driven-development",
|
|
39
|
+
"ai-coding",
|
|
40
|
+
"documentation",
|
|
41
|
+
"project-management",
|
|
42
|
+
"bdd",
|
|
43
|
+
"gherkin",
|
|
44
|
+
"domain-driven-design",
|
|
45
|
+
"event-storming",
|
|
46
|
+
"api-design",
|
|
47
|
+
"adr",
|
|
48
|
+
"task-management",
|
|
49
|
+
"user-stories",
|
|
50
|
+
"copilot",
|
|
51
|
+
"gpt",
|
|
52
|
+
"claude"
|
|
53
|
+
],
|
|
54
|
+
"author": "tkysi-mi",
|
|
55
|
+
"license": "MIT",
|
|
56
|
+
"engines": {
|
|
57
|
+
"node": ">=18"
|
|
58
|
+
},
|
|
59
|
+
"dependencies": {
|
|
60
|
+
"fs-extra": "^11.2.0",
|
|
61
|
+
"kleur": "^4.1.5",
|
|
62
|
+
"prompts": "^2.4.2"
|
|
63
|
+
},
|
|
64
|
+
"devDependencies": {
|
|
65
|
+
"husky": "^9.1.7",
|
|
66
|
+
"markdownlint-cli2": "^0.22.1"
|
|
67
|
+
}
|
|
68
|
+
}
|
|
@@ -1,68 +1,68 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: a-001-setup-doc-structure
|
|
3
|
-
description: docs/ 配下にプロジェクト/タスク用のディレクトリ構造と README を作成する。新規リポジトリでドキュメント基盤を初期化する際に使用。
|
|
4
|
-
disable-model-invocation: true
|
|
5
|
-
allowed-tools: Read, Write, Bash, Glob
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
# SetupDocStructure (a-001)
|
|
9
|
-
|
|
10
|
-
## 目的
|
|
11
|
-
|
|
12
|
-
- プロジェクトルートに標準化されたドキュメントディレクトリ構造を作成する。
|
|
13
|
-
- `docs/README.md` を作成し、ドキュメント構成と更新方針を明文化する。
|
|
14
|
-
|
|
15
|
-
## 前提
|
|
16
|
-
|
|
17
|
-
- プロジェクトのルートディレクトリへの書き込み権限があること
|
|
18
|
-
- `docs/` ディレクトリが存在しない、または既存の構造を拡張したいこと
|
|
19
|
-
|
|
20
|
-
## 手順
|
|
21
|
-
|
|
22
|
-
### 1. ディレクトリ構造の作成
|
|
23
|
-
|
|
24
|
-
次のディレクトリを作成する(`mkdir -p` なので既存の場合は不足分のみ追加される)。
|
|
25
|
-
|
|
26
|
-
```bash
|
|
27
|
-
mkdir -p docs/project/01-requirements docs/project/02-behavior docs/project/03-domain docs/project/04-design docs/tasks
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
続いて `docs/README.md` を作成する。内容は [reference/directory-structure.md](reference/directory-structure.md#docsreadmemd-テンプレート) の「docs/README.md テンプレート」をそのまま Write する。`docs/README.md` が既に存在する場合は、上書き前にユーザーへ確認する。
|
|
31
|
-
|
|
32
|
-
### 2. 結果の確認
|
|
33
|
-
|
|
34
|
-
ディレクトリ構造と `docs/README.md` が期待どおり生成されていることを確認。生成構造と各ディレクトリの用途は [reference/directory-structure.md](reference/directory-structure.md#生成されるディレクトリ構造) を参照。
|
|
35
|
-
|
|
36
|
-
### 3. Git への追加(オプション)
|
|
37
|
-
|
|
38
|
-
ユーザーに確認し、「はい」なら:
|
|
39
|
-
|
|
40
|
-
```bash
|
|
41
|
-
git add docs/
|
|
42
|
-
git status
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
推奨コミットメッセージは [reference/directory-structure.md](reference/directory-structure.md#git-追加時の推奨コミットメッセージ) を参照。
|
|
46
|
-
|
|
47
|
-
### 4. 完了条件の確認
|
|
48
|
-
|
|
49
|
-
- [ ] `docs/` ディレクトリ構造が正しく作成されている
|
|
50
|
-
- [ ] `docs/README.md` が作成されている
|
|
51
|
-
|
|
52
|
-
## 完了条件
|
|
53
|
-
|
|
54
|
-
- プロジェクトルートに `docs/` ディレクトリが作成されている
|
|
55
|
-
- `docs/project/` 配下に `01-requirements/`, `02-behavior/`, `03-domain/`, `04-design/` が存在する
|
|
56
|
-
- `docs/tasks/` ディレクトリが存在する
|
|
57
|
-
- `docs/README.md` が作成されている
|
|
58
|
-
- ユーザーに作成結果が報告されている
|
|
59
|
-
|
|
60
|
-
## エスカレーション
|
|
61
|
-
|
|
62
|
-
- **既存の `docs/` が存在し重要ファイルを含む**: 「既存のドキュメント構造が検出されました。上書きや削除のリスクがあるため、手動で確認してください。」と警告し処理を中断
|
|
63
|
-
- **権限エラー**: 「ディレクトリの作成に失敗しました。書き込み権限を確認してください。」
|
|
64
|
-
- **Git リポジトリでない**: 「このディレクトリは Git リポジトリではありません。必要なら `git init` を実行してください。」
|
|
65
|
-
|
|
66
|
-
## 参考
|
|
67
|
-
|
|
68
|
-
- [reference/directory-structure.md](reference/directory-structure.md) — 生成構造、各ディレクトリの用途、スクリプト詳細、推奨コミットメッセージ
|
|
1
|
+
---
|
|
2
|
+
name: a-001-setup-doc-structure
|
|
3
|
+
description: docs/ 配下にプロジェクト/タスク用のディレクトリ構造と README を作成する。新規リポジトリでドキュメント基盤を初期化する際に使用。
|
|
4
|
+
disable-model-invocation: true
|
|
5
|
+
allowed-tools: Read, Write, Bash, Glob
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# SetupDocStructure (a-001)
|
|
9
|
+
|
|
10
|
+
## 目的
|
|
11
|
+
|
|
12
|
+
- プロジェクトルートに標準化されたドキュメントディレクトリ構造を作成する。
|
|
13
|
+
- `docs/README.md` を作成し、ドキュメント構成と更新方針を明文化する。
|
|
14
|
+
|
|
15
|
+
## 前提
|
|
16
|
+
|
|
17
|
+
- プロジェクトのルートディレクトリへの書き込み権限があること
|
|
18
|
+
- `docs/` ディレクトリが存在しない、または既存の構造を拡張したいこと
|
|
19
|
+
|
|
20
|
+
## 手順
|
|
21
|
+
|
|
22
|
+
### 1. ディレクトリ構造の作成
|
|
23
|
+
|
|
24
|
+
次のディレクトリを作成する(`mkdir -p` なので既存の場合は不足分のみ追加される)。
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
mkdir -p docs/project/01-requirements docs/project/02-behavior docs/project/03-domain docs/project/04-design docs/tasks
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
続いて `docs/README.md` を作成する。内容は [reference/directory-structure.md](reference/directory-structure.md#docsreadmemd-テンプレート) の「docs/README.md テンプレート」をそのまま Write する。`docs/README.md` が既に存在する場合は、上書き前にユーザーへ確認する。
|
|
31
|
+
|
|
32
|
+
### 2. 結果の確認
|
|
33
|
+
|
|
34
|
+
ディレクトリ構造と `docs/README.md` が期待どおり生成されていることを確認。生成構造と各ディレクトリの用途は [reference/directory-structure.md](reference/directory-structure.md#生成されるディレクトリ構造) を参照。
|
|
35
|
+
|
|
36
|
+
### 3. Git への追加(オプション)
|
|
37
|
+
|
|
38
|
+
ユーザーに確認し、「はい」なら:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
git add docs/
|
|
42
|
+
git status
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
推奨コミットメッセージは [reference/directory-structure.md](reference/directory-structure.md#git-追加時の推奨コミットメッセージ) を参照。
|
|
46
|
+
|
|
47
|
+
### 4. 完了条件の確認
|
|
48
|
+
|
|
49
|
+
- [ ] `docs/` ディレクトリ構造が正しく作成されている
|
|
50
|
+
- [ ] `docs/README.md` が作成されている
|
|
51
|
+
|
|
52
|
+
## 完了条件
|
|
53
|
+
|
|
54
|
+
- プロジェクトルートに `docs/` ディレクトリが作成されている
|
|
55
|
+
- `docs/project/` 配下に `01-requirements/`, `02-behavior/`, `03-domain/`, `04-design/` が存在する
|
|
56
|
+
- `docs/tasks/` ディレクトリが存在する
|
|
57
|
+
- `docs/README.md` が作成されている
|
|
58
|
+
- ユーザーに作成結果が報告されている
|
|
59
|
+
|
|
60
|
+
## エスカレーション
|
|
61
|
+
|
|
62
|
+
- **既存の `docs/` が存在し重要ファイルを含む**: 「既存のドキュメント構造が検出されました。上書きや削除のリスクがあるため、手動で確認してください。」と警告し処理を中断
|
|
63
|
+
- **権限エラー**: 「ディレクトリの作成に失敗しました。書き込み権限を確認してください。」
|
|
64
|
+
- **Git リポジトリでない**: 「このディレクトリは Git リポジトリではありません。必要なら `git init` を実行してください。」
|
|
65
|
+
|
|
66
|
+
## 参考
|
|
67
|
+
|
|
68
|
+
- [reference/directory-structure.md](reference/directory-structure.md) — 生成構造、各ディレクトリの用途、スクリプト詳細、推奨コミットメッセージ
|
|
@@ -1,75 +1,75 @@
|
|
|
1
|
-
# docs ディレクトリ構造とコミットメッセージ
|
|
2
|
-
|
|
3
|
-
SKILL.md 手順2〜3で参照する生成構造とコミットメッセージテンプレート。
|
|
4
|
-
|
|
5
|
-
## 生成されるディレクトリ構造
|
|
6
|
-
|
|
7
|
-
```
|
|
8
|
-
docs/
|
|
9
|
-
├── README.md
|
|
10
|
-
├── project/
|
|
11
|
-
│ ├── 01-requirements/
|
|
12
|
-
│ ├── 02-behavior/
|
|
13
|
-
│ ├── 03-domain/
|
|
14
|
-
│ └── 04-design/
|
|
15
|
-
└── tasks/
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
### 各ディレクトリの用途
|
|
19
|
-
|
|
20
|
-
- `project/01-requirements/` —
|
|
21
|
-
- `project/02-behavior/` — 振る舞い定義(
|
|
22
|
-
- `project/03-domain/` — ドメインモデル、ユビキタス言語
|
|
23
|
-
- `project/04-design/` — 画面設計、データモデル、API 仕様、アーキテクチャ等
|
|
24
|
-
- `tasks/` — 個別タスク(`task{ID}-{SLUG}/` 形式)
|
|
25
|
-
|
|
26
|
-
## Git 追加時の推奨コミットメッセージ
|
|
27
|
-
|
|
28
|
-
```
|
|
29
|
-
ドキュメント構造の初期化
|
|
30
|
-
|
|
31
|
-
- 標準的な構造を持つ docs/ ディレクトリを追加
|
|
32
|
-
- ドキュメント構成を説明する docs/README.md を追加
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
## docs/README.md テンプレート
|
|
36
|
-
|
|
37
|
-
SKILL.md 手順1で `docs/README.md` として Write する内容。
|
|
38
|
-
|
|
39
|
-
```markdown
|
|
40
|
-
# プロジェクトドキュメント
|
|
41
|
-
|
|
42
|
-
このディレクトリには、プロジェクト全体のドキュメントと個別タスクのドキュメントを管理します。
|
|
43
|
-
|
|
44
|
-
## 構成
|
|
45
|
-
|
|
46
|
-
### project/
|
|
47
|
-
プロジェクト全体のドキュメント。要件定義、設計、アーキテクチャなど、プロジェクトスコープ全体に関わる情報を記載します。
|
|
48
|
-
|
|
49
|
-
- **01-requirements/**:
|
|
50
|
-
- **02-behavior/**:
|
|
51
|
-
- **03-domain/**: ドメインモデル(エンティティ、用語集など)
|
|
52
|
-
- **04-design/**: 設計(アーキテクチャ、データモデル、API仕様など)
|
|
53
|
-
|
|
54
|
-
### tasks/
|
|
55
|
-
個別タスクのドキュメント。Issue やチケット単位で作成します。
|
|
56
|
-
|
|
57
|
-
## 更新方針
|
|
58
|
-
|
|
59
|
-
### プロジェクト全体のドキュメント (project/)
|
|
60
|
-
- プロジェクトのスコープ全体に影響する情報を記載
|
|
61
|
-
- チーム全体で共有すべき要件・設計・アーキテクチャを管理
|
|
62
|
-
- 更新時は関係者にレビューを依頼
|
|
63
|
-
|
|
64
|
-
### 個別タスクのドキュメント (tasks/)
|
|
65
|
-
- 特定の Issue やチケットに紐づく情報を記載
|
|
66
|
-
- タスク単位で作成・完了・アーカイブ
|
|
67
|
-
- 完了後は参照資料として保持、または削除
|
|
68
|
-
|
|
69
|
-
## ドキュメント作成ガイドライン
|
|
70
|
-
|
|
71
|
-
- **具体的**: 抽象的な表現を避け、数値・期限・制約を明確に記載
|
|
72
|
-
- **測定可能**: 成功基準やパフォーマンス目標を定量化
|
|
73
|
-
- **最新**: 変更があれば速やかに更新し、古い情報を残さない
|
|
74
|
-
- **簡潔**: 必要最低限の情報に絞り、詳細はコードやリンク先に委ねる
|
|
75
|
-
```
|
|
1
|
+
# docs ディレクトリ構造とコミットメッセージ
|
|
2
|
+
|
|
3
|
+
SKILL.md 手順2〜3で参照する生成構造とコミットメッセージテンプレート。
|
|
4
|
+
|
|
5
|
+
## 生成されるディレクトリ構造
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
docs/
|
|
9
|
+
├── README.md
|
|
10
|
+
├── project/
|
|
11
|
+
│ ├── 01-requirements/
|
|
12
|
+
│ ├── 02-behavior/
|
|
13
|
+
│ ├── 03-domain/
|
|
14
|
+
│ └── 04-design/
|
|
15
|
+
└── tasks/
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
### 各ディレクトリの用途
|
|
19
|
+
|
|
20
|
+
- `project/01-requirements/` — 要件定義(Product Brief、MVP スコープ、Parking Lot、ユーザーストーリー。詳細な非機能要件は設計フェーズ/a-014 で扱う)
|
|
21
|
+
- `project/02-behavior/` — 振る舞い定義(Core Scenarios)
|
|
22
|
+
- `project/03-domain/` — ドメインモデル、ユビキタス言語
|
|
23
|
+
- `project/04-design/` — 画面設計、データモデル、API 仕様、アーキテクチャ等
|
|
24
|
+
- `tasks/` — 個別タスク(`task{ID}-{SLUG}/` 形式)
|
|
25
|
+
|
|
26
|
+
## Git 追加時の推奨コミットメッセージ
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
ドキュメント構造の初期化
|
|
30
|
+
|
|
31
|
+
- 標準的な構造を持つ docs/ ディレクトリを追加
|
|
32
|
+
- ドキュメント構成を説明する docs/README.md を追加
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## docs/README.md テンプレート
|
|
36
|
+
|
|
37
|
+
SKILL.md 手順1で `docs/README.md` として Write する内容。
|
|
38
|
+
|
|
39
|
+
```markdown
|
|
40
|
+
# プロジェクトドキュメント
|
|
41
|
+
|
|
42
|
+
このディレクトリには、プロジェクト全体のドキュメントと個別タスクのドキュメントを管理します。
|
|
43
|
+
|
|
44
|
+
## 構成
|
|
45
|
+
|
|
46
|
+
### project/
|
|
47
|
+
プロジェクト全体のドキュメント。要件定義、設計、アーキテクチャなど、プロジェクトスコープ全体に関わる情報を記載します。
|
|
48
|
+
|
|
49
|
+
- **01-requirements/**: 要件定義(Product Brief、MVP スコープ、Parking Lot、ユーザーストーリーなど。詳細な非機能要件は設計フェーズ/a-014 で扱う)
|
|
50
|
+
- **02-behavior/**: 振る舞い定義(Core Scenarios、ユースケース、ユーザージャーニーなど)
|
|
51
|
+
- **03-domain/**: ドメインモデル(エンティティ、用語集など)
|
|
52
|
+
- **04-design/**: 設計(アーキテクチャ、データモデル、API仕様など)
|
|
53
|
+
|
|
54
|
+
### tasks/
|
|
55
|
+
個別タスクのドキュメント。Issue やチケット単位で作成します。
|
|
56
|
+
|
|
57
|
+
## 更新方針
|
|
58
|
+
|
|
59
|
+
### プロジェクト全体のドキュメント (project/)
|
|
60
|
+
- プロジェクトのスコープ全体に影響する情報を記載
|
|
61
|
+
- チーム全体で共有すべき要件・設計・アーキテクチャを管理
|
|
62
|
+
- 更新時は関係者にレビューを依頼
|
|
63
|
+
|
|
64
|
+
### 個別タスクのドキュメント (tasks/)
|
|
65
|
+
- 特定の Issue やチケットに紐づく情報を記載
|
|
66
|
+
- タスク単位で作成・完了・アーカイブ
|
|
67
|
+
- 完了後は参照資料として保持、または削除
|
|
68
|
+
|
|
69
|
+
## ドキュメント作成ガイドライン
|
|
70
|
+
|
|
71
|
+
- **具体的**: 抽象的な表現を避け、数値・期限・制約を明確に記載
|
|
72
|
+
- **測定可能**: 成功基準やパフォーマンス目標を定量化
|
|
73
|
+
- **最新**: 変更があれば速やかに更新し、古い情報を残さない
|
|
74
|
+
- **簡潔**: 必要最低限の情報に絞り、詳細はコードやリンク先に委ねる
|
|
75
|
+
```
|