@mstar-harness/opencode 0.6.12 → 0.6.14
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/harness-agents/architect.md +0 -1
- package/harness-agents/frontend-dev.md +0 -1
- package/harness-agents/fullstack-dev-2.md +0 -1
- package/harness-agents/fullstack-dev.md +0 -1
- package/harness-agents/ops-engineer.md +0 -1
- package/harness-agents/product-manager.md +0 -1
- package/harness-agents/project-manager.md +0 -1
- package/harness-agents/prompt-engineer.md +0 -1
- package/harness-agents/qa-engineer.md +0 -1
- package/harness-agents/qc-specialist-2.md +0 -1
- package/harness-agents/qc-specialist-3.md +0 -1
- package/harness-agents/qc-specialist.md +0 -1
- package/harness-agents/writing-specialist.md +0 -1
- package/harness-skills/mstar-design-md/SKILL.md +143 -0
- package/harness-skills/mstar-design-md/references/completeness-checklist.md +175 -0
- package/harness-skills/mstar-design-md/references/design-md-spec.md +378 -0
- package/harness-skills/mstar-design-md/references/vercel-example.md +138 -0
- package/harness-skills/mstar-design-md/templates/DESIGN.dark.md.template +133 -0
- package/harness-skills/mstar-design-md/templates/DESIGN.md.template +273 -0
- package/harness-skills/mstar-harness-core/SKILL.md +3 -2
- package/harness-skills/mstar-phase-gates/SKILL.md +6 -5
- package/harness-skills/mstar-roles/SKILL.md +5 -4
- package/harness-skills/mstar-roles/references/architect.md +3 -2
- package/harness-skills/mstar-roles/references/frontend-dev.md +2 -2
- package/harness-skills/mstar-roles/references/fullstack-dev-shared.md +1 -1
- package/harness-skills/mstar-roles/references/product-manager.md +1 -1
- package/harness-skills/mstar-roles/references/qa-engineer.md +1 -1
- package/harness-skills/mstar-roles/references/qc-specialist-shared.md +1 -1
- package/package.json +1 -1
|
@@ -3,7 +3,6 @@ name: frontend-dev
|
|
|
3
3
|
description: |-
|
|
4
4
|
前端开发工程师 - 页面/组件/交互/a11y/前端性能。全栈功能里默认前端主责(与 `@fullstack-dev` 分轨);纯 UI 任务首选本角色。
|
|
5
5
|
Frontend Developer - pages/components/interactions/accessibility/frontend performance. This is the default frontend owner in fullstack work (split with `@fullstack-dev`) and the preferred role for pure UI tasks.
|
|
6
|
-
model: inherit
|
|
7
6
|
mode: subagent
|
|
8
7
|
tools:
|
|
9
8
|
write: true
|
|
@@ -3,7 +3,6 @@ name: fullstack-dev-2
|
|
|
3
3
|
description: |-
|
|
4
4
|
全栈开发工程师 - 与 `@fullstack-dev` 并行的第二实现轨(独立模块/API/页面岛)。PM 在 tasks 可并行或加速时指派;须写明模块边界与分支,勿当作闲置备用。
|
|
5
5
|
Fullstack Developer (Track 2) - the second implementation track parallel to `@fullstack-dev` (independent modules/APIs/page islands). PM should assign this role when tasks can run in parallel or when acceleration is needed, with explicit module boundaries and branch ownership.
|
|
6
|
-
model: inherit
|
|
7
6
|
mode: subagent
|
|
8
7
|
tools:
|
|
9
8
|
write: true
|
|
@@ -3,7 +3,6 @@ name: fullstack-dev
|
|
|
3
3
|
description: |-
|
|
4
4
|
全栈开发工程师 - 后端主导的全栈实现(API/业务/数据层)。UI 重或新页面多时由 PM 拆给 `@frontend-dev`;第二并行实现轨用 `@fullstack-dev-2`。Hotfix/单流小改可一人完成。
|
|
5
5
|
Fullstack Developer - backend-led fullstack implementation (API/business/data). PM should split UI-heavy or new-page work to `@frontend-dev`, and use `@fullstack-dev-2` for the second parallel track. One developer can handle hotfixes or small single-stream updates.
|
|
6
|
-
model: inherit
|
|
7
6
|
mode: subagent
|
|
8
7
|
tools:
|
|
9
8
|
write: true
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: mstar-design-md
|
|
3
|
+
description: DESIGN.md design system specification for Morning Star projects. Create, audit, and maintain project-level design tokens (Colors, Typography, Spacing, Elevation, Motion, Shapes, Components, Voice & Content) using Vercel Geist as reference template. Three-level completeness checklist (MVP/Standard/Production) with built-in upgrade placeholders. Supports light/dark dual-theme via DESIGN.md + DESIGN.dark.md sharing same token names with different values. Prepare 阶段由 @architect 主责创建,@product-manager 提供设计需求;@frontend-dev / @fullstack-dev 实现 UI 时消费;@qc-specialist / @qa-engineer 审查 UI 对齐 DESIGN.md。Read when PM assigns DESIGN.md creation in Prepare, initiating a new UI project, @architect defining a design system, implementing styled components, auditing UI against design spec, adding dark theme, or user mentions "DESIGN.md" / "design tokens" / "design system". Phase gate → **mstar-phase-gates**; paths → **mstar-plan-conventions**.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## Load order
|
|
7
|
+
|
|
8
|
+
**Before first Read of this skill: Read `mstar-harness-core` (SKILL.md).** For Prepare phase integration and gate rules, read `mstar-phase-gates`. For plan directory paths (`{HARNESS_DIR}`, `{SPECS_DIR}`), read `mstar-plan-conventions`. On conflict, **`mstar-harness-core` wins**.
|
|
9
|
+
|
|
10
|
+
| 你还可能要 Read | 何时 |
|
|
11
|
+
|-----------------|------|
|
|
12
|
+
| `mstar-phase-gates` | Prepare 阶段判定 gate、何时 DESIGN.md 必须就绪 |
|
|
13
|
+
| `mstar-plan-conventions` | `{HARNESS_DIR}` / `{SPECS_DIR}` 路径解析 |
|
|
14
|
+
| `mstar-roles` | `@architect` / `@product-manager` / `@frontend-dev` / `@qc-specialist` / `@qa-engineer` 角色职责边界 |
|
|
15
|
+
| `mstar-coding-behavior` | 实现角色消费 DESIGN.md 前的通用编码约束 |
|
|
16
|
+
|
|
17
|
+
## Scope (DESIGN.md lifecycle)
|
|
18
|
+
|
|
19
|
+
| Topic | See |
|
|
20
|
+
|-------|-----|
|
|
21
|
+
| Normative spec: section definitions, token naming, light/dark rules | `references/design-md-spec.md` |
|
|
22
|
+
| Three-level completeness checklist (MVP / Standard / Production) | `references/completeness-checklist.md` |
|
|
23
|
+
| Vercel Geist DESIGN.md as annotated reference | `references/vercel-example.md` |
|
|
24
|
+
| Full template with Level 2/3 placeholders | `templates/DESIGN.md.template` |
|
|
25
|
+
| Dark theme template (same token names, different values) | `templates/DESIGN.dark.md.template` |
|
|
26
|
+
|
|
27
|
+
**Out of scope:** rendered UI artifacts (use Open Design MCP `user-open-design`); frontend implementation that consumes DESIGN.md tokens (use `@frontend-dev` / `@fullstack-dev`); QC review verdict rules (→ **`mstar-review-qc`**).
|
|
28
|
+
|
|
29
|
+
## Location
|
|
30
|
+
|
|
31
|
+
- **Primary**: project root `DESIGN.md` (human + agent visible, aligns with `AGENTS.md`)
|
|
32
|
+
- **Dark theme**: project root `DESIGN.dark.md` (same token names, different values)
|
|
33
|
+
- `DESIGN.md` is a **project-level design contract**, not a harness internal artifact. It lives beside `README.md` and `AGENTS.md`.
|
|
34
|
+
|
|
35
|
+
## Role lifecycle
|
|
36
|
+
|
|
37
|
+
### Creator: `@architect` (primary) + `@product-manager` (requirements)
|
|
38
|
+
|
|
39
|
+
`@architect` owns DESIGN.md content — token selection, naming, completeness level decisions. `@product-manager` provides design intent: brand identity, target audience, must-have UI patterns, accessibility requirements.
|
|
40
|
+
|
|
41
|
+
### Orchestrator: `@project-manager`
|
|
42
|
+
|
|
43
|
+
In Prepare phase, PM decides whether the project needs a DESIGN.md. If yes, dispatches to `@architect` with product requirements from `@product-manager`. PM checks DESIGN.md exists and meets the assigned completeness level before `plan(locked)`.
|
|
44
|
+
|
|
45
|
+
### Consumers
|
|
46
|
+
|
|
47
|
+
- `@frontend-dev` / `@fullstack-dev` — read DESIGN.md before implementing styled components; map tokens to CSS/theme variables
|
|
48
|
+
- `@qc-specialist` — verify UI implementation aligns with DESIGN.md tokens
|
|
49
|
+
- `@qa-engineer` — verify visual output matches design spec
|
|
50
|
+
|
|
51
|
+
## Phase gate integration
|
|
52
|
+
|
|
53
|
+
DESIGN.md is a **Prepare-stage artifact** (like spec). It must be created and reviewed before `plan(locked)` for any plan that includes UI work.
|
|
54
|
+
|
|
55
|
+
1. PM includes "DESIGN.md creation/audit" in Prepare tracking checklist when the plan involves UI
|
|
56
|
+
2. `@architect` creates or updates DESIGN.md; `@product-manager` reviews design intent alignment
|
|
57
|
+
3. PM gates on: DESIGN.md exists, meets completeness level declared in plan, `@product-manager` signed off
|
|
58
|
+
|
|
59
|
+
For **hotfix** or plans with no UI changes, DESIGN.md check may be skipped.
|
|
60
|
+
|
|
61
|
+
## Completeness levels
|
|
62
|
+
|
|
63
|
+
DESIGN.md supports three levels, each with built-in upgrade path:
|
|
64
|
+
|
|
65
|
+
1. **Level 1 — MVP** (minimal, prevents guesswork): palette, base typography, spacing scale
|
|
66
|
+
2. **Level 2 — Standard** (consistent components): full token scales, breakpoints, component tokens (Button, Input)
|
|
67
|
+
3. **Level 3 — Production** (complete design system): dual theme, elevation, motion, shapes, component library, voice
|
|
68
|
+
|
|
69
|
+
The template includes all levels; Level 2 and 3 sections are commented out with `<!-- LEVEL2_PLACEHOLDER: ... -->` markers that explain when to activate them. The audit workflow detects these placeholders and can recommend upgrade.
|
|
70
|
+
|
|
71
|
+
Full checklist → `references/completeness-checklist.md`.
|
|
72
|
+
|
|
73
|
+
## Workflows
|
|
74
|
+
|
|
75
|
+
### Workflow 1: Create DESIGN.md (Prepare phase)
|
|
76
|
+
|
|
77
|
+
1. Read `references/design-md-spec.md` for section definitions
|
|
78
|
+
2. Copy `templates/DESIGN.md.template` to `{PROJECT_ROOT}/DESIGN.md`
|
|
79
|
+
3. Interview `@product-manager` for brand colors, typography preferences, must-have patterns
|
|
80
|
+
4. Fill Level 1 sections; leave Level 2/3 as-is (commented placeholders)
|
|
81
|
+
5. If plan requires Level 2+ out of the gate, fill those sections too
|
|
82
|
+
6. Run the completeness audit workflow below to confirm level
|
|
83
|
+
7. Report to PM: path created, level achieved, what's needed for next level
|
|
84
|
+
|
|
85
|
+
### Workflow 2: Audit DESIGN.md completeness
|
|
86
|
+
|
|
87
|
+
1. Read `DESIGN.md` and `DESIGN.dark.md` (if exists)
|
|
88
|
+
2. Load `references/completeness-checklist.md`
|
|
89
|
+
3. Check each checklist item; note gaps
|
|
90
|
+
4. Report:
|
|
91
|
+
- Current completeness level
|
|
92
|
+
- Gaps preventing next level
|
|
93
|
+
- Presence of upgrade placeholders (`LEVEL2_PLACEHOLDER`, `LEVEL3_PLACEHOLDER`)
|
|
94
|
+
- Recommendation: whether to upgrade now or defer
|
|
95
|
+
5. Update DESIGN.md level tag (e.g., `<!-- COMPLETENESS_LEVEL: 1 -->`) if changed
|
|
96
|
+
|
|
97
|
+
### Workflow 3: Add dark theme
|
|
98
|
+
|
|
99
|
+
1. Read existing `DESIGN.md` to extract token names
|
|
100
|
+
2. Copy `templates/DESIGN.dark.md.template` to `{PROJECT_ROOT}/DESIGN.dark.md`
|
|
101
|
+
3. For each token in DESIGN.md, define the dark-theme equivalent value
|
|
102
|
+
4. Preserve same token names; only values change (see `references/design-md-spec.md` § Light/Dark rules)
|
|
103
|
+
5. Audit with Workflow 2 to confirm Level 3 completeness
|
|
104
|
+
|
|
105
|
+
### Workflow 4: Consume DESIGN.md (implementation roles)
|
|
106
|
+
|
|
107
|
+
Before writing styled UI code:
|
|
108
|
+
1. Read `DESIGN.md` (and `DESIGN.dark.md` if exists)
|
|
109
|
+
2. Extract tokens into implementation layer (CSS custom properties, Tailwind config, theme object, etc.)
|
|
110
|
+
3. Follow DESIGN.md Voice & Content rules for copy text
|
|
111
|
+
4. If DESIGN.md is missing or incomplete, report to PM — do not guess tokens
|
|
112
|
+
|
|
113
|
+
## Light/Dark dual-theme rules
|
|
114
|
+
|
|
115
|
+
Dual theme uses **same token names, different values** across two files:
|
|
116
|
+
|
|
117
|
+
```
|
|
118
|
+
DESIGN.md DESIGN.dark.md
|
|
119
|
+
----------- --------------
|
|
120
|
+
gray-100: #fff gray-100: #111
|
|
121
|
+
gray-1000: #000 gray-1000: #eee
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
- Token names are the **SSOT interface** — consumers reference tokens by name, not raw values
|
|
125
|
+
- `references/design-md-spec.md` § Light/Dark rules defines the contract
|
|
126
|
+
|
|
127
|
+
## Open Design integration
|
|
128
|
+
|
|
129
|
+
If `user-open-design` MCP is available:
|
|
130
|
+
- DESIGN.md is the **design intent** (tokens + rules)
|
|
131
|
+
- Open Design manages **rendered artifacts** (HTML/CSS/JSX previews)
|
|
132
|
+
- When DESIGN.md is updated, recommend syncing the Open Design project to reflect new tokens
|
|
133
|
+
- DESIGN.md does not replace Open Design; they are complementary
|
|
134
|
+
|
|
135
|
+
## References
|
|
136
|
+
|
|
137
|
+
- `references/design-md-spec.md` — normative spec: section definitions, token naming conventions, light/dark contract
|
|
138
|
+
- `references/completeness-checklist.md` — three-level audit checklist with detailed criteria per level
|
|
139
|
+
- `references/vercel-example.md` — Vercel Geist DESIGN.md as annotated reference (read when creating from scratch or needing design inspiration)
|
|
140
|
+
|
|
141
|
+
**Templates (this skill):**
|
|
142
|
+
- `templates/DESIGN.md.template` — full template including all Level 1-3 sections with placeholder comments
|
|
143
|
+
- `templates/DESIGN.dark.md.template` — dark theme template with same token names, different values
|
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
# DESIGN.md Completeness Checklist
|
|
2
|
+
|
|
3
|
+
Three-level progressive checklist for evaluating whether a `DESIGN.md` is sufficient to drive agent UI generation. Each level builds on the previous level's requirements.
|
|
4
|
+
|
|
5
|
+
## How to use
|
|
6
|
+
|
|
7
|
+
1. Read `DESIGN.md` (and `DESIGN.dark.md` if exists)
|
|
8
|
+
2. Check each item in the target level (and all lower levels)
|
|
9
|
+
3. An item is **complete** only when concrete values exist — placeholder comments do not count
|
|
10
|
+
4. A `DESIGN.md` is at **Level N** when all items in Level N and below are complete
|
|
11
|
+
5. Record the result in a comment at the top of DESIGN.md:
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
<!-- COMPLETENESS_LEVEL: N — last audited YYYY-MM-DD -->
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Level 1 — MVP (prevents guesswork)
|
|
18
|
+
|
|
19
|
+
The minimum bar for an agent to produce UI without hallucinating colors and typography. Sufficient for early-stage projects, prototypes, and CLI tools with minimal UI.
|
|
20
|
+
|
|
21
|
+
### Checklist
|
|
22
|
+
|
|
23
|
+
- [ ] **Overview** — design system name and aesthetic principles stated
|
|
24
|
+
- [ ] **Colors — Background** — at least one surface color (`background-100`)
|
|
25
|
+
- [ ] **Colors — Text** — at least one text color (`gray-1000` or equivalent)
|
|
26
|
+
- [ ] **Colors — Accent** — at least one accent color for links/actions (`blue*` or brand equivalent)
|
|
27
|
+
- [ ] **Colors — Semantic** — at least one error color (`red*`) and warning color (`amber*`)
|
|
28
|
+
- [ ] **Typography — Body** — at least one body text token with font family, size, weight, line height
|
|
29
|
+
- [ ] **Typography — Heading** — at least one heading token
|
|
30
|
+
- [ ] **Spacing** — base unit declared (4px or 8px) and at least 5 scale steps
|
|
31
|
+
- [ ] **Breakpoints** — at least 2 responsive breakpoints defined
|
|
32
|
+
|
|
33
|
+
### What an agent CAN do at Level 1
|
|
34
|
+
|
|
35
|
+
- Style a basic page with correct brand colors
|
|
36
|
+
- Choose readable typography
|
|
37
|
+
- Apply consistent spacing
|
|
38
|
+
- Make a responsive layout that works on mobile and desktop
|
|
39
|
+
- Signal errors with the correct color
|
|
40
|
+
|
|
41
|
+
### What an agent CANNOT do at Level 1
|
|
42
|
+
|
|
43
|
+
- Build a consistent component library (no component tokens)
|
|
44
|
+
- Apply elevation/shadow correctly (will guess)
|
|
45
|
+
- Use motion responsibly (will guess)
|
|
46
|
+
- Generate dark mode (no DESIGN.dark.md)
|
|
47
|
+
- Apply voice rules to copy text
|
|
48
|
+
|
|
49
|
+
### Verdict
|
|
50
|
+
|
|
51
|
+
- **All 9 items checked → Level 1 complete**
|
|
52
|
+
- **Missing items → below Level 1 (insufficient for agent UI generation)**
|
|
53
|
+
|
|
54
|
+
## Level 2 — Standard (consistent components)
|
|
55
|
+
|
|
56
|
+
Sufficient for building a consistent, polished UI with reusable components. The expected level for production codebases with a frontend.
|
|
57
|
+
|
|
58
|
+
Prerequisite: Level 1 complete.
|
|
59
|
+
|
|
60
|
+
### Checklist
|
|
61
|
+
|
|
62
|
+
- All Level 1 items complete
|
|
63
|
+
- [ ] **Colors — Full background scale** — `background-100` through at least `background-300`
|
|
64
|
+
- [ ] **Colors — Full gray solid scale** — `gray-100` through `gray-1000` (10 steps)
|
|
65
|
+
- [ ] **Colors — Gray alpha scale** — at least `gray-alpha-100` through `gray-alpha-600`
|
|
66
|
+
- [ ] **Colors — All accent scales** — `blue`, `red`, `amber`, `green`, `teal`, `purple`, `pink` with at least `700`/`800`/`900`/`1000` steps each
|
|
67
|
+
- [ ] **Typography — Headings** — at least 3 heading levels (e.g., `heading-32`, `heading-24`, `heading-20`)
|
|
68
|
+
- [ ] **Typography — Labels** — at least one label token
|
|
69
|
+
- [ ] **Typography — Buttons** — at least one button typography token
|
|
70
|
+
- [ ] **Spacing** — full 9-step scale (4, 8, 12, 16, 24, 32, 40, 64, 96px) and three-step rhythm documented
|
|
71
|
+
- [ ] **Breakpoints** — at least 4 breakpoints
|
|
72
|
+
- [ ] **Components — Button** — at least primary and secondary variants with size variants (default 40px, small 32px), plus hover/active/disabled/focus states
|
|
73
|
+
- [ ] **Components — Input** — at least default variant with size variants, plus hover/active/disabled/focus/error states
|
|
74
|
+
|
|
75
|
+
### What an agent CAN do at Level 2
|
|
76
|
+
|
|
77
|
+
- Everything from Level 1
|
|
78
|
+
- Build a consistent Button component with all states
|
|
79
|
+
- Build a consistent Input component with all states
|
|
80
|
+
- Use the full color scale for nuanced visual hierarchy
|
|
81
|
+
- Apply correct typography to every text role
|
|
82
|
+
- Use translucent overlays and borders (alpha scale)
|
|
83
|
+
- Pick the right accent color for each semantic purpose
|
|
84
|
+
|
|
85
|
+
### What an agent CANNOT do at Level 2
|
|
86
|
+
|
|
87
|
+
- Generate dark mode (no DESIGN.dark.md)
|
|
88
|
+
- Apply elevation/shadows with confidence (may guess)
|
|
89
|
+
- Use motion consistently (may guess)
|
|
90
|
+
- Enforce voice rules on copy text
|
|
91
|
+
- Know the correct border radius for each component type
|
|
92
|
+
|
|
93
|
+
### Verdict
|
|
94
|
+
|
|
95
|
+
- **All 11 items checked (on top of Level 1) → Level 2 complete**
|
|
96
|
+
- **1–3 items missing → Level 2 partial; useable but expect component inconsistencies**
|
|
97
|
+
- **4+ items missing → below Level 2; recommend completing Level 1 only deploy**
|
|
98
|
+
|
|
99
|
+
## Level 3 — Production (complete design system)
|
|
100
|
+
|
|
101
|
+
Full design system ready for production at scale. Includes dual theme, motion, and voice.
|
|
102
|
+
|
|
103
|
+
Prerequisite: Level 2 complete.
|
|
104
|
+
|
|
105
|
+
### Checklist
|
|
106
|
+
|
|
107
|
+
- All Level 1 and Level 2 items complete
|
|
108
|
+
- [ ] **DESIGN.dark.md exists** — dark theme file with same token names, dark-appropriate values
|
|
109
|
+
- [ ] **Dark theme covers all tokens** — every token in DESIGN.md has a corresponding entry in DESIGN.dark.md
|
|
110
|
+
- [ ] **Elevation — Shadows** — at least 3 elevation levels (card, popover, modal) with explicit `box-shadow` values
|
|
111
|
+
- [ ] **Motion — Easing** — easing curve declared
|
|
112
|
+
- [ ] **Motion — Durations** — at least state change, popover, modal durations
|
|
113
|
+
- [ ] **Motion — Reduced motion** — `prefers-reduced-motion` rule declared
|
|
114
|
+
- [ ] **Shapes — Border radius** — at least 4 radius tokens (surface/input, menu/modal, fullscreen, pill)
|
|
115
|
+
- [ ] **Components — Full library** — at least Card, Modal, Tooltip, Menu/Dropdown tokens
|
|
116
|
+
- [ ] **Voice & Content** — writing rules documented: casing conventions, action naming, error format, toast format, empty state format
|
|
117
|
+
|
|
118
|
+
### What an agent CAN do at Level 3
|
|
119
|
+
|
|
120
|
+
- Everything from Levels 1 and 2
|
|
121
|
+
- Generate dark-mode-compatible UI
|
|
122
|
+
- Apply elevation correctly for every UI layer
|
|
123
|
+
- Animate state changes consistently
|
|
124
|
+
- Apply correct border radius per element type
|
|
125
|
+
- Write correct microcopy (button labels, errors, toasts, empty states)
|
|
126
|
+
- Build a full component library (Card, Modal, Tooltip, Menu)
|
|
127
|
+
|
|
128
|
+
### Verdict
|
|
129
|
+
|
|
130
|
+
- **All 9 items checked → Level 3 complete (production-ready)**
|
|
131
|
+
- **DESIGN.dark.md missing but rest complete → Level 2+ (partial Level 3, no dark mode)**
|
|
132
|
+
|
|
133
|
+
## Audit workflow
|
|
134
|
+
|
|
135
|
+
### When auditing existing DESIGN.md
|
|
136
|
+
|
|
137
|
+
1. Load the DESIGN.md file
|
|
138
|
+
2. Start at Level 1 checklist — check each item against actual content
|
|
139
|
+
3. If Level 1 complete, proceed to Level 2
|
|
140
|
+
4. If Level 2 complete, proceed to Level 3
|
|
141
|
+
5. Record the level as `<!-- COMPLETENESS_LEVEL: N -->` at top of DESIGN.md
|
|
142
|
+
6. For each incomplete item, note what's missing and which level it belongs to
|
|
143
|
+
7. Check for `LEVEL2_PLACEHOLDER` / `LEVEL3_PLACEHOLDER` markers — if present and the project is ready for upgrade, recommend activation
|
|
144
|
+
|
|
145
|
+
### When creating new DESIGN.md
|
|
146
|
+
|
|
147
|
+
1. Decide target level with PM/architect:
|
|
148
|
+
- Prototype / early project → Level 1
|
|
149
|
+
- Production frontend → Level 2
|
|
150
|
+
- Full design system → Level 3
|
|
151
|
+
2. Copy the template from `templates/DESIGN.md.template`
|
|
152
|
+
3. Fill all items in the target level
|
|
153
|
+
4. Run this checklist to confirm
|
|
154
|
+
5. Leave higher-level placeholders as-is
|
|
155
|
+
|
|
156
|
+
### When upgrading DESIGN.md
|
|
157
|
+
|
|
158
|
+
1. Read current DESIGN.md and note the level tag
|
|
159
|
+
2. Identify which items in the next level are missing
|
|
160
|
+
3. For each missing item, either:
|
|
161
|
+
- Fill with concrete values if known
|
|
162
|
+
- Leave the `LEVEL*_PLACEHOLDER` marker if deferred
|
|
163
|
+
4. Re-audit and update the level tag
|
|
164
|
+
|
|
165
|
+
## Upgrade trigger conditions
|
|
166
|
+
|
|
167
|
+
Agents encountering a DESIGN.md with placeholders should evaluate these conditions:
|
|
168
|
+
|
|
169
|
+
| Condition | Action |
|
|
170
|
+
|-----------|--------|
|
|
171
|
+
| `LEVEL2_PLACEHOLDER` found AND plan includes component work | Recommend completing the Level 2 sections |
|
|
172
|
+
| `LEVEL3_PLACEHOLDER` found AND plan includes dark mode | Recommend creating DESIGN.dark.md |
|
|
173
|
+
| `LEVEL3_PLACEHOLDER` found AND plan targets production release | Recommend completing Level 3 |
|
|
174
|
+
| `COMPLETENESS_LEVEL: 1` AND project has >3 UI views | Recommend upgrading to Level 2 |
|
|
175
|
+
| `COMPLETENESS_LEVEL: 2` AND project has dark mode requirement | Recommend upgrading to Level 3 |
|