@mstar-harness/omp 3.6.0-alpha.4
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.md +63 -0
- package/agents/architect.md +35 -0
- package/agents/code-reviewer.md +90 -0
- package/agents/frontend-dev.md +33 -0
- package/agents/fullstack-dev-2.md +33 -0
- package/agents/fullstack-dev.md +33 -0
- package/agents/ops-engineer.md +33 -0
- package/agents/product-manager.md +35 -0
- package/agents/project-manager.md +32 -0
- package/agents/prompt-engineer.md +33 -0
- package/agents/qa-engineer.md +35 -0
- package/agents/qc-specialist-2.md +62 -0
- package/agents/qc-specialist-3.md +62 -0
- package/agents/qc-specialist.md +62 -0
- package/agents/writing-specialist.md +35 -0
- package/assets/icon.png +0 -0
- package/assets/logo-dark.png +0 -0
- package/assets/logo-dark.svg +6 -0
- package/assets/logo.png +0 -0
- package/assets/logo.svg +6 -0
- package/commands/amazing-pr-review.md +31 -0
- package/commands/codebase-audit.md +40 -0
- package/commands/iteration-drive.md +48 -0
- package/commands/iteration-loop.md +99 -0
- package/commands/iteration-start.md +122 -0
- package/dist/hooks/pre/mstar-gates.js +6579 -0
- package/dist/tools/mstar_dispatch_validate/index.js +6291 -0
- package/dist/tools/mstar_iteration_gate/index.js +6321 -0
- package/dist/tools/mstar_lease_verify/index.js +6343 -0
- package/dist/tools/mstar_path_resolve/index.js +6297 -0
- package/dist/tools/mstar_status_validate/index.js +6402 -0
- package/dist/tools/mstar_worktree_check/index.js +6343 -0
- package/harness-agents/architect.md +35 -0
- package/harness-agents/code-reviewer.md +90 -0
- package/harness-agents/frontend-dev.md +33 -0
- package/harness-agents/fullstack-dev-2.md +33 -0
- package/harness-agents/fullstack-dev.md +33 -0
- package/harness-agents/ops-engineer.md +33 -0
- package/harness-agents/product-manager.md +35 -0
- package/harness-agents/project-manager.md +32 -0
- package/harness-agents/prompt-engineer.md +33 -0
- package/harness-agents/qa-engineer.md +35 -0
- package/harness-agents/qc-specialist-2.md +62 -0
- package/harness-agents/qc-specialist-3.md +62 -0
- package/harness-agents/qc-specialist.md +62 -0
- package/harness-agents/writing-specialist.md +35 -0
- package/harness-commands/amazing-pr-review.md +31 -0
- package/harness-commands/codebase-audit.md +40 -0
- package/harness-commands/iteration-drive.md +48 -0
- package/harness-commands/iteration-loop.md +99 -0
- package/harness-commands/iteration-start.md +122 -0
- package/harness-skills/grill-me/SKILL.md +10 -0
- package/harness-skills/mstar-artifacts/SKILL.md +66 -0
- package/harness-skills/mstar-artifacts/references/knowledge-and-designs.md +110 -0
- package/harness-skills/mstar-artifacts/references/plan-files-and-reports.md +98 -0
- package/harness-skills/mstar-artifacts/references/plan-quality-bar.md +99 -0
- package/harness-skills/mstar-artifacts/references/status-and-residuals.md +472 -0
- package/harness-skills/mstar-artifacts/templates/README.md +7 -0
- package/harness-skills/mstar-artifacts/templates/plan.main.md +54 -0
- package/harness-skills/mstar-artifacts/templates/status.empty.json +5 -0
- package/harness-skills/mstar-audit/SKILL.md +151 -0
- package/harness-skills/mstar-audit/references/audit-playbook.md +175 -0
- package/harness-skills/mstar-audit/references/codebase-audit.md +103 -0
- package/harness-skills/mstar-audit/references/finding-format.md +69 -0
- package/harness-skills/mstar-audit/references/pr-review-seat-evidence.md +28 -0
- package/harness-skills/mstar-audit/references/pr-review.md +475 -0
- package/harness-skills/mstar-audit/references/security-review.md +219 -0
- package/harness-skills/mstar-branch-worktree/SKILL.md +236 -0
- package/harness-skills/mstar-branch-worktree/references/parallel-writable-pre-dispatch.md +68 -0
- package/harness-skills/mstar-coding-behavior/SKILL.md +167 -0
- package/harness-skills/mstar-compound/SKILL.md +109 -0
- package/harness-skills/mstar-compound/assets/resolution-template.md +94 -0
- package/harness-skills/mstar-compound/references/category-mapping.md +37 -0
- package/harness-skills/mstar-compound/references/compound-workflow.md +171 -0
- package/harness-skills/mstar-compound/references/concepts-vocabulary.md +44 -0
- package/harness-skills/mstar-compound/references/schema.yaml +122 -0
- package/harness-skills/mstar-compound-refresh/SKILL.md +154 -0
- package/harness-skills/mstar-compound-refresh/references/project-knowledge-bootstrap.md +164 -0
- package/harness-skills/mstar-conventions/SKILL.md +215 -0
- package/harness-skills/mstar-conventions/references/artifact-storage-paths.md +53 -0
- package/harness-skills/mstar-conventions/references/effort-estimation.md +38 -0
- package/harness-skills/mstar-conventions/references/harness-bootstrap-and-agents-layering.md +96 -0
- package/harness-skills/mstar-design-md/SKILL.md +142 -0
- package/harness-skills/mstar-design-md/references/completeness-checklist.md +181 -0
- package/harness-skills/mstar-design-md/references/design-md-spec.md +508 -0
- package/harness-skills/mstar-design-md/references/vercel-example.md +200 -0
- package/harness-skills/mstar-design-md/templates/DESIGN.dark.md.template +354 -0
- package/harness-skills/mstar-design-md/templates/DESIGN.md.template +474 -0
- package/harness-skills/mstar-dispatch-gates/SKILL.md +134 -0
- package/harness-skills/mstar-dispatch-gates/references/leaf-executor-checklist.md +23 -0
- package/harness-skills/mstar-engine-legacy/SKILL.md +53 -0
- package/harness-skills/mstar-engine-legacy/references/anti-recursion-checklists.md +58 -0
- package/harness-skills/mstar-engine-legacy/references/engine-check-boilerplate.md +26 -0
- package/harness-skills/mstar-engine-legacy/references/lease-protocol.md +92 -0
- package/harness-skills/mstar-engine-legacy/references/qc-seat-n-restatements.md +57 -0
- package/harness-skills/mstar-engine-legacy/references/status-field-history.md +186 -0
- package/harness-skills/mstar-harness-core/SKILL.md +196 -0
- package/harness-skills/mstar-host/SKILL.md +96 -0
- package/harness-skills/mstar-host/references/_shared/host-role-binding-core.md +51 -0
- package/harness-skills/mstar-host/references/_shared/plan-mode-bridge-core.md +91 -0
- package/harness-skills/mstar-host/references/codex.md +61 -0
- package/harness-skills/mstar-host/references/cursor-plan-mode-bridge.md +170 -0
- package/harness-skills/mstar-host/references/cursor.md +183 -0
- package/harness-skills/mstar-host/references/dsh.md +507 -0
- package/harness-skills/mstar-host/references/kimi-plan-mode-bridge.md +36 -0
- package/harness-skills/mstar-host/references/kimi.md +136 -0
- package/harness-skills/mstar-host/references/omp-plan-mode-bridge.md +32 -0
- package/harness-skills/mstar-host/references/omp.md +245 -0
- package/harness-skills/mstar-host/references/opencode.md +76 -0
- package/harness-skills/mstar-host/references/parallel-dispatch.md +68 -0
- package/harness-skills/mstar-host/references/zcode-plan-mode-bridge.md +36 -0
- package/harness-skills/mstar-host/references/zcode.md +129 -0
- package/harness-skills/mstar-iteration/SKILL.md +408 -0
- package/harness-skills/mstar-iteration/references/autonomous-direction-lock.md +90 -0
- package/harness-skills/mstar-iteration/references/command-shared-invariants.md +62 -0
- package/harness-skills/mstar-iteration/references/iteration-artifact-boundaries.md +103 -0
- package/harness-skills/mstar-iteration/references/iteration-compass-template.md +142 -0
- package/harness-skills/mstar-iteration/references/iteration-corpus-hygiene.md +45 -0
- package/harness-skills/mstar-iteration/references/iteration-workspace-readme-template.md +27 -0
- package/harness-skills/mstar-iteration/references/phase-2-worktree-lease.md +205 -0
- package/harness-skills/mstar-iteration/references/phase-3-iteration-close.md +105 -0
- package/harness-skills/mstar-iteration/references/phase-4-5-pr-delivery.md +85 -0
- package/harness-skills/mstar-iteration/references/phase5-helper-discovery.md +24 -0
- package/harness-skills/mstar-phase-gates/SKILL.md +118 -0
- package/harness-skills/mstar-project-governance/SKILL.md +119 -0
- package/harness-skills/mstar-review-qc/SKILL.md +76 -0
- package/harness-skills/mstar-review-qc/references/review-responsibility-boundaries.md +54 -0
- package/harness-skills/mstar-roles/SKILL.md +103 -0
- package/harness-skills/mstar-roles/references/_shared/leaf-executor-core.md +65 -0
- package/harness-skills/mstar-roles/references/architect.md +109 -0
- package/harness-skills/mstar-roles/references/code-reviewer.md +118 -0
- package/harness-skills/mstar-roles/references/frontend-dev.md +70 -0
- package/harness-skills/mstar-roles/references/fullstack-dev-shared.md +89 -0
- package/harness-skills/mstar-roles/references/ops-engineer.md +72 -0
- package/harness-skills/mstar-roles/references/product-manager.md +102 -0
- package/harness-skills/mstar-roles/references/project-manager/dispatch-and-assignment.md +200 -0
- package/harness-skills/mstar-roles/references/project-manager/plan-management.md +59 -0
- package/harness-skills/mstar-roles/references/project-manager/qa-trigger-matrix.md +56 -0
- package/harness-skills/mstar-roles/references/project-manager/qc-and-residuals.md +99 -0
- package/harness-skills/mstar-roles/references/project-manager/routing-and-dev-allocation.md +99 -0
- package/harness-skills/mstar-roles/references/project-manager.md +310 -0
- package/harness-skills/mstar-roles/references/prompt-engineer.md +65 -0
- package/harness-skills/mstar-roles/references/qa-engineer/acceptance-gate.md +62 -0
- package/harness-skills/mstar-roles/references/qa-engineer.md +71 -0
- package/harness-skills/mstar-roles/references/qc-specialist/deep-review-lenses.md +104 -0
- package/harness-skills/mstar-roles/references/qc-specialist/report-template.md +88 -0
- package/harness-skills/mstar-roles/references/qc-specialist/reviewer-checklist.md +44 -0
- package/harness-skills/mstar-roles/references/qc-specialist/reviewer-workflow.md +57 -0
- package/harness-skills/mstar-roles/references/qc-specialist-shared.md +120 -0
- package/harness-skills/mstar-roles/references/writing-specialist.md +88 -0
- package/harness-skills/mstar-sdd/SKILL.md +137 -0
- package/harness-skills/mstar-sdd/references/file-handoffs.md +85 -0
- package/harness-skills/mstar-sdd/references/implementer-continuation-prompt.md +44 -0
- package/harness-skills/mstar-sdd/references/implementer-prompt.md +56 -0
- package/harness-skills/mstar-sdd/references/sticky-implementer-session.md +103 -0
- package/harness-skills/mstar-sdd/references/task-reviewer-prompt.md +53 -0
- package/harness-skills/mstar-skill-authoring/SKILL.md +182 -0
- package/harness-skills/mstar-skill-authoring/references/regression-fixation.md +46 -0
- package/harness-skills/mstar-skill-authoring/references/skillsbench-authoring.md +154 -0
- package/harness-skills/mstar-strategy/SKILL.md +114 -0
- package/harness-skills/pm/SKILL.md +40 -0
- package/hooks/pre/mstar-gates.js +6579 -0
- package/package.json +45 -0
- package/plugin.json +49 -0
- package/skills/grill-me/SKILL.md +10 -0
- package/skills/mstar-artifacts/SKILL.md +66 -0
- package/skills/mstar-artifacts/references/knowledge-and-designs.md +110 -0
- package/skills/mstar-artifacts/references/plan-files-and-reports.md +98 -0
- package/skills/mstar-artifacts/references/plan-quality-bar.md +99 -0
- package/skills/mstar-artifacts/references/status-and-residuals.md +472 -0
- package/skills/mstar-artifacts/templates/README.md +7 -0
- package/skills/mstar-artifacts/templates/plan.main.md +54 -0
- package/skills/mstar-artifacts/templates/status.empty.json +5 -0
- package/skills/mstar-audit/SKILL.md +151 -0
- package/skills/mstar-audit/references/audit-playbook.md +175 -0
- package/skills/mstar-audit/references/codebase-audit.md +103 -0
- package/skills/mstar-audit/references/finding-format.md +69 -0
- package/skills/mstar-audit/references/pr-review-seat-evidence.md +28 -0
- package/skills/mstar-audit/references/pr-review.md +475 -0
- package/skills/mstar-audit/references/security-review.md +219 -0
- package/skills/mstar-branch-worktree/SKILL.md +236 -0
- package/skills/mstar-branch-worktree/references/parallel-writable-pre-dispatch.md +68 -0
- package/skills/mstar-coding-behavior/SKILL.md +167 -0
- package/skills/mstar-compound/SKILL.md +109 -0
- package/skills/mstar-compound/assets/resolution-template.md +94 -0
- package/skills/mstar-compound/references/category-mapping.md +37 -0
- package/skills/mstar-compound/references/compound-workflow.md +171 -0
- package/skills/mstar-compound/references/concepts-vocabulary.md +44 -0
- package/skills/mstar-compound/references/schema.yaml +122 -0
- package/skills/mstar-compound-refresh/SKILL.md +154 -0
- package/skills/mstar-compound-refresh/references/project-knowledge-bootstrap.md +164 -0
- package/skills/mstar-conventions/SKILL.md +215 -0
- package/skills/mstar-conventions/references/artifact-storage-paths.md +53 -0
- package/skills/mstar-conventions/references/effort-estimation.md +38 -0
- package/skills/mstar-conventions/references/harness-bootstrap-and-agents-layering.md +96 -0
- package/skills/mstar-design-md/SKILL.md +142 -0
- package/skills/mstar-design-md/references/completeness-checklist.md +181 -0
- package/skills/mstar-design-md/references/design-md-spec.md +508 -0
- package/skills/mstar-design-md/references/vercel-example.md +200 -0
- package/skills/mstar-design-md/templates/DESIGN.dark.md.template +354 -0
- package/skills/mstar-design-md/templates/DESIGN.md.template +474 -0
- package/skills/mstar-dispatch-gates/SKILL.md +134 -0
- package/skills/mstar-dispatch-gates/references/leaf-executor-checklist.md +23 -0
- package/skills/mstar-engine-legacy/SKILL.md +53 -0
- package/skills/mstar-engine-legacy/references/anti-recursion-checklists.md +58 -0
- package/skills/mstar-engine-legacy/references/engine-check-boilerplate.md +26 -0
- package/skills/mstar-engine-legacy/references/lease-protocol.md +92 -0
- package/skills/mstar-engine-legacy/references/qc-seat-n-restatements.md +57 -0
- package/skills/mstar-engine-legacy/references/status-field-history.md +186 -0
- package/skills/mstar-harness-core/SKILL.md +196 -0
- package/skills/mstar-host/SKILL.md +96 -0
- package/skills/mstar-host/references/_shared/host-role-binding-core.md +51 -0
- package/skills/mstar-host/references/_shared/plan-mode-bridge-core.md +91 -0
- package/skills/mstar-host/references/codex.md +61 -0
- package/skills/mstar-host/references/cursor-plan-mode-bridge.md +170 -0
- package/skills/mstar-host/references/cursor.md +183 -0
- package/skills/mstar-host/references/dsh.md +507 -0
- package/skills/mstar-host/references/kimi-plan-mode-bridge.md +36 -0
- package/skills/mstar-host/references/kimi.md +136 -0
- package/skills/mstar-host/references/omp-plan-mode-bridge.md +32 -0
- package/skills/mstar-host/references/omp.md +245 -0
- package/skills/mstar-host/references/opencode.md +76 -0
- package/skills/mstar-host/references/parallel-dispatch.md +68 -0
- package/skills/mstar-host/references/zcode-plan-mode-bridge.md +36 -0
- package/skills/mstar-host/references/zcode.md +129 -0
- package/skills/mstar-iteration/SKILL.md +408 -0
- package/skills/mstar-iteration/references/autonomous-direction-lock.md +90 -0
- package/skills/mstar-iteration/references/command-shared-invariants.md +62 -0
- package/skills/mstar-iteration/references/iteration-artifact-boundaries.md +103 -0
- package/skills/mstar-iteration/references/iteration-compass-template.md +142 -0
- package/skills/mstar-iteration/references/iteration-corpus-hygiene.md +45 -0
- package/skills/mstar-iteration/references/iteration-workspace-readme-template.md +27 -0
- package/skills/mstar-iteration/references/phase-2-worktree-lease.md +205 -0
- package/skills/mstar-iteration/references/phase-3-iteration-close.md +105 -0
- package/skills/mstar-iteration/references/phase-4-5-pr-delivery.md +85 -0
- package/skills/mstar-iteration/references/phase5-helper-discovery.md +24 -0
- package/skills/mstar-phase-gates/SKILL.md +118 -0
- package/skills/mstar-project-governance/SKILL.md +119 -0
- package/skills/mstar-review-qc/SKILL.md +76 -0
- package/skills/mstar-review-qc/references/review-responsibility-boundaries.md +54 -0
- package/skills/mstar-roles/SKILL.md +103 -0
- package/skills/mstar-roles/references/_shared/leaf-executor-core.md +65 -0
- package/skills/mstar-roles/references/architect.md +109 -0
- package/skills/mstar-roles/references/code-reviewer.md +118 -0
- package/skills/mstar-roles/references/frontend-dev.md +70 -0
- package/skills/mstar-roles/references/fullstack-dev-shared.md +89 -0
- package/skills/mstar-roles/references/ops-engineer.md +72 -0
- package/skills/mstar-roles/references/product-manager.md +102 -0
- package/skills/mstar-roles/references/project-manager/dispatch-and-assignment.md +200 -0
- package/skills/mstar-roles/references/project-manager/plan-management.md +59 -0
- package/skills/mstar-roles/references/project-manager/qa-trigger-matrix.md +56 -0
- package/skills/mstar-roles/references/project-manager/qc-and-residuals.md +99 -0
- package/skills/mstar-roles/references/project-manager/routing-and-dev-allocation.md +99 -0
- package/skills/mstar-roles/references/project-manager.md +310 -0
- package/skills/mstar-roles/references/prompt-engineer.md +65 -0
- package/skills/mstar-roles/references/qa-engineer/acceptance-gate.md +62 -0
- package/skills/mstar-roles/references/qa-engineer.md +71 -0
- package/skills/mstar-roles/references/qc-specialist/deep-review-lenses.md +104 -0
- package/skills/mstar-roles/references/qc-specialist/report-template.md +88 -0
- package/skills/mstar-roles/references/qc-specialist/reviewer-checklist.md +44 -0
- package/skills/mstar-roles/references/qc-specialist/reviewer-workflow.md +57 -0
- package/skills/mstar-roles/references/qc-specialist-shared.md +120 -0
- package/skills/mstar-roles/references/writing-specialist.md +88 -0
- package/skills/mstar-sdd/SKILL.md +137 -0
- package/skills/mstar-sdd/references/file-handoffs.md +85 -0
- package/skills/mstar-sdd/references/implementer-continuation-prompt.md +44 -0
- package/skills/mstar-sdd/references/implementer-prompt.md +56 -0
- package/skills/mstar-sdd/references/sticky-implementer-session.md +103 -0
- package/skills/mstar-sdd/references/task-reviewer-prompt.md +53 -0
- package/skills/mstar-skill-authoring/SKILL.md +182 -0
- package/skills/mstar-skill-authoring/references/regression-fixation.md +46 -0
- package/skills/mstar-skill-authoring/references/skillsbench-authoring.md +154 -0
- package/skills/mstar-strategy/SKILL.md +114 -0
- package/skills/pm/SKILL.md +40 -0
- package/tools/mstar_dispatch_validate.js +6291 -0
- package/tools/mstar_iteration_gate.js +6321 -0
- package/tools/mstar_lease_verify.js +6343 -0
- package/tools/mstar_path_resolve.js +6297 -0
- package/tools/mstar_status_validate.js +6402 -0
- package/tools/mstar_worktree_check.js +6343 -0
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# 产物存储路径(SSOT · 路径符号解析后)
|
|
2
|
+
|
|
3
|
+
> **Authority**: `mstar-conventions` `references/artifact-storage-paths.md`.
|
|
4
|
+
> Symbol definitions (`{HARNESS_DIR}`, `{KNOWLEDGE_DIR}`, `{PLAN_DIR}`, etc.) → `mstar-conventions` SKILL.md § 路径符号。
|
|
5
|
+
> All `mstar-*` skills that produce or operate on files **must** follow this table; do not redefine paths locally.
|
|
6
|
+
|
|
7
|
+
## Harness 子树内(`{HARNESS_DIR}/` 下)
|
|
8
|
+
|
|
9
|
+
这些是 agent handoff 用的结构化产物。**Git 跟踪**遵循 `mstar-conventions` SKILL.md「Git 跟踪策略」:**进程本地、结果共享** — `plans/`、`iterations/`、`status.json`、`workflows/`、`projects/`、`sdd/` 等默认 gitignored;`AGENTS.md`、`knowledge/`、`specs/` 默认 tracked。
|
|
10
|
+
|
|
11
|
+
| 产物 | 解析后路径(默认 `.mstar/`) | 读写的技能 |
|
|
12
|
+
|------|---------------------------|-----------|
|
|
13
|
+
| **知识文档** | `.mstar/knowledge/<category>/<slug>.md` | `mstar-compound`(写)、`mstar-compound-refresh`(读写) |
|
|
14
|
+
| **知识索引** | `.mstar/knowledge/README.md` | `mstar-compound`(写)、`mstar-compound-refresh`(读写) |
|
|
15
|
+
| **主 plan** | `.mstar/plans/<plan-id>-<name>.md`(gitignored;本地会话 SSOT) | PM / `mstar-artifacts` |
|
|
16
|
+
| **Review bundle(QC/QA 原始过程报告)** | `{HARNESS_DIR}/sdd/<plan-id>/review/`(gitignored;默认 `.mstar/sdd/<plan-id>/review/`) | `mstar-sdd`、`mstar-review-qc`、`qa-engineer` |
|
|
17
|
+
| **SDD scratch** | `{HARNESS_DIR}/sdd/<plan-id>/`(gitignored;含 per-task handoff 与 `review/` bundle) | `mstar-sdd` |
|
|
18
|
+
| **status.json(v2 根)** | `.mstar/status.json`(gitignored;本地会话 SSOT;`{version: 2, updated_at, workflows[]}` 活跃 lifecycle 登记) | `mstar-artifacts`、`mstar-iteration` |
|
|
19
|
+
| **workflow snapshot** | `{HARNESS_DIR}/workflows/<id>/snapshot.json`(gitignored;每 lifecycle 运行态:`plans[]` 行 + leases + branch anchors;`<id>` = plan id 或 iteration id) | `mstar-artifacts`、`mstar-iteration`、`mstar-branch-worktree` |
|
|
20
|
+
| **workflow notes ledger** | `{HARNESS_DIR}/workflows/<id>/notes.jsonl`(gitignored;append-only 运行时笔记) | `mstar-artifacts`、`mstar-iteration` |
|
|
21
|
+
| **project roadmap** | `.mstar/projects/<id>/roadmap.md`(gitignored;frontmatter `{project_id, title, status, created_at, milestones[]?, residuals_ref?}` + 正文约定) | `mstar-artifacts`、`mstar-iteration` |
|
|
22
|
+
| **project register** | `.mstar/projects/<id>/residuals.json`(gitignored;open residual SSOT:`entries[<plan-id>]` 数组;项目缺失用 `_default`) | `mstar-artifacts`、`mstar-review-qc` |
|
|
23
|
+
| **project references(研究语料)** | `.mstar/projects/<id>/references/`(gitignored;主题化 surveys / epic 备注 / 第三方 notes,与项目绑定;与 `{SPECS_DIR}` / `{KNOWLEDGE_DIR}` / `{ITERATION_DIR}` 不同) | `mstar-project-governance`、`mstar-artifacts` |
|
|
24
|
+
| **迭代 package** | `.mstar/iterations/<iteration-id>/`(gitignored;`delivery-compass.md`、`guides/`、`specs/`、可选 `README.md`) | `mstar-iteration`(读写);close 时 `mstar-compound`(提升读;默认排除 compass) |
|
|
25
|
+
| **迭代索引** | `.mstar/iterations/README.md`(gitignored;一行 = 一次迭代) | `mstar-iteration`(读写) |
|
|
26
|
+
| **规格** | `{HARNESS_DIR}/specs/`(默认 tracked;解析见 `mstar-conventions`) | `mstar-artifacts` |
|
|
27
|
+
| **harness AGENTS** | `.mstar/AGENTS.md`(tracked) | PM / init |
|
|
28
|
+
| **archived knowledge** | `.mstar/archived/knowledge/`(保留原 `{KNOWLEDGE_DIR}` 相对路径) | `mstar-iteration` §1.6 corpus hygiene、`mstar-artifacts` |
|
|
29
|
+
| **archived specs** | `.mstar/archived/specs/`(保留原 `{SPECS_DIR}` 相对路径) | `mstar-iteration` §1.6 corpus hygiene、`mstar-artifacts` |
|
|
30
|
+
|
|
31
|
+
## 仓库根目录(`<repo-root>/`,与 `.git/` 同级)
|
|
32
|
+
|
|
33
|
+
这些是人类和所有 agent 的共同入口,**不在** `{HARNESS_DIR}` 子树内。
|
|
34
|
+
|
|
35
|
+
| 产物 | 解析后路径 | 读写的技能 |
|
|
36
|
+
|------|----------|-----------|
|
|
37
|
+
| **CONCEPTS.md** | `<repo-root>/CONCEPTS.md` | `mstar-compound`(写/协同)、`mstar-compound-refresh`(reconciliation/bootstrapping) |
|
|
38
|
+
| **STRATEGY.md** | `<repo-root>/STRATEGY.md` | `mstar-strategy`(读写) |
|
|
39
|
+
| **AGENTS.md 更新** | `<repo-root>/AGENTS.md`(或 `CLAUDE.md`) | `mstar-compound`(可发现性检查编辑)、`mstar-strategy`(索引编辑) |
|
|
40
|
+
|
|
41
|
+
## 禁止操作区域
|
|
42
|
+
|
|
43
|
+
以下目录**不属于** harness 知识/策略的产出目标,skills 不得在其中写入:
|
|
44
|
+
|
|
45
|
+
| 路径 | 说明 |
|
|
46
|
+
|------|------|
|
|
47
|
+
| `docs/` | 人类文档(安装、贡献指南等),知识产物不放此处 |
|
|
48
|
+
| `{ITERATION_DIR}/` | 迭代 package(compass + guides/specs);知识文档不放此处 |
|
|
49
|
+
| `{SPECS_DIR}/` | 仅限冻结规格/ADR,运行时知识不放此处 |
|
|
50
|
+
|
|
51
|
+
## `<category>` 取值
|
|
52
|
+
|
|
53
|
+
知识文档的 `<category>` 子目录由 `mstar-compound` 的 `references/category-mapping.md` 定义,在 `{KNOWLEDGE_DIR}` 下按需创建。示例:`runtime-errors/`、`conventions/`、`architecture-patterns/` 等。
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# 工期与工作量预估(Agent 语境 · Morning Star)
|
|
2
|
+
|
|
3
|
+
> **Load order(与其它 `mstar-*` skill 一致)**:写 Effort 字段前须已 Read **`mstar-harness-core`** skill(SKILL.md)以对齐「仅 agent-oriented、禁止人天/日历」的全局不变量;本 reference 为口径细则展开。
|
|
4
|
+
|
|
5
|
+
在 OpenCode / Cursor 等多角色 agent 编排下,**所有「工期 / 工作量 / Effort」类预估只描述 agent 实施量级**:在规格与验收已就绪、上下文可加载的前提下,**agent 连续或少量会话内**完成实现与基础自证(跑通命令/单测等)需要多少**agent 工作量**。
|
|
6
|
+
|
|
7
|
+
## 硬性规则(不得混入人工时间)
|
|
8
|
+
|
|
9
|
+
凡使用本 harness 的计划、PRD、架构文档、Assignment、Status Update 中的 **Effort / 工期 / 预估** 表述:
|
|
10
|
+
|
|
11
|
+
- **必须**只反映 **agent 执行与会话**(见下节尺码与会话带)。
|
|
12
|
+
- **禁止**纳入任何**人类时间**,包括但不限于:人天 / person-days / FTE、人类日历天或周、等待人工评审、会议、排期空档、发布窗口、合规签批排队、跨团队人类响应时间。
|
|
13
|
+
- **禁止**用「标了轴的人天」变相写人类时间;**本节字段内不要使用人天 / FTE / 人类日历**。
|
|
14
|
+
- **QC/QA 在流程中的迭代**:视为 **agent 会话**的一部分(可多算几次会话),**不要**单独加「人类审查要等 X 天」。
|
|
15
|
+
|
|
16
|
+
若业务方必须另做**人类排期或合同人天**,须在**与本 Effort 字段完全分离**的文档或章节(例如路线图、商务附件)中撰写,**不得**写进 `Effort (agent-oriented)` 或同名小节,以免与 agent 预估混读。
|
|
17
|
+
|
|
18
|
+
## 推荐写法:T 恤尺码 + agent 会话带
|
|
19
|
+
|
|
20
|
+
1. **XS**:单文件 / 单测点 / 配置微调 — 通常 **<1** 次完整 agent 回合可交付。
|
|
21
|
+
2. **S**:局部模块小改 — 约 **1** 次专注会话。
|
|
22
|
+
3. **M**:单功能横切少量文件 — 约 **1–3** 次会话(含流程内 QC/QA agent 迭代则取上沿)。
|
|
23
|
+
4. **L**:多模块、新子系统、或强依赖摸底 — 约 **3–8** 次会话;**应拆里程碑**。
|
|
24
|
+
5. **XL**:接近子系统级或未知域 — **先 spike / 原型**,未摸底前不给紧凑数字预估。
|
|
25
|
+
|
|
26
|
+
「**会话**」指:一次连贯的 agent 运行(读上下文 → 实现 → 运行验证),**不是**人类 8 小时工作日。
|
|
27
|
+
|
|
28
|
+
## 文档与模板中的字段名(建议)
|
|
29
|
+
|
|
30
|
+
- **PRD / 产品文档**:**`## Effort (agent-oriented)`** — 仅 **Complexity (XS–XL) + agent session band + 假设**(规格已锁、契约稳定等)。
|
|
31
|
+
- **架构 / 技术计划**:**`### Implementation effort (agent-oriented)`** — 同上;区分 **spike** vs **build**。
|
|
32
|
+
- **PM Assignment `Constraints`**:**`Effort (agent-oriented)`**: `M, ~2–4 agent sessions — assumes plan locked and contracts stable`。
|
|
33
|
+
- **Status Update**:剩余工作仅用 agent 会话语言(如「约 1 次会话可收口」),**不写**人类日历或人天。
|
|
34
|
+
|
|
35
|
+
## 与不确定性的关系
|
|
36
|
+
|
|
37
|
+
- **规格未锁、接口未定、依赖外部凭证**:标 **`blocked` / `spike required`**,改为「先 1 次摸底会话再更新 Effort」,仍**只**用 agent 会话描述。
|
|
38
|
+
- **高危变更 / 生产发布**:人类审批或发布节奏**不计入**本节 Effort;若需记录依赖,用 **阻塞/依赖清单**(非时间预估字段)。
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# Harness 初始化与 `AGENTS.md` 分层策略(Morning Star)
|
|
2
|
+
|
|
3
|
+
> **Load order**:使用本参考初始化仓库前,须先 Read `mstar-harness-core` 与 `mstar-conventions`;冲突以 `mstar-harness-core` 为准。
|
|
4
|
+
|
|
5
|
+
## 目标
|
|
6
|
+
|
|
7
|
+
给新仓或迁移仓提供一套可复制的启动方式,确保:
|
|
8
|
+
|
|
9
|
+
- `status.json` / residual / review bundle 有唯一落点;
|
|
10
|
+
- 根规则与 harness 规则不互相覆盖;
|
|
11
|
+
- 目录级 `AGENTS.md` 只承载增量边界,不变成重复手册。
|
|
12
|
+
|
|
13
|
+
## Bootstrap 最小步骤
|
|
14
|
+
|
|
15
|
+
1. 创建 `{HARNESS_DIR}`(推荐 `.mstar/`)与 `{PLAN_DIR}`(推荐 `.mstar/plans/`)。
|
|
16
|
+
2. 初始化 `status.json`:从 **`mstar-artifacts/templates/status.empty.json`** 复制(**v2 形状**:`version: 2` + `workflows: []`);residual canonical 见 **`mstar-artifacts` SKILL.md**;字段与生命周期见 **`mstar-artifacts/references/status-and-residuals.md`**。`projects/_default/`(`roadmap.md` + 空 `residuals.json`)由 **`scaffoldHarness` / `mstar harness scaffold` 预建**;其余 project id 与 `workflows/` 子目录由 engine writers 按需创建(**不**在 bootstrap 预建)。
|
|
17
|
+
3. `sdd/` 空目录占位(per-plan 子目录由 **`mstar-sdd`** → `mstar sdd workspace <plan-id>` 创建)。
|
|
18
|
+
4. 项目根 `.gitignore` 追加 Morning Star **进程产物**忽略集(canonical snippet → `mstar-conventions` SKILL.md「Git 跟踪策略」;legacy `.agents/` 有等价表)。
|
|
19
|
+
5. 可选:创建 `{ITERATION_DIR}`(`iterations/` + `README.md`)与 `{KNOWLEDGE_DIR}`(`knowledge/` + `README.md`);`{HARNESS_DIR}/specs/`(解析后的 `{SPECS_DIR}` 默认落点);内容边界见 `mstar-conventions` SKILL.md 与 `references/knowledge-and-designs.md`。
|
|
20
|
+
6. 创建 `{HARNESS_DIR}/AGENTS.md`(harness 子树规则;**tracked**):符号表可复述 `{HARNESS_DIR}`、`{PLAN_DIR}`、`{ITERATION_DIR}`、`{KNOWLEDGE_DIR}`、`{SPECS_DIR}` 与 `docs/` 分工;新项目推荐 `.mstar/AGENTS.md`,已有项目可继续使用 `.agents/AGENTS.md`。
|
|
21
|
+
7. 校准根 `AGENTS.md`:只保留仓库级长期约束,显式引用 `{HARNESS_DIR}/AGENTS.md` 作为 harness SSOT。
|
|
22
|
+
8. 仅在确有稳定边界时新增目录级 `AGENTS.md`(如 `contracts/`、`gateway/`、`sdk/`)。
|
|
23
|
+
|
|
24
|
+
**程序化路径**:`mstar harness scaffold [path]`(CLI,默认 cwd)一次性完成步骤 1–2(含 `projects/_default/`)、4 与 6 —— 调用 engine `scaffoldHarness`、追加 canonical gitignore snippet(已存在则跳过)、写最小 `{HARNESS_DIR}/AGENTS.md`(已存在则跳过);幂等,重跑只补缺失件。步骤 3、5、7、8 仍按需手工。 scaffold 遵循 `.mstarc` 的 `harness_dir` / `project_dir` 覆盖(写入解析后的目录);解析出的 harness 目录名非 `.mstar` 时跳过 canonical gitignore snippet(自定义 harness 布局自行管理 ignore 规则)。
|
|
25
|
+
|
|
26
|
+
**gitignore 归一化契约**:scaffold 对默认布局的根 `.gitignore` 仅做四类收敛——分区(用户针对性 `.mstar/…` 规则整体移到 fence 之后、相对顺序不变)、去重冗余宽规则、错位主宽规则前移至首个 canonical negation 之前(仅当跨越行全部为 scaffold 自有语义)、补齐 canonical negation 使其出现在最后一条宽规则之后。保证:① tracked 结果(AGENTS/knowledge/specs)不因错序 fence 被忽略;② 用户针对性规则的字面意图最后生效(`!x` 即 track `x`)。自我否定的规则序列(先 `!x` 后被宽规则压制)按字面意图解析;每次变更均在 scaffold 输出中报告。
|
|
27
|
+
|
|
28
|
+
## Git 跟踪策略(进程 vs 结果)
|
|
29
|
+
|
|
30
|
+
**原则**:进程留在本地;结果与团队共享。完整规则与 canonical `.gitignore` snippet → **`mstar-conventions` SKILL.md「Git 跟踪策略」**。
|
|
31
|
+
|
|
32
|
+
| 类别 | 默认 tracked | 默认 gitignored |
|
|
33
|
+
|------|--------------|-----------------|
|
|
34
|
+
| 结果(跨 clone handoff) | `{HARNESS_DIR}/AGENTS.md`、`{KNOWLEDGE_DIR}/**`、`{SPECS_DIR}/**` | — |
|
|
35
|
+
| 进程(本地会话 SSOT) | — | `plans/`、`iterations/`、`status.json`、`workflows/`、`projects/`、`sdd/`、`archived/` |
|
|
36
|
+
|
|
37
|
+
跨 clone 须持久的 residual 或决策:经 **`mstar-compound`** 提升入 `{KNOWLEDGE_DIR}/`、写入 `{SPECS_DIR}/`,或记入 tracked `{HARNESS_DIR}/AGENTS.md` — **勿**默认 `git add` `status.json` / `plans/`。
|
|
38
|
+
|
|
39
|
+
## 三层 `AGENTS.md` 职责切分
|
|
40
|
+
|
|
41
|
+
### 根 `AGENTS.md`(项目层)
|
|
42
|
+
|
|
43
|
+
- 放:仓库身份、技术边界、构建/测试接口、安全与分支策略、规格路由表。
|
|
44
|
+
- 不放:动态状态、当前批次进展、R# 明细、QC 单次结论。
|
|
45
|
+
|
|
46
|
+
### `{HARNESS_DIR}/AGENTS.md`(harness 层)
|
|
47
|
+
|
|
48
|
+
- 放:`{HARNESS_DIR}`/`{PLAN_DIR}`/`{ITERATION_DIR}`/`{KNOWLEDGE_DIR}`/`{SPECS_DIR}` 契约、`docs/` 与 harness 子树内容边界、状态推进门禁、QC/QA 对齐规则、residual 生命周期。
|
|
49
|
+
- 不放:语言/框架编码细节、业务模块实现约束。
|
|
50
|
+
|
|
51
|
+
### `<subdir>/AGENTS.md`(边界层)
|
|
52
|
+
|
|
53
|
+
- 放:该目录独有的边界、禁区、接口命令与升级触发。
|
|
54
|
+
- 不放:根级通用规则复写、harness 全量规则拷贝。
|
|
55
|
+
|
|
56
|
+
## 分目录 `AGENTS.md` 创建准入
|
|
57
|
+
|
|
58
|
+
仅当满足任一条件时创建:
|
|
59
|
+
|
|
60
|
+
- 目录具备独立风险模型(如链上合约 vs 网关服务);
|
|
61
|
+
- 目录有单独发布面或对外 API 面;
|
|
62
|
+
- 目录有稳定且长期存在的专属约束(构建、依赖、数据/安全边界)。
|
|
63
|
+
|
|
64
|
+
若仅是代码组织而无新增约束,不创建目录级 `AGENTS.md`。
|
|
65
|
+
|
|
66
|
+
## 推荐模板骨架(目录级)
|
|
67
|
+
|
|
68
|
+
```markdown
|
|
69
|
+
# AGENTS.md — `<dir>/`
|
|
70
|
+
|
|
71
|
+
## Source Priority
|
|
72
|
+
1. Current user instruction
|
|
73
|
+
2. Root `AGENTS.md`
|
|
74
|
+
3. This file
|
|
75
|
+
4. `{HARNESS_DIR}/AGENTS.md`
|
|
76
|
+
|
|
77
|
+
## Boundary Rules
|
|
78
|
+
- ...
|
|
79
|
+
|
|
80
|
+
## Build & Test (interface)
|
|
81
|
+
- ...
|
|
82
|
+
|
|
83
|
+
## Escalation Triggers
|
|
84
|
+
- ...
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## 反模式与修正
|
|
88
|
+
|
|
89
|
+
- 反模式:在根 `AGENTS.md` 维护当前计划进展与 commit 列表。
|
|
90
|
+
修正:迁移到 workflow snapshot 的 `plans[].metadata` 与 `workflows/<id>/notes.jsonl`。
|
|
91
|
+
|
|
92
|
+
- 反模式:每个子目录复制一份完整 harness 规则。
|
|
93
|
+
修正:保留一行引用 `{HARNESS_DIR}/AGENTS.md`,仅写本目录增量约束。
|
|
94
|
+
|
|
95
|
+
- 反模式:目录级规则未声明 Source Priority,冲突时不可裁决。
|
|
96
|
+
修正:统一四级优先级模板并在每个目录级文件开头声明。
|
|
@@ -0,0 +1,142 @@
|
|
|
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-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-conventions`. On conflict, **`mstar-harness-core` wins**.
|
|
9
|
+
|
|
10
|
+
| 你还可能要 Read | 何时 |
|
|
11
|
+
|-----------------|------|
|
|
12
|
+
| `mstar-phase-gates` | Prepare 阶段判定 gate、何时 DESIGN.md 必须就绪 |
|
|
13
|
+
| `mstar-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, **YAML frontmatter structure** | `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 YAML frontmatter and Level 2/3 placeholders | `templates/DESIGN.md.template` |
|
|
25
|
+
| Dark theme template (same token names, different values) | `templates/DESIGN.dark.md.template` |
|
|
26
|
+
|
|
27
|
+
**YAML frontmatter is the SSOT for token values.** Colors, typography, spacing, rounded, and components live in the frontmatter as structured, machine-readable data. The Markdown body is supplementary documentation (rules, intent, usage guidance). When reading DESIGN.md, always parse the YAML frontmatter first; when writing, keep frontmatter and body in sync.
|
|
28
|
+
|
|
29
|
+
**Out of scope:** rendered UI preview tooling outside the repo; frontend implementation that consumes DESIGN.md tokens (use `@frontend-dev` / `@fullstack-dev`); QC review verdict rules (→ **`mstar-review-qc`**).
|
|
30
|
+
|
|
31
|
+
## Location
|
|
32
|
+
|
|
33
|
+
- **Primary**: project root `DESIGN.md` (human + agent visible, aligns with `AGENTS.md`)
|
|
34
|
+
- **Dark theme**: project root `DESIGN.dark.md` (same token names, different values)
|
|
35
|
+
- `DESIGN.md` is a **project-level design contract**, not a harness internal artifact. It lives beside `README.md` and `AGENTS.md`.
|
|
36
|
+
|
|
37
|
+
## Role lifecycle
|
|
38
|
+
|
|
39
|
+
### Creator: `@architect` (primary) + `@product-manager` (requirements)
|
|
40
|
+
|
|
41
|
+
`@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.
|
|
42
|
+
|
|
43
|
+
### Orchestrator: `@project-manager`
|
|
44
|
+
|
|
45
|
+
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)`.
|
|
46
|
+
|
|
47
|
+
### Consumers
|
|
48
|
+
|
|
49
|
+
- `@frontend-dev` / `@fullstack-dev` — read DESIGN.md before implementing styled components; map tokens to CSS/theme variables
|
|
50
|
+
- `@qc-specialist` — verify UI implementation aligns with DESIGN.md tokens
|
|
51
|
+
- `@qa-engineer` — verify visual output matches design spec when **`QA gate: mandatory`**
|
|
52
|
+
|
|
53
|
+
## Phase gate integration
|
|
54
|
+
|
|
55
|
+
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.
|
|
56
|
+
|
|
57
|
+
1. PM includes "DESIGN.md creation/audit" in Prepare tracking checklist when the plan involves UI
|
|
58
|
+
2. `@architect` creates or updates DESIGN.md; `@product-manager` reviews design intent alignment
|
|
59
|
+
3. PM gates on: DESIGN.md exists, meets completeness level declared in plan, `@product-manager` signed off
|
|
60
|
+
|
|
61
|
+
For **hotfix** or plans with no UI changes, DESIGN.md check may be skipped.
|
|
62
|
+
|
|
63
|
+
## Completeness levels(Evidence)
|
|
64
|
+
|
|
65
|
+
DESIGN.md supports three levels, each with built-in upgrade path:
|
|
66
|
+
|
|
67
|
+
1. **Level 1 — MVP** (minimal, prevents guesswork): palette, base typography, spacing scale
|
|
68
|
+
2. **Level 2 — Standard** (consistent components): full token scales, breakpoints, component tokens (Button, Input)
|
|
69
|
+
3. **Level 3 — Production** (complete design system): dual theme, elevation, motion, shapes, component library, voice
|
|
70
|
+
|
|
71
|
+
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.
|
|
72
|
+
|
|
73
|
+
Full checklist → `references/completeness-checklist.md`.
|
|
74
|
+
|
|
75
|
+
## Workflows
|
|
76
|
+
|
|
77
|
+
### Workflow 1: Create DESIGN.md (Prepare phase)
|
|
78
|
+
|
|
79
|
+
1. Read `references/design-md-spec.md` for section definitions and YAML frontmatter structure
|
|
80
|
+
2. Copy `templates/DESIGN.md.template` to `{PROJECT_ROOT}/DESIGN.md` — the template includes the full YAML frontmatter skeleton
|
|
81
|
+
3. Interview `@product-manager` for brand colors, typography preferences, must-have patterns
|
|
82
|
+
4. Fill Level 1 frontmatter tokens (uncomment and replace `"[placeholder]"` values with concrete hex/px values)
|
|
83
|
+
5. If plan requires Level 2+ out of the gate, uncomment and fill those sections too
|
|
84
|
+
6. Update the body prose to match the frontmatter values (target audience, aesthetic principles, rhythm rules)
|
|
85
|
+
7. Run the completeness audit workflow below to confirm level
|
|
86
|
+
8. Report to PM: path created, level achieved, what's needed for next level
|
|
87
|
+
|
|
88
|
+
### Workflow 2: Audit DESIGN.md completeness
|
|
89
|
+
|
|
90
|
+
1. Read `DESIGN.md` and `DESIGN.dark.md` (if exists) — **parse the YAML frontmatter** for structured token values
|
|
91
|
+
2. Load `references/completeness-checklist.md`
|
|
92
|
+
3. Check each checklist item; note gaps in both frontmatter (missing/uncommented keys, placeholder values) and body (missing rules/documentation)
|
|
93
|
+
4. Report:
|
|
94
|
+
- Current completeness level
|
|
95
|
+
- Gaps preventing next level (frontmatter gaps vs. body gaps, tagged separately)
|
|
96
|
+
- Presence of upgrade placeholders (`LEVEL2_PLACEHOLDER`, `LEVEL3_PLACEHOLDER` in both frontmatter comments and body HTML comments)
|
|
97
|
+
- Recommendation: whether to upgrade now or defer
|
|
98
|
+
5. Update DESIGN.md level tag (e.g., `<!-- COMPLETENESS_LEVEL: 1 — last audited YYYY-MM-DD -->`) if changed
|
|
99
|
+
|
|
100
|
+
### Workflow 3: Add dark theme
|
|
101
|
+
|
|
102
|
+
1. Read existing `DESIGN.md` to extract token names
|
|
103
|
+
2. Copy `templates/DESIGN.dark.md.template` to `{PROJECT_ROOT}/DESIGN.dark.md`
|
|
104
|
+
3. For each token in DESIGN.md, define the dark-theme equivalent value
|
|
105
|
+
4. Preserve same token names; only values change (see `references/design-md-spec.md` § Light/Dark rules)
|
|
106
|
+
5. Audit with Workflow 2 to confirm Level 3 completeness
|
|
107
|
+
|
|
108
|
+
### Workflow 4: Consume DESIGN.md (implementation roles)
|
|
109
|
+
|
|
110
|
+
Before writing styled UI code:
|
|
111
|
+
1. Read `DESIGN.md` (and `DESIGN.dark.md` if exists)
|
|
112
|
+
2. **Parse the YAML frontmatter** for token values — this is the SSOT for colors, typography, spacing, rounded, and components
|
|
113
|
+
3. Resolve component `{colors.X}`, `{typography.X}`, `{rounded.X}` references by tracing back to the corresponding frontmatter keys
|
|
114
|
+
4. Extract tokens into implementation layer (CSS custom properties, Tailwind config, theme object, etc.)
|
|
115
|
+
5. Follow DESIGN.md body Voice & Content rules for copy text
|
|
116
|
+
6. If DESIGN.md is missing, has no frontmatter, or is incomplete, report to PM — do not guess tokens
|
|
117
|
+
|
|
118
|
+
## Light/Dark dual-theme rules
|
|
119
|
+
|
|
120
|
+
Dual theme uses **same token names, different values** across two files:
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
DESIGN.md DESIGN.dark.md
|
|
124
|
+
----------- --------------
|
|
125
|
+
gray-100: #fff gray-100: #111
|
|
126
|
+
gray-1000: #000 gray-1000: #eee
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
- Token names are the **SSOT interface** — consumers reference tokens by name, not raw values
|
|
130
|
+
- `references/design-md-spec.md` § Light/Dark rules defines the contract
|
|
131
|
+
|
|
132
|
+
> **Engine check (when available):** run `mstar design-md validate <dir>` (or `import { validateDesignTokenFrontmatter, assertLightDarkParity, completenessLevel } from "@mstar-harness/engine"` in a host hook) to validate the token frontmatter schema above, the light/dark parity of `DESIGN.dark.md` (same token names, different values), and the achieved completeness level. On `fail` -> do not proceed; fix and re-run. Skill text below remains authoritative when the runtime is absent.
|
|
133
|
+
|
|
134
|
+
## References
|
|
135
|
+
|
|
136
|
+
- `references/design-md-spec.md` — normative spec: section definitions, token naming conventions, light/dark contract
|
|
137
|
+
- `references/completeness-checklist.md` — three-level audit checklist with detailed criteria per level
|
|
138
|
+
- `references/vercel-example.md` — Vercel Geist DESIGN.md as annotated reference (read when creating from scratch or needing design inspiration)
|
|
139
|
+
|
|
140
|
+
**Templates (this skill):**
|
|
141
|
+
- `templates/DESIGN.md.template` — full template including all Level 1-3 sections with placeholder comments
|
|
142
|
+
- `templates/DESIGN.dark.md.template` — dark theme template with same token names, different values
|
|
@@ -0,0 +1,181 @@
|
|
|
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. **Parse the YAML frontmatter** for structured token values — the frontmatter is the SSOT for colors, typography, spacing, rounded, and components
|
|
9
|
+
3. Review the Markdown body for documented rules, rhythm, and usage intent
|
|
10
|
+
4. Check each item in the target level (and all lower levels)
|
|
11
|
+
5. An item is **complete** only when concrete values exist in the frontmatter (uncommented keys with non-placeholder values) — YAML comments and `[LEVEL*]` placeholder values do not count
|
|
12
|
+
6. A `DESIGN.md` is at **Level N** when all items in Level N and below are complete
|
|
13
|
+
7. Record the result in a comment at the top of DESIGN.md:
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
<!-- COMPLETENESS_LEVEL: N — last audited YYYY-MM-DD -->
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Level 1 — MVP (prevents guesswork)
|
|
20
|
+
|
|
21
|
+
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.
|
|
22
|
+
|
|
23
|
+
### Checklist
|
|
24
|
+
|
|
25
|
+
- [ ] **Frontmatter exists** — YAML frontmatter block with `---` delimiters present and parseable
|
|
26
|
+
- [ ] **Frontmatter `version`** — `version: 0.1.0` declared
|
|
27
|
+
- [ ] **Frontmatter `name` and `description`** — design system name and description filled (non-placeholder)
|
|
28
|
+
- [ ] **Overview** — design system name and aesthetic principles stated in body
|
|
29
|
+
- [ ] **Colors — Background** — frontmatter has `colors.background-100` with a concrete hex value (not `"[LEVEL*]"` placeholder)
|
|
30
|
+
- [ ] **Colors — Text** — frontmatter has `colors.gray-1000` and `colors.gray-900` with concrete hex values
|
|
31
|
+
- [ ] **Colors — Accent** — frontmatter has `colors.blue-700` (or brand equivalent) with a concrete hex value
|
|
32
|
+
- [ ] **Colors — Semantic** — frontmatter has `colors.red-700` (error) and `colors.amber-700` (warning) with concrete hex values
|
|
33
|
+
- [ ] **Typography — Body** — frontmatter has at least one `typography.copy-*` token with all five properties filled
|
|
34
|
+
- [ ] **Typography — Heading** — frontmatter has at least one `typography.heading-*` token with all five properties filled
|
|
35
|
+
- [ ] **Spacing** — frontmatter has `spacing.base` declared and at least 5 numbered steps with pixel values
|
|
36
|
+
- [ ] **Rounded** — frontmatter has `rounded.sm` with a concrete pixel value
|
|
37
|
+
- [ ] **Breakpoints** — at least 2 responsive breakpoints documented in body
|
|
38
|
+
|
|
39
|
+
### What an agent CAN do at Level 1
|
|
40
|
+
|
|
41
|
+
- Style a basic page with correct brand colors
|
|
42
|
+
- Choose readable typography
|
|
43
|
+
- Apply consistent spacing
|
|
44
|
+
- Make a responsive layout that works on mobile and desktop
|
|
45
|
+
- Signal errors with the correct color
|
|
46
|
+
|
|
47
|
+
### What an agent CANNOT do at Level 1
|
|
48
|
+
|
|
49
|
+
- Build a consistent component library (no component tokens)
|
|
50
|
+
- Apply elevation/shadow correctly (will guess)
|
|
51
|
+
- Use motion responsibly (will guess)
|
|
52
|
+
- Generate dark mode (no DESIGN.dark.md)
|
|
53
|
+
- Apply voice rules to copy text
|
|
54
|
+
|
|
55
|
+
### Verdict
|
|
56
|
+
|
|
57
|
+
- **All 13 items checked → Level 1 complete**
|
|
58
|
+
- **Missing items → below Level 1 (insufficient for agent UI generation)**
|
|
59
|
+
|
|
60
|
+
## Level 2 — Standard (consistent components)
|
|
61
|
+
|
|
62
|
+
Sufficient for building a consistent, polished UI with reusable components. The expected level for production codebases with a frontend.
|
|
63
|
+
|
|
64
|
+
Prerequisite: Level 1 complete.
|
|
65
|
+
|
|
66
|
+
### Checklist
|
|
67
|
+
|
|
68
|
+
- All Level 1 items complete
|
|
69
|
+
- [ ] **Colors — Full background scale** — frontmatter has `colors.background-100`, `background-200`, `background-300` active (uncommented, filled)
|
|
70
|
+
- [ ] **Colors — Full gray solid scale** — frontmatter has `colors.gray-100` through `gray-1000` (10 steps) all active
|
|
71
|
+
- [ ] **Colors — Gray alpha scale** — frontmatter has `colors.gray-alpha-100` through at least `gray-alpha-600` all active
|
|
72
|
+
- [ ] **Colors — All accent scales** — frontmatter has `blue`, `red`, `amber`, `green`, `teal`, `purple`, `pink` scales, each with at least `700`/`800`/`900`/`1000` steps active
|
|
73
|
+
- [ ] **Typography — Headings** — frontmatter has at least 3 heading levels active (e.g., `heading-32`, `heading-24`, `heading-20`)
|
|
74
|
+
- [ ] **Typography — Labels** — frontmatter has at least one `label-*` token active
|
|
75
|
+
- [ ] **Typography — Buttons** — frontmatter has at least one `button-*` token active
|
|
76
|
+
- [ ] **Spacing** — frontmatter `spacing:` has full 9-step scale active; three-step rhythm documented in body
|
|
77
|
+
- [ ] **Rounded** — frontmatter `rounded:` has `sm`, `md`, `lg`, `full` all active
|
|
78
|
+
- [ ] **Breakpoints** — at least 4 breakpoints documented in body
|
|
79
|
+
- [ ] **Components — Button** — frontmatter `components:` has `button-primary` and `button-secondary` with all properties filled, plus `button-small` size variant; body documents hover/active/disabled/focus states
|
|
80
|
+
- [ ] **Components — Input** — frontmatter `components:` has `input` with all properties filled; body documents states
|
|
81
|
+
|
|
82
|
+
### What an agent CAN do at Level 2
|
|
83
|
+
|
|
84
|
+
- Everything from Level 1
|
|
85
|
+
- Build a consistent Button component with all states
|
|
86
|
+
- Build a consistent Input component with all states
|
|
87
|
+
- Use the full color scale for nuanced visual hierarchy
|
|
88
|
+
- Apply correct typography to every text role
|
|
89
|
+
- Use translucent overlays and borders (alpha scale)
|
|
90
|
+
- Pick the right accent color for each semantic purpose
|
|
91
|
+
|
|
92
|
+
### What an agent CANNOT do at Level 2
|
|
93
|
+
|
|
94
|
+
- Generate dark mode (no DESIGN.dark.md)
|
|
95
|
+
- Apply elevation/shadows with confidence (may guess)
|
|
96
|
+
- Use motion consistently (may guess)
|
|
97
|
+
- Enforce voice rules on copy text
|
|
98
|
+
- Know the correct border radius for each component type
|
|
99
|
+
|
|
100
|
+
### Verdict
|
|
101
|
+
|
|
102
|
+
- **All 11 items checked (on top of Level 1) → Level 2 complete**
|
|
103
|
+
- **1–3 items missing → Level 2 partial; useable but expect component inconsistencies**
|
|
104
|
+
- **4+ items missing → below Level 2; recommend completing Level 1 only deploy**
|
|
105
|
+
|
|
106
|
+
## Level 3 — Production (complete design system)
|
|
107
|
+
|
|
108
|
+
Full design system ready for production at scale. Includes dual theme, motion, and voice.
|
|
109
|
+
|
|
110
|
+
Prerequisite: Level 2 complete.
|
|
111
|
+
|
|
112
|
+
### Checklist
|
|
113
|
+
|
|
114
|
+
- All Level 1 and Level 2 items complete
|
|
115
|
+
- [ ] **DESIGN.dark.md exists** — dark theme file with `---` YAML frontmatter present, same key structure as DESIGN.md
|
|
116
|
+
- [ ] **Dark theme frontmatter parity** — every token in DESIGN.md frontmatter (`colors`, `typography`, `spacing`, `rounded`, `components`) has a corresponding active entry in DESIGN.dark.md frontmatter with dark-appropriate values
|
|
117
|
+
- [ ] **Elevation — Shadows** — at least 3 elevation levels (card, popover, modal) with explicit `box-shadow` values in body
|
|
118
|
+
- [ ] **Motion — Easing** — easing curve declared in body
|
|
119
|
+
- [ ] **Motion — Durations** — at least state change, popover, modal durations in body
|
|
120
|
+
- [ ] **Motion — Reduced motion** — `prefers-reduced-motion` rule declared in body
|
|
121
|
+
- [ ] **Components — Full library** — frontmatter `components:` has at least Card, Modal, Tooltip, Menu/Dropdown variants
|
|
122
|
+
- [ ] **Voice & Content** — writing rules documented in body: casing conventions, action naming, error format, toast format, empty state format
|
|
123
|
+
|
|
124
|
+
### What an agent CAN do at Level 3
|
|
125
|
+
|
|
126
|
+
- Everything from Levels 1 and 2
|
|
127
|
+
- Generate dark-mode-compatible UI
|
|
128
|
+
- Apply elevation correctly for every UI layer
|
|
129
|
+
- Animate state changes consistently
|
|
130
|
+
- Apply correct border radius per element type
|
|
131
|
+
- Write correct microcopy (button labels, errors, toasts, empty states)
|
|
132
|
+
- Build a full component library (Card, Modal, Tooltip, Menu)
|
|
133
|
+
|
|
134
|
+
### Verdict
|
|
135
|
+
|
|
136
|
+
- **All 9 items checked → Level 3 complete (production-ready)**
|
|
137
|
+
- **DESIGN.dark.md missing but rest complete → Level 2+ (partial Level 3, no dark mode)**
|
|
138
|
+
|
|
139
|
+
## Audit workflow
|
|
140
|
+
|
|
141
|
+
### When auditing existing DESIGN.md
|
|
142
|
+
|
|
143
|
+
1. Load the DESIGN.md file
|
|
144
|
+
2. Start at Level 1 checklist — check each item against actual content
|
|
145
|
+
3. If Level 1 complete, proceed to Level 2
|
|
146
|
+
4. If Level 2 complete, proceed to Level 3
|
|
147
|
+
5. Record the level as `<!-- COMPLETENESS_LEVEL: N -->` at top of DESIGN.md
|
|
148
|
+
6. For each incomplete item, note what's missing and which level it belongs to
|
|
149
|
+
7. Check for `LEVEL2_PLACEHOLDER` / `LEVEL3_PLACEHOLDER` markers — if present and the project is ready for upgrade, recommend activation
|
|
150
|
+
|
|
151
|
+
### When creating new DESIGN.md
|
|
152
|
+
|
|
153
|
+
1. Decide target level with PM/architect:
|
|
154
|
+
- Prototype / early project → Level 1
|
|
155
|
+
- Production frontend → Level 2
|
|
156
|
+
- Full design system → Level 3
|
|
157
|
+
2. Copy the template from `templates/DESIGN.md.template`
|
|
158
|
+
3. Fill all items in the target level
|
|
159
|
+
4. Run this checklist to confirm
|
|
160
|
+
5. Leave higher-level placeholders as-is
|
|
161
|
+
|
|
162
|
+
### When upgrading DESIGN.md
|
|
163
|
+
|
|
164
|
+
1. Read current DESIGN.md and note the level tag
|
|
165
|
+
2. Identify which items in the next level are missing
|
|
166
|
+
3. For each missing item, either:
|
|
167
|
+
- Fill with concrete values if known
|
|
168
|
+
- Leave the `LEVEL*_PLACEHOLDER` marker if deferred
|
|
169
|
+
4. Re-audit and update the level tag
|
|
170
|
+
|
|
171
|
+
## Upgrade trigger conditions
|
|
172
|
+
|
|
173
|
+
Agents encountering a DESIGN.md with placeholders should evaluate these conditions:
|
|
174
|
+
|
|
175
|
+
| Condition | Action |
|
|
176
|
+
|-----------|--------|
|
|
177
|
+
| `LEVEL2_PLACEHOLDER` found AND plan includes component work | Recommend completing the Level 2 sections |
|
|
178
|
+
| `LEVEL3_PLACEHOLDER` found AND plan includes dark mode | Recommend creating DESIGN.dark.md |
|
|
179
|
+
| `LEVEL3_PLACEHOLDER` found AND plan targets production release | Recommend completing Level 3 |
|
|
180
|
+
| `COMPLETENESS_LEVEL: 1` AND project has >3 UI views | Recommend upgrading to Level 2 |
|
|
181
|
+
| `COMPLETENESS_LEVEL: 2` AND project has dark mode requirement | Recommend upgrading to Level 3 |
|