id3-cli 0.9.1
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/README.ja-JP.md +769 -0
- package/README.ko-KR.md +769 -0
- package/README.md +769 -0
- package/README.tr-TR.md +769 -0
- package/README.zh-CN.md +769 -0
- package/dist/bin/cli.d.ts +2 -0
- package/dist/bin/cli.js +40 -0
- package/dist/bin/cli.js.map +1 -0
- package/dist/scripts/build-hooks.d.ts +1 -0
- package/dist/scripts/build-hooks.js +58 -0
- package/dist/scripts/build-hooks.js.map +1 -0
- package/dist/src/hooks/auto-audit.d.ts +4 -0
- package/dist/src/hooks/auto-audit.js +47 -0
- package/dist/src/hooks/auto-audit.js.map +1 -0
- package/dist/src/hooks/claude-pretool-entry.d.ts +1 -0
- package/dist/src/hooks/claude-pretool-entry.js +36 -0
- package/dist/src/hooks/claude-pretool-entry.js.map +1 -0
- package/dist/src/hooks/claude-stop-entry.d.ts +1 -0
- package/dist/src/hooks/claude-stop-entry.js +7 -0
- package/dist/src/hooks/claude-stop-entry.js.map +1 -0
- package/dist/src/hooks/post-commit-entry.d.ts +1 -0
- package/dist/src/hooks/post-commit-entry.js +7 -0
- package/dist/src/hooks/post-commit-entry.js.map +1 -0
- package/dist/src/hooks/pre-commit-entry.d.ts +1 -0
- package/dist/src/hooks/pre-commit-entry.js +16 -0
- package/dist/src/hooks/pre-commit-entry.js.map +1 -0
- package/dist/src/hooks/rule-check.d.ts +8 -0
- package/dist/src/hooks/rule-check.js +101 -0
- package/dist/src/hooks/rule-check.js.map +1 -0
- package/dist/src/hooks/schema-drift.d.ts +17 -0
- package/dist/src/hooks/schema-drift.js +151 -0
- package/dist/src/hooks/schema-drift.js.map +1 -0
- package/dist/src/hooks/shared.d.ts +43 -0
- package/dist/src/hooks/shared.js +98 -0
- package/dist/src/hooks/shared.js.map +1 -0
- package/dist/src/init.d.ts +20 -0
- package/dist/src/init.js +193 -0
- package/dist/src/init.js.map +1 -0
- package/dist/src/preview/mockup-generator.d.ts +56 -0
- package/dist/src/preview/mockup-generator.js +402 -0
- package/dist/src/preview/mockup-generator.js.map +1 -0
- package/dist/src/preview/renderer.d.ts +30 -0
- package/dist/src/preview/renderer.js +145 -0
- package/dist/src/preview/renderer.js.map +1 -0
- package/dist/src/preview/server.d.ts +9 -0
- package/dist/src/preview/server.js +55 -0
- package/dist/src/preview/server.js.map +1 -0
- package/dist/src/preview/ui-auditor.d.ts +27 -0
- package/dist/src/preview/ui-auditor.js +141 -0
- package/dist/src/preview/ui-auditor.js.map +1 -0
- package/dist/src/preview/ui-gate.d.ts +66 -0
- package/dist/src/preview/ui-gate.js +210 -0
- package/dist/src/preview/ui-gate.js.map +1 -0
- package/dist/src/utils/ascii.d.ts +7 -0
- package/dist/src/utils/ascii.js +41 -0
- package/dist/src/utils/ascii.js.map +1 -0
- package/dist/src/utils/fs.d.ts +6 -0
- package/dist/src/utils/fs.js +39 -0
- package/dist/src/utils/fs.js.map +1 -0
- package/dist/templates/hooks/iddd-auto-audit.js +121 -0
- package/dist/templates/hooks/iddd-schema-drift.js +279 -0
- package/dist/templates/hooks/post-commit +121 -0
- package/dist/templates/hooks/pre-commit +348 -0
- package/package.json +37 -0
- package/templates/.agents/skills/.gitkeep +0 -0
- package/templates/.claude/hooks/.gitkeep +0 -0
- package/templates/.claude/hooks/hook-config.json +34 -0
- package/templates/.claude/skills/.gitkeep +0 -0
- package/templates/.codex/.gitkeep +0 -0
- package/templates/.codex/hooks.json +40 -0
- package/templates/.iddd/commit-count +1 -0
- package/templates/.iddd/preview/.gitkeep +0 -0
- package/templates/AGENTS.md +204 -0
- package/templates/CLAUDE.md +215 -0
- package/templates/README.md +476 -0
- package/templates/docs/.gitkeep +0 -0
- package/templates/docs/business-rules.md +14 -0
- package/templates/docs/domain-glossary.md +8 -0
- package/templates/docs/info-debt.md +17 -0
- package/templates/docs/model-changelog.md +12 -0
- package/templates/hooks/.gitkeep +0 -0
- package/templates/hooks/iddd-auto-audit.js +121 -0
- package/templates/hooks/iddd-schema-drift.js +279 -0
- package/templates/hooks/post-commit +121 -0
- package/templates/hooks/pre-commit +348 -0
- package/templates/skills/id3-design-information/SKILL.md +170 -0
- package/templates/skills/id3-design-information/references/phase2-procedure.md +241 -0
- package/templates/skills/id3-design-ui/.gitkeep +0 -0
- package/templates/skills/id3-design-ui/SKILL.md +200 -0
- package/templates/skills/id3-design-ui/references/.gitkeep +0 -0
- package/templates/skills/id3-design-ui/references/step1-structure-derivation.md +177 -0
- package/templates/skills/id3-design-ui/references/step2-visual-contract.md +257 -0
- package/templates/skills/id3-design-ui/references/step3-gate-and-mockup.md +177 -0
- package/templates/skills/id3-design-ui/references/step4-implementation.md +244 -0
- package/templates/skills/id3-identify-entities/SKILL.md +239 -0
- package/templates/skills/id3-identify-entities/references/.gitkeep +0 -0
- package/templates/skills/id3-identify-entities/references/phase0-brownfield.md +377 -0
- package/templates/skills/id3-identify-entities/references/phase1-greenfield.md +319 -0
- package/templates/skills/id3-info-audit/.gitkeep +0 -0
- package/templates/skills/id3-info-audit/SKILL.md +191 -0
- package/templates/skills/id3-preview/.gitkeep +0 -0
- package/templates/skills/id3-preview/SKILL.md +168 -0
- package/templates/skills/id3-spawn-team/.gitkeep +0 -0
- package/templates/skills/id3-spawn-team/SKILL.md +213 -0
- package/templates/specs/.gitkeep +0 -0
- package/templates/specs/data-model.md +26 -0
- package/templates/specs/entity-catalog.md +22 -0
- package/templates/specs/ui-design-contract.md +54 -0
- package/templates/specs/ui-inventory.md +24 -0
- package/templates/specs/ui-structure.md +32 -0
- package/templates/src/.gitkeep +0 -0
- package/templates/steering/.gitkeep +0 -0
- package/templates/steering/data-conventions.md +42 -0
- package/templates/steering/product.md +38 -0
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: id3-spawn-team
|
|
3
|
+
description: >
|
|
4
|
+
Spawn an Agent Team (Phase 3-5) to parallelize spec generation, implementation,
|
|
5
|
+
and QA review based on the information model. Reads entity-catalog.md and
|
|
6
|
+
data-model.md to auto-generate entity-level tasks with FK dependency ordering.
|
|
7
|
+
Trigger: spawn team, agent team, phase 3, implement entities, parallel implementation,
|
|
8
|
+
start implementation, build from model
|
|
9
|
+
allowed-tools: Read, Glob, Grep, Bash, Write, Edit
|
|
10
|
+
user-invocable: true
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Phase 3-5: Spawn Agent Team
|
|
14
|
+
|
|
15
|
+
You are the lead agent spawning an Agent Team for IDDD Phase 3 through 5. This skill reads the finalized information model and orchestrates parallel spec generation, implementation, and QA review across team members.
|
|
16
|
+
|
|
17
|
+
**IMPORTANT: Use Agent Teams, NOT subagents.** Each team member operates in an independent context with its own worktree.
|
|
18
|
+
|
|
19
|
+
## Prerequisites
|
|
20
|
+
|
|
21
|
+
Before spawning the team, verify ALL of the following:
|
|
22
|
+
|
|
23
|
+
1. `specs/entity-catalog.md` exists and contains identified entities.
|
|
24
|
+
2. `specs/data-model.md` exists with a finalized Mermaid ERD.
|
|
25
|
+
3. Phase 2 is complete (entity-catalog.md frontmatter shows `phase: "Phase 2 Complete"` and `version: "1.0"` or higher).
|
|
26
|
+
4. `docs/business-rules.md` exists with derived rules (BR-xxx).
|
|
27
|
+
5. `steering/data-conventions.md` exists with project conventions.
|
|
28
|
+
|
|
29
|
+
If prerequisites are **not** met, respond:
|
|
30
|
+
|
|
31
|
+
> "Phase 2 must be completed before spawning an Agent Team. Use 'design information' to run Phase 2 first."
|
|
32
|
+
|
|
33
|
+
Do **not** proceed until all prerequisites are confirmed.
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## Team Composition
|
|
38
|
+
|
|
39
|
+
Spawn exactly **3 team members** with the following roles:
|
|
40
|
+
|
|
41
|
+
### 1. spec-generator
|
|
42
|
+
|
|
43
|
+
**Role:** Transform the information model into implementation-ready specifications.
|
|
44
|
+
|
|
45
|
+
**Reference files (must be provided as context when spawning):**
|
|
46
|
+
- `specs/entity-catalog.md`
|
|
47
|
+
- `specs/data-model.md`
|
|
48
|
+
- `specs/ui-structure.md`
|
|
49
|
+
- `specs/ui-design-contract.md`
|
|
50
|
+
- `specs/ui-inventory.md`
|
|
51
|
+
- `docs/business-rules.md`
|
|
52
|
+
- `steering/data-conventions.md`
|
|
53
|
+
|
|
54
|
+
**Responsibilities:**
|
|
55
|
+
- Generate `requirements.md` per entity or feature group, derived directly from entity-catalog.md attributes, relationships, and business rules.
|
|
56
|
+
- Generate `api-contracts.md` with endpoint definitions, request/response schemas, and validation rules derived from the information model.
|
|
57
|
+
- Ensure every requirement traces back to a specific entity, attribute, or business rule (BR-xxx).
|
|
58
|
+
- Flag any ambiguity or missing information back to the lead agent rather than making assumptions.
|
|
59
|
+
|
|
60
|
+
**Work principles:**
|
|
61
|
+
- Every spec line must reference an entity-catalog.md entry or a BR-xxx rule.
|
|
62
|
+
- Do not invent requirements that are not grounded in the information model.
|
|
63
|
+
- Use data-conventions.md for naming, typing, and structural decisions.
|
|
64
|
+
|
|
65
|
+
### 2. implementer
|
|
66
|
+
|
|
67
|
+
**Role:** Implement code based on specs produced by spec-generator.
|
|
68
|
+
|
|
69
|
+
**Reference files (must be provided as context when spawning):**
|
|
70
|
+
- `specs/entity-catalog.md`
|
|
71
|
+
- `specs/data-model.md`
|
|
72
|
+
- `specs/ui-structure.md`
|
|
73
|
+
- `specs/ui-design-contract.md`
|
|
74
|
+
- `specs/ui-inventory.md`
|
|
75
|
+
- `docs/business-rules.md`
|
|
76
|
+
- `steering/data-conventions.md`
|
|
77
|
+
- spec-generator output (requirements.md, api-contracts.md)
|
|
78
|
+
|
|
79
|
+
**Responsibilities:**
|
|
80
|
+
- Implement entity models, migrations, API endpoints, and validation logic.
|
|
81
|
+
- Commit per entity (one entity per commit, with descriptive commit messages referencing the entity name).
|
|
82
|
+
- Follow the project's tech stack and conventions.
|
|
83
|
+
- Ensure every business rule (BR-xxx) is enforced at the specified enforcement location (DB constraint, application logic, or both).
|
|
84
|
+
|
|
85
|
+
**Work principles:**
|
|
86
|
+
- Never modify `specs/` or `docs/` files. Implementation follows the spec, not the other way around.
|
|
87
|
+
- If implementation reveals a spec gap, message the qa-reviewer and spec-generator rather than improvising.
|
|
88
|
+
- Each commit must be atomic: one entity's model + migration + API + validation + tests.
|
|
89
|
+
|
|
90
|
+
### 3. qa-reviewer
|
|
91
|
+
|
|
92
|
+
**Role:** Verify implementation against the information model. Act as the quality gate.
|
|
93
|
+
|
|
94
|
+
**Reference files (must be provided as context when spawning):**
|
|
95
|
+
- `specs/entity-catalog.md`
|
|
96
|
+
- `specs/ui-structure.md`
|
|
97
|
+
- `specs/ui-design-contract.md`
|
|
98
|
+
- `docs/business-rules.md`
|
|
99
|
+
|
|
100
|
+
**Responsibilities:**
|
|
101
|
+
- Review each entity implementation against entity-catalog.md: all attributes present, correct types, correct constraints.
|
|
102
|
+
- Verify all business rules (BR-xxx) are enforced at the correct location.
|
|
103
|
+
- Verify relationship implementations match the ERD (FK placement, delete rules, cardinality).
|
|
104
|
+
- Check UI implementations against ui-structure.md and ui-design-contract.md.
|
|
105
|
+
- If a review fails, message the implementer directly with specific findings and the exact spec reference that was violated.
|
|
106
|
+
|
|
107
|
+
**Work principles:**
|
|
108
|
+
- Every review finding must cite the specific spec entry (entity name, attribute, BR-xxx) that is violated.
|
|
109
|
+
- Approve only when implementation matches the information model exactly.
|
|
110
|
+
- Track review status per entity: PASS, FAIL (with reasons), or BLOCKED (missing dependency).
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## Task Generation Rules
|
|
115
|
+
|
|
116
|
+
### Entity-Level Task Decomposition
|
|
117
|
+
|
|
118
|
+
1. **Read `specs/entity-catalog.md`** to extract the full entity list.
|
|
119
|
+
2. **Create one task per entity.** Each task includes: model definition, migration, API endpoints, validation, and tests for that entity.
|
|
120
|
+
3. **Analyze FK dependencies** from `specs/data-model.md`:
|
|
121
|
+
- Entities with no FK dependencies on other project entities are **independent** and can be worked on in parallel.
|
|
122
|
+
- Entities with FK references to other entities are **dependent** and must wait for their parent entities to be completed first.
|
|
123
|
+
4. **Build a dependency graph** and determine the execution order:
|
|
124
|
+
- Wave 1: All independent entities (no FK to other project entities).
|
|
125
|
+
- Wave 2: Entities depending only on Wave 1 entities.
|
|
126
|
+
- Wave N: Entities depending on entities from previous waves.
|
|
127
|
+
5. **Within each wave**, tasks run in parallel across team members.
|
|
128
|
+
|
|
129
|
+
### Task Assignment Flow
|
|
130
|
+
|
|
131
|
+
```
|
|
132
|
+
Lead Agent
|
|
133
|
+
│
|
|
134
|
+
├── Parse entity-catalog.md → entity list
|
|
135
|
+
├── Parse data-model.md → FK dependency graph
|
|
136
|
+
├── Topological sort → execution waves
|
|
137
|
+
│
|
|
138
|
+
├── Wave 1 (independent entities):
|
|
139
|
+
│ ├── spec-generator: generate specs for wave 1 entities
|
|
140
|
+
│ ├── implementer: implement (after specs ready)
|
|
141
|
+
│ └── qa-reviewer: review (after implementation ready)
|
|
142
|
+
│
|
|
143
|
+
├── Wave 2 (depends on wave 1):
|
|
144
|
+
│ ├── spec-generator: generate specs for wave 2 entities
|
|
145
|
+
│ ├── implementer: implement (after specs ready)
|
|
146
|
+
│ └── qa-reviewer: review (after implementation ready)
|
|
147
|
+
│
|
|
148
|
+
└── ... repeat for subsequent waves
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### Context Files for All Team Members
|
|
152
|
+
|
|
153
|
+
When spawning each team member, include these 7 files as mandatory context:
|
|
154
|
+
|
|
155
|
+
1. `specs/entity-catalog.md`
|
|
156
|
+
2. `specs/data-model.md`
|
|
157
|
+
3. `specs/ui-structure.md`
|
|
158
|
+
4. `specs/ui-design-contract.md`
|
|
159
|
+
5. `docs/business-rules.md`
|
|
160
|
+
6. `steering/data-conventions.md`
|
|
161
|
+
7. `CLAUDE.md` (or `AGENTS.md` for Codex)
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## Lead Agent Responsibilities
|
|
166
|
+
|
|
167
|
+
As the lead agent, you do **not** write code or specs yourself. Your role is:
|
|
168
|
+
|
|
169
|
+
1. **Task distribution:** Assign clear, entity-scoped tasks to team members.
|
|
170
|
+
2. **Progress tracking:** Monitor each team member's progress per entity.
|
|
171
|
+
3. **Quality review:** Review qa-reviewer findings and escalate unresolved issues.
|
|
172
|
+
4. **Feedback:** Provide specific, actionable feedback when work does not meet spec.
|
|
173
|
+
5. **Final integration:** Verify that all entities are implemented, reviewed, and passing before marking the phase complete.
|
|
174
|
+
|
|
175
|
+
---
|
|
176
|
+
|
|
177
|
+
## Codex Multi-Agent Workflow
|
|
178
|
+
|
|
179
|
+
When running on Codex (detected by the presence of `AGENTS.md` and `.codex/` directory), the multi-agent workflow uses the Agents SDK handoff pattern instead of Agent Teams:
|
|
180
|
+
|
|
181
|
+
- **Project Manager agent** reads entity-catalog.md, builds the dependency graph, and coordinates handoffs.
|
|
182
|
+
- **spec-generator agent** receives entity assignments and produces specs.
|
|
183
|
+
- **implementer agent** receives specs and produces code.
|
|
184
|
+
- **qa-reviewer agent** receives implementations and produces review verdicts.
|
|
185
|
+
|
|
186
|
+
The roles, responsibilities, and task generation rules are identical to the Claude Code Agent Teams workflow above. Only the orchestration mechanism differs.
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
190
|
+
## Completion
|
|
191
|
+
|
|
192
|
+
When all entities have been implemented and passed QA review:
|
|
193
|
+
|
|
194
|
+
1. Update `specs/entity-catalog.md` and `specs/data-model.md` frontmatter:
|
|
195
|
+
```yaml
|
|
196
|
+
version: "1.x" # increment minor version
|
|
197
|
+
last_verified: "YYYY-MM-DD"
|
|
198
|
+
phase: "Phase 3-5 Complete"
|
|
199
|
+
audit_status: "clean"
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
2. Add an entry to `docs/model-changelog.md`:
|
|
203
|
+
```markdown
|
|
204
|
+
## [1.x] -- YYYY-MM-DD
|
|
205
|
+
### Phase 3-5 Complete
|
|
206
|
+
- N entities implemented
|
|
207
|
+
- M business rules enforced
|
|
208
|
+
- All QA reviews passed
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
3. Display completion message:
|
|
212
|
+
|
|
213
|
+
> "Agent Team completed Phase 3-5. N entities implemented, M business rules enforced, all QA reviews passed. Run /id3-info-audit for a comprehensive information model audit."
|
|
File without changes
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
---
|
|
2
|
+
version: "0.0"
|
|
3
|
+
last_verified: ""
|
|
4
|
+
phase: "Initialized"
|
|
5
|
+
entity_count: 0
|
|
6
|
+
rule_count: 0
|
|
7
|
+
audit_status: "unverified"
|
|
8
|
+
---
|
|
9
|
+
# Data Model
|
|
10
|
+
|
|
11
|
+
## ER Diagram
|
|
12
|
+
|
|
13
|
+
```mermaid
|
|
14
|
+
erDiagram
|
|
15
|
+
%% Generated in Phase 1
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Index Strategy
|
|
19
|
+
|
|
20
|
+
_(Populated in Phase 2)_
|
|
21
|
+
|
|
22
|
+
## Design Decision Log
|
|
23
|
+
|
|
24
|
+
| Decision ID | Topic | Choice | Rationale | Date |
|
|
25
|
+
|-------------|-------|--------|-----------|------|
|
|
26
|
+
| _(Populated in Phase 2)_ | | | | |
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
version: "0.0"
|
|
3
|
+
last_verified: ""
|
|
4
|
+
phase: "Initialized"
|
|
5
|
+
entity_count: 0
|
|
6
|
+
rule_count: 0
|
|
7
|
+
audit_status: "unverified"
|
|
8
|
+
---
|
|
9
|
+
# Entity Catalog
|
|
10
|
+
|
|
11
|
+
> This file is the project's **Single Source of Truth**.
|
|
12
|
+
> All development artifacts (requirements, APIs, screens, tests) are derived from this document.
|
|
13
|
+
|
|
14
|
+
## Entity Summary
|
|
15
|
+
|
|
16
|
+
| Entity | Description | Status |
|
|
17
|
+
|--------|-------------|--------|
|
|
18
|
+
| _(Populated in Phase 1)_ | | |
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
_(Detailed definitions for each entity will be added below)_
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
---
|
|
2
|
+
version: "0.0"
|
|
3
|
+
framework: ""
|
|
4
|
+
ui_library: ""
|
|
5
|
+
css: ""
|
|
6
|
+
derived_from: ""
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# UI Design Contract
|
|
10
|
+
|
|
11
|
+
> This document defines the visual design contract -- tech stack, design tokens, copywriting standards, and component mappings. Produced during Phase 2.5.
|
|
12
|
+
|
|
13
|
+
## Tech Stack
|
|
14
|
+
|
|
15
|
+
- **Framework:** _(Populated in Phase 2.5)_
|
|
16
|
+
- **UI Library:** _(Populated in Phase 2.5)_
|
|
17
|
+
- **Styling:** _(Populated in Phase 2.5)_
|
|
18
|
+
- **Icons:** _(Populated in Phase 2.5)_
|
|
19
|
+
|
|
20
|
+
## Design Tokens
|
|
21
|
+
|
|
22
|
+
### Spacing
|
|
23
|
+
|
|
24
|
+
| Token | Value | Usage |
|
|
25
|
+
|-------|-------|-------|
|
|
26
|
+
| _(Populated in Phase 2.5)_ | | |
|
|
27
|
+
|
|
28
|
+
### Typography
|
|
29
|
+
|
|
30
|
+
| Token | Size | Weight | Line Height | Usage |
|
|
31
|
+
|-------|------|--------|-------------|-------|
|
|
32
|
+
| _(Populated in Phase 2.5)_ | | | | |
|
|
33
|
+
|
|
34
|
+
### Colors
|
|
35
|
+
|
|
36
|
+
| Token | Light | Dark | Usage |
|
|
37
|
+
|-------|-------|------|-------|
|
|
38
|
+
| _(Populated in Phase 2.5)_ | | | |
|
|
39
|
+
|
|
40
|
+
### Copywriting
|
|
41
|
+
|
|
42
|
+
| Pattern | Template | Example |
|
|
43
|
+
|---------|----------|---------|
|
|
44
|
+
| _(Populated in Phase 2.5)_ | | |
|
|
45
|
+
|
|
46
|
+
## Component Mapping
|
|
47
|
+
|
|
48
|
+
| Widget | Component | Import |
|
|
49
|
+
|--------|-----------|--------|
|
|
50
|
+
| _(Populated in Phase 2.5)_ | | |
|
|
51
|
+
|
|
52
|
+
## Per-Screen Design Spec
|
|
53
|
+
|
|
54
|
+
_(Populated in Phase 2.5)_
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UI Inventory (Current Screen Structure)
|
|
2
|
+
|
|
3
|
+
> For brownfield projects, this captures the analysis of existing UI during Phase 0 (reverse extraction).
|
|
4
|
+
> For greenfield projects, it is normal for this file to be empty.
|
|
5
|
+
|
|
6
|
+
## Screen Inventory
|
|
7
|
+
|
|
8
|
+
| Screen | URL Pattern | Related Entities | UI Pattern | Notes |
|
|
9
|
+
|--------|-------------|------------------|------------|-------|
|
|
10
|
+
| _(Populated in Phase 0)_ | | | | |
|
|
11
|
+
|
|
12
|
+
## Screen–Entity Mapping Matrix
|
|
13
|
+
|
|
14
|
+
| Entity | List View | Detail View | Create Form | Edit Form | Notes |
|
|
15
|
+
|--------|-----------|-------------|-------------|-----------|-------|
|
|
16
|
+
| _(Populated in Phase 0)_ | | | | | |
|
|
17
|
+
|
|
18
|
+
## Unmapped Entities (No UI)
|
|
19
|
+
|
|
20
|
+
_(Populated in Phase 0)_
|
|
21
|
+
|
|
22
|
+
## Unmapped Screens (Entity Unknown)
|
|
23
|
+
|
|
24
|
+
_(Populated in Phase 0)_
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
---
|
|
2
|
+
version: "0.0"
|
|
3
|
+
derived_from: ""
|
|
4
|
+
screen_count: 0
|
|
5
|
+
entity_coverage: ""
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# UI Structure
|
|
9
|
+
|
|
10
|
+
> This document defines the screen inventory and navigation structure, automatically derived from the information model (entity-catalog.md) during Phase 2.5.
|
|
11
|
+
|
|
12
|
+
## Screen Inventory
|
|
13
|
+
|
|
14
|
+
| Screen | URL | Primary Entity | Pattern | Priority | Source |
|
|
15
|
+
|--------|-----|----------------|---------|----------|--------|
|
|
16
|
+
| _(Populated in Phase 2.5)_ | | | | | |
|
|
17
|
+
|
|
18
|
+
## Entity-Screen Traceability Matrix
|
|
19
|
+
|
|
20
|
+
| Entity | List | Detail | Create | Edit | Dashboard | Notes |
|
|
21
|
+
|--------|------|--------|--------|------|-----------|-------|
|
|
22
|
+
| _(Populated in Phase 2.5)_ | | | | | | |
|
|
23
|
+
|
|
24
|
+
## Navigation Structure
|
|
25
|
+
|
|
26
|
+
_(Populated in Phase 2.5 -- Mermaid graph)_
|
|
27
|
+
|
|
28
|
+
## Change Summary (Brownfield)
|
|
29
|
+
|
|
30
|
+
| Type | Entity | Current | Proposed | Reason |
|
|
31
|
+
|------|--------|---------|----------|--------|
|
|
32
|
+
| _(Populated in Phase 2.5 for brownfield projects)_ | | | | |
|
|
File without changes
|
|
File without changes
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Data Conventions
|
|
2
|
+
|
|
3
|
+
> Default rules for data modeling. Modify these to match your project's requirements.
|
|
4
|
+
|
|
5
|
+
## Primary Key Strategy
|
|
6
|
+
|
|
7
|
+
- **Default**: UUID v7 (time-sortable)
|
|
8
|
+
- Auto-increment integer IDs are allowed as an alternative
|
|
9
|
+
- All PKs use the column name `id`
|
|
10
|
+
|
|
11
|
+
## Naming Conventions
|
|
12
|
+
|
|
13
|
+
- **Database columns**: `snake_case`
|
|
14
|
+
- **Code properties**: `camelCase`
|
|
15
|
+
- **Table names**: plural form (e.g., `users`, `order_items`)
|
|
16
|
+
- **Boolean columns**: prefix with `is_` or `has_` (e.g., `is_active`, `has_verified`)
|
|
17
|
+
|
|
18
|
+
## Timestamps
|
|
19
|
+
|
|
20
|
+
- All entities automatically include `created_at` and `updated_at`
|
|
21
|
+
- Stored as `TIMESTAMP WITH TIME ZONE` (UTC)
|
|
22
|
+
|
|
23
|
+
## Soft Delete
|
|
24
|
+
|
|
25
|
+
- Pattern: `deleted_at` column (nullable timestamp)
|
|
26
|
+
- Which entities use soft delete is determined in Phase 2
|
|
27
|
+
|
|
28
|
+
## Indexes
|
|
29
|
+
|
|
30
|
+
- Foreign keys automatically get an index
|
|
31
|
+
- Add additional indexes for frequently searched attributes
|
|
32
|
+
- Composite indexes for common query patterns
|
|
33
|
+
|
|
34
|
+
## ENUM vs Reference Table
|
|
35
|
+
|
|
36
|
+
- **3 or fewer fixed values**: use ENUM type
|
|
37
|
+
- **More than 3 values** or values that may change: use a reference table
|
|
38
|
+
|
|
39
|
+
## JSON Columns
|
|
40
|
+
|
|
41
|
+
- Allowed only for metadata whose structure changes frequently
|
|
42
|
+
- If a JSON field is a search target, normalize it into proper columns
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Product Vision & Scope
|
|
2
|
+
|
|
3
|
+
> Fill in the sections below to define the product context for IDDD.
|
|
4
|
+
> This information guides entity identification and UI design decisions.
|
|
5
|
+
|
|
6
|
+
## Product Name
|
|
7
|
+
|
|
8
|
+
_(Enter your product or project name)_
|
|
9
|
+
|
|
10
|
+
## Vision Statement
|
|
11
|
+
|
|
12
|
+
_(One-paragraph description of what this product aims to achieve)_
|
|
13
|
+
|
|
14
|
+
## Target Users
|
|
15
|
+
|
|
16
|
+
_(Who are the primary users? List user roles/personas)_
|
|
17
|
+
|
|
18
|
+
## Scope
|
|
19
|
+
|
|
20
|
+
### In Scope
|
|
21
|
+
|
|
22
|
+
_(Key features and capabilities included in this project)_
|
|
23
|
+
|
|
24
|
+
### Out of Scope
|
|
25
|
+
|
|
26
|
+
_(What is explicitly excluded from this project)_
|
|
27
|
+
|
|
28
|
+
## Domain Context
|
|
29
|
+
|
|
30
|
+
_(Brief description of the business domain - e.g., e-commerce, healthcare, education)_
|
|
31
|
+
|
|
32
|
+
## Key Constraints
|
|
33
|
+
|
|
34
|
+
_(Technical, business, or regulatory constraints that affect design decisions)_
|
|
35
|
+
|
|
36
|
+
## Existing Systems
|
|
37
|
+
|
|
38
|
+
_(For brownfield projects: list existing systems, databases, or APIs to integrate with)_
|