architext 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +63 -0
- package/LICENSE +21 -0
- package/README.md +326 -0
- package/README.zh-CN.md +326 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +46 -0
- package/dist/templates/en/briefs/_base.md +115 -0
- package/dist/templates/en/briefs/_modules.md +173 -0
- package/dist/templates/en/docs/global/data_snapshot.json +31 -0
- package/dist/templates/en/docs/global/design_tokens.json +150 -0
- package/dist/templates/en/docs/global/dictionary.json +35 -0
- package/dist/templates/en/docs/global/error_codes.json +19 -0
- package/dist/templates/en/docs/global/map.json +94 -0
- package/dist/templates/en/docs/global/roadmap.json +39 -0
- package/dist/templates/en/docs/global/vision.md +82 -0
- package/dist/templates/en/docs/prompts/audit.md +150 -0
- package/dist/templates/en/docs/prompts/code.md +160 -0
- package/dist/templates/en/docs/prompts/edit.md +87 -0
- package/dist/templates/en/docs/prompts/fix.md +86 -0
- package/dist/templates/en/docs/prompts/help.md +69 -0
- package/dist/templates/en/docs/prompts/inherit.md +270 -0
- package/dist/templates/en/docs/prompts/map.md +131 -0
- package/dist/templates/en/docs/prompts/plan.md +252 -0
- package/dist/templates/en/docs/prompts/remove.md +162 -0
- package/dist/templates/en/docs/prompts/revise.md +160 -0
- package/dist/templates/en/docs/prompts/scope.md +198 -0
- package/dist/templates/en/docs/prompts/start.md +258 -0
- package/dist/templates/en/docs/templates/plan.template.json +113 -0
- package/dist/templates/en/docs/templates/scope-brief.template.md +58 -0
- package/dist/templates/en/docs/templates/spec.template.md +51 -0
- package/dist/templates/en/docs/templates/ui.template.md +51 -0
- package/dist/templates/en/rules/00_system.md +123 -0
- package/dist/templates/en/rules/01_workflow.md +93 -0
- package/dist/templates/en/rules/02_tech_stack.md +197 -0
- package/dist/templates/en/rules/03_data_governance.md +102 -0
- package/dist/templates/en/rules/04_cli_tools.md +50 -0
- package/dist/templates/en/rules/90_custom_rules.md +22 -0
- package/dist/templates/en/rules/99_context_glue.md +53 -0
- package/dist/templates/en/skills/archi-decompose-roadmap/SKILL.md +292 -0
- package/dist/templates/en/skills/archi-interview-protocol/SKILL.md +86 -0
- package/dist/templates/en/skills/archi-plan-options/SKILL.md +364 -0
- package/dist/templates/en/skills/archi-ui-wireframe/SKILL.md +342 -0
- package/dist/templates/zh/briefs/_base.md +116 -0
- package/dist/templates/zh/briefs/_modules.md +173 -0
- package/dist/templates/zh/docs/global/data_snapshot.json +31 -0
- package/dist/templates/zh/docs/global/design_tokens.json +135 -0
- package/dist/templates/zh/docs/global/dictionary.json +35 -0
- package/dist/templates/zh/docs/global/error_codes.json +19 -0
- package/dist/templates/zh/docs/global/map.json +94 -0
- package/dist/templates/zh/docs/global/roadmap.json +39 -0
- package/dist/templates/zh/docs/global/vision.md +82 -0
- package/dist/templates/zh/docs/prompts/audit.md +150 -0
- package/dist/templates/zh/docs/prompts/code.md +160 -0
- package/dist/templates/zh/docs/prompts/edit.md +87 -0
- package/dist/templates/zh/docs/prompts/fix.md +86 -0
- package/dist/templates/zh/docs/prompts/help.md +69 -0
- package/dist/templates/zh/docs/prompts/inherit.md +270 -0
- package/dist/templates/zh/docs/prompts/map.md +131 -0
- package/dist/templates/zh/docs/prompts/plan.md +253 -0
- package/dist/templates/zh/docs/prompts/remove.md +162 -0
- package/dist/templates/zh/docs/prompts/revise.md +160 -0
- package/dist/templates/zh/docs/prompts/scope.md +198 -0
- package/dist/templates/zh/docs/prompts/start.md +258 -0
- package/dist/templates/zh/docs/templates/plan.template.json +88 -0
- package/dist/templates/zh/docs/templates/scope-brief.template.md +58 -0
- package/dist/templates/zh/docs/templates/spec.template.md +51 -0
- package/dist/templates/zh/docs/templates/ui.template.md +51 -0
- package/dist/templates/zh/rules/00_system.md +123 -0
- package/dist/templates/zh/rules/01_workflow.md +93 -0
- package/dist/templates/zh/rules/02_tech_stack.md +192 -0
- package/dist/templates/zh/rules/03_data_governance.md +102 -0
- package/dist/templates/zh/rules/04_cli_tools.md +50 -0
- package/dist/templates/zh/rules/90_custom_rules.md +21 -0
- package/dist/templates/zh/rules/99_context_glue.md +53 -0
- package/dist/templates/zh/skills/archi-decompose-roadmap/SKILL.md +293 -0
- package/dist/templates/zh/skills/archi-interview-protocol/SKILL.md +86 -0
- package/dist/templates/zh/skills/archi-plan-options/SKILL.md +364 -0
- package/dist/templates/zh/skills/archi-ui-wireframe/SKILL.md +339 -0
- package/dist/templates/zh-Hant/briefs/_base.md +115 -0
- package/dist/templates/zh-Hant/briefs/_modules.md +173 -0
- package/dist/templates/zh-Hant/docs/global/data_snapshot.json +31 -0
- package/dist/templates/zh-Hant/docs/global/design_tokens.json +135 -0
- package/dist/templates/zh-Hant/docs/global/dictionary.json +35 -0
- package/dist/templates/zh-Hant/docs/global/error_codes.json +19 -0
- package/dist/templates/zh-Hant/docs/global/map.json +94 -0
- package/dist/templates/zh-Hant/docs/global/roadmap.json +39 -0
- package/dist/templates/zh-Hant/docs/global/vision.md +82 -0
- package/dist/templates/zh-Hant/docs/prompts/audit.md +150 -0
- package/dist/templates/zh-Hant/docs/prompts/code.md +160 -0
- package/dist/templates/zh-Hant/docs/prompts/edit.md +87 -0
- package/dist/templates/zh-Hant/docs/prompts/fix.md +86 -0
- package/dist/templates/zh-Hant/docs/prompts/help.md +69 -0
- package/dist/templates/zh-Hant/docs/prompts/inherit.md +270 -0
- package/dist/templates/zh-Hant/docs/prompts/map.md +131 -0
- package/dist/templates/zh-Hant/docs/prompts/plan.md +252 -0
- package/dist/templates/zh-Hant/docs/prompts/remove.md +162 -0
- package/dist/templates/zh-Hant/docs/prompts/revise.md +160 -0
- package/dist/templates/zh-Hant/docs/prompts/scope.md +198 -0
- package/dist/templates/zh-Hant/docs/prompts/start.md +258 -0
- package/dist/templates/zh-Hant/docs/templates/plan.template.json +88 -0
- package/dist/templates/zh-Hant/docs/templates/scope-brief.template.md +58 -0
- package/dist/templates/zh-Hant/docs/templates/spec.template.md +51 -0
- package/dist/templates/zh-Hant/docs/templates/ui.template.md +51 -0
- package/dist/templates/zh-Hant/rules/00_system.md +123 -0
- package/dist/templates/zh-Hant/rules/01_workflow.md +93 -0
- package/dist/templates/zh-Hant/rules/02_tech_stack.md +192 -0
- package/dist/templates/zh-Hant/rules/03_data_governance.md +102 -0
- package/dist/templates/zh-Hant/rules/04_cli_tools.md +50 -0
- package/dist/templates/zh-Hant/rules/90_custom_rules.md +21 -0
- package/dist/templates/zh-Hant/rules/99_context_glue.md +53 -0
- package/dist/templates/zh-Hant/skills/archi-decompose-roadmap/SKILL.md +293 -0
- package/dist/templates/zh-Hant/skills/archi-interview-protocol/SKILL.md +86 -0
- package/dist/templates/zh-Hant/skills/archi-plan-options/SKILL.md +364 -0
- package/dist/templates/zh-Hant/skills/archi-ui-wireframe/SKILL.md +337 -0
- package/package.json +85 -0
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# Project Brief: [Project Name]
|
|
2
|
+
|
|
3
|
+
> Fill in what you can; leave blank if unsure. When done, run `/archi.start project-brief.md` and AI will complete missing info via multiple-choice questions.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Project Overview
|
|
8
|
+
|
|
9
|
+
**Project Name**:
|
|
10
|
+
**One-line description**: [What the project is, who it serves, what problem it solves]
|
|
11
|
+
**Problem statement**: [Core pain points for target users? Where do existing solutions fall short?]
|
|
12
|
+
|
|
13
|
+
**Target users**:
|
|
14
|
+
- **Primary users**: [Role/audience]
|
|
15
|
+
- **Key characteristics**: [Skill level, usage context, behavioral patterns]
|
|
16
|
+
|
|
17
|
+
**Success metrics**: [What counts as done? e.g.: DAU 1000 / adopted by 100+ projects / P99 < 200ms]
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Core Tasks
|
|
22
|
+
|
|
23
|
+
> MVP must-have tasks (recommend 3–7), each in one sentence describing expected behavior.
|
|
24
|
+
> Detailed specs are defined in `/archi.plan`; here just clarify "what to build."
|
|
25
|
+
|
|
26
|
+
1.
|
|
27
|
+
2.
|
|
28
|
+
3.
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## Existing Design Decisions
|
|
33
|
+
|
|
34
|
+
> If you have clear ideas for specific tasks/pages/flows, describe them here. AI will treat these as final in the plan phase and will not override them.
|
|
35
|
+
> Leave blank if not applicable.
|
|
36
|
+
>
|
|
37
|
+
> Format:
|
|
38
|
+
> - **[Task/page name]**: Describe behavior, flow, constraints
|
|
39
|
+
> - May include screenshot/sketch links
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Tech Stack
|
|
44
|
+
|
|
45
|
+
> Fill in what's confirmed. Leave blank or write "recommend" for the rest; AI will recommend based on project characteristics.
|
|
46
|
+
|
|
47
|
+
**Project type**: [[__PROJECT_TYPE__]]
|
|
48
|
+
<!-- Auto-filled by archi init; if writing manually, refer to the project type table in the archi-decompose-roadmap SKILL -->
|
|
49
|
+
**Language/runtime**: [e.g.: TypeScript + Node.js 22]
|
|
50
|
+
**Core framework**: [e.g.: Next.js 15 / Fastify / Tauri]
|
|
51
|
+
**Package manager**: [e.g.: pnpm / npm / yarn / cargo]
|
|
52
|
+
**Build tool**: [e.g.: Vite / tsup / Webpack / esbuild / cargo / go build]
|
|
53
|
+
**Linter / Formatter**: [e.g.: ESLint + Prettier / Biome / ruff / clippy + rustfmt]
|
|
54
|
+
<!-- @slot:tech -->
|
|
55
|
+
**Deployment target**: [e.g.: Vercel / Docker / npm publish / binary distribution]
|
|
56
|
+
**Key third-party libraries**: [e.g.: Zod, TanStack Query, Lucia Auth]
|
|
57
|
+
|
|
58
|
+
**Technical red lines** (banned tech/approaches):
|
|
59
|
+
- [e.g.: No jQuery; no CSS-in-JS]
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## Engineering Standards
|
|
64
|
+
|
|
65
|
+
> Existing team conventions. Leave blank if unsure; AI will recommend sensible defaults based on your tech stack.
|
|
66
|
+
|
|
67
|
+
**Repository structure**: [Monorepo (Turborepo/Nx/pnpm workspaces) / single repo]
|
|
68
|
+
**Architecture pattern**: [e.g.: MFA / FSD / Clean Architecture / layered / no preference (AI recommends)]
|
|
69
|
+
**Directory structure**: [already defined → describe key dirs / none (AI generates based on pattern)]
|
|
70
|
+
**Branching strategy**: [e.g.: Trunk-based / Git Flow / GitHub Flow]
|
|
71
|
+
**Commit convention**: [e.g.: Conventional Commits (feat/fix/chore) / custom → describe]
|
|
72
|
+
**Testing preference**: [e.g.: Vitest / Jest / pytest / no special requirements]
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## Existing Resources & Context
|
|
77
|
+
|
|
78
|
+
> What already exists that AI should know—to avoid reinventing or making conflicting decisions.
|
|
79
|
+
|
|
80
|
+
**Project starting point**: [Greenfield / based on existing repo (brief status and tech debt)]
|
|
81
|
+
**Design assets**: [Figma link / design mockup screenshots / none (AI designs)]
|
|
82
|
+
**Brand guidelines**: [Existing logo/colors/fonts → describe or link / none]
|
|
83
|
+
**Existing API/backend**: [API docs link / brief available endpoints / none (build from scratch)]
|
|
84
|
+
**Third-party services**: [Confirmed services, e.g.: Auth0, Stripe, AWS S3, Resend...]
|
|
85
|
+
**Existing data**: [Existing DB/data sources? Format? Migration needed? / none]
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
<!-- @slot:style -->
|
|
90
|
+
|
|
91
|
+
## Scope & Constraints
|
|
92
|
+
|
|
93
|
+
**Explicit non-goals** (anti-goals):
|
|
94
|
+
- [e.g.: No i18n this release / no mobile adaption / no paid features]
|
|
95
|
+
|
|
96
|
+
**Hard constraints**:
|
|
97
|
+
- **Timeline**: [e.g.: 4-week MVP / no hard deadline]
|
|
98
|
+
- **Compatibility**: [e.g.: Chrome 90+ / Node 18+ / iOS 15+]
|
|
99
|
+
- **Performance**: [e.g.: First paint < 2s / API P99 < 500ms / no special requirements]
|
|
100
|
+
- **Compliance/accessibility**: [e.g.: WCAG 2.1 AA / GDPR / none]
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
## References & Inspiration
|
|
105
|
+
|
|
106
|
+
| Reference project | Reference dimension |
|
|
107
|
+
|:---|:---|
|
|
108
|
+
| [e.g.: Linear] | [Interaction UX, task management logic] |
|
|
109
|
+
| | |
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## Additional Notes
|
|
114
|
+
|
|
115
|
+
> Anything not covered above: background story, special requirements, rationale for decisions, team tech preferences, etc.
|
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
<!-- @tech:ui -->
|
|
2
|
+
**CSS/UI approach**: [e.g.: TailwindCSS + Shadcn/UI / Ant Design / plain CSS]
|
|
3
|
+
<!-- @end -->
|
|
4
|
+
|
|
5
|
+
<!-- @tech:data -->
|
|
6
|
+
**Database**: [e.g.: PostgreSQL / MongoDB / SQLite]
|
|
7
|
+
**ORM / Query Builder**: [e.g.: Prisma / Drizzle / TypeORM]
|
|
8
|
+
<!-- @end -->
|
|
9
|
+
|
|
10
|
+
<!-- @tech:api -->
|
|
11
|
+
**API style**: [e.g.: RESTful / GraphQL / gRPC / tRPC]
|
|
12
|
+
<!-- @end -->
|
|
13
|
+
|
|
14
|
+
<!-- @tech:cli -->
|
|
15
|
+
**CLI framework**: [e.g.: cac / commander / clap (Rust) / cobra (Go)]
|
|
16
|
+
**Distribution**: [e.g.: npm publish / GitHub Releases / binary]
|
|
17
|
+
<!-- @end -->
|
|
18
|
+
|
|
19
|
+
<!-- @tech:lib -->
|
|
20
|
+
**Module format**: [e.g.: ESM / CJS + ESM dual output]
|
|
21
|
+
**Target platforms**: [e.g.: browser + Node.js / Node.js only]
|
|
22
|
+
**Distribution channel**: [e.g.: npm / PyPI / crates.io]
|
|
23
|
+
<!-- @end -->
|
|
24
|
+
|
|
25
|
+
<!-- @style:ui -->
|
|
26
|
+
## Style & Tone
|
|
27
|
+
|
|
28
|
+
**Aesthetic direction** (pick the closest match; leave blank for AI to recommend):
|
|
29
|
+
<!-- Pick one, or write "custom" and describe below -->
|
|
30
|
+
<!-- saas-dark — like Linear/Vercel/Raycast: dark bg, high contrast, minimal, sharp edges -->
|
|
31
|
+
<!-- saas-light — like Notion/Stripe/GitHub: white bg, thin borders, system fonts, breathing room -->
|
|
32
|
+
<!-- dashboard — like Grafana/Datadog: info-dense, card grids, data-first -->
|
|
33
|
+
<!-- marketing — like Loom/Framer: large headings, gradients, visual impact, narrative -->
|
|
34
|
+
<!-- mobile-app — like Telegram/Bear: large radius, wide spacing, touch-friendly -->
|
|
35
|
+
<!-- editorial — like Medium/Substack: typography-first, serif fonts, reading immersion -->
|
|
36
|
+
<!-- brutalist — like Craigslist/HN: function-first, no decoration, raw -->
|
|
37
|
+
<!-- custom — describe your desired style in "Custom description" below -->
|
|
38
|
+
|
|
39
|
+
**Aesthetic direction**: [e.g.: saas-dark / saas-light / dashboard / marketing / mobile-app / editorial / brutalist / custom]
|
|
40
|
+
**Custom description**: [only for "custom", e.g.: "Spotify-like dark + green accent + card-based layout"]
|
|
41
|
+
|
|
42
|
+
**Information density**: [generous whitespace/immersive / dense/dashboard-style]
|
|
43
|
+
**Motion preference**: [subtle micro-interactions / rich animation / no animation]
|
|
44
|
+
|
|
45
|
+
### Visual Reference
|
|
46
|
+
|
|
47
|
+
> Provides aesthetic input for AI — directly impacts `ui_concept.html` quality.
|
|
48
|
+
> Fill in any of the fields below; the more you provide, the closer AI can match your vision.
|
|
49
|
+
|
|
50
|
+
**Competitor/inspiration screenshots**: [paste image / Figma link / URL]
|
|
51
|
+
**Brand palette**: [primary color Hex / gradient description / none (AI generates from aesthetic direction)]
|
|
52
|
+
**Font preference**: [e.g.: JetBrains Mono + Space Grotesk / Playfair Display / no preference (AI picks from aesthetic direction)]
|
|
53
|
+
**Icon library**: [e.g.: Lucide / Heroicons / Tabler / no preference]
|
|
54
|
+
**Forbidden styles**: [e.g.: no gradient backgrounds / no cartoon illustration / no restriction]
|
|
55
|
+
<!-- @end -->
|
|
56
|
+
|
|
57
|
+
<!-- @style:cli -->
|
|
58
|
+
## Style & Tone
|
|
59
|
+
|
|
60
|
+
**Output style**: [concise single-line / structured colorful / JSON machine-readable]
|
|
61
|
+
**Interaction mode**: [pure argument-driven / interactive prompts / hybrid]
|
|
62
|
+
**Error display**: [concise message / detailed stack / tiered (--verbose)]
|
|
63
|
+
<!-- @end -->
|
|
64
|
+
|
|
65
|
+
<!-- @style:api -->
|
|
66
|
+
## Style & Tone
|
|
67
|
+
|
|
68
|
+
**Documentation approach**: [OpenAPI/Swagger / GraphQL Schema / hand-written docs]
|
|
69
|
+
**Error response format**: [RFC 7807 / custom JSON / GraphQL errors]
|
|
70
|
+
**Versioning strategy**: [URL path /v1 / Header / no versioning]
|
|
71
|
+
<!-- @end -->
|
|
72
|
+
|
|
73
|
+
<!-- @tech:mobile -->
|
|
74
|
+
**Mobile runtime**: [e.g.: React Native 0.76 / Flutter 3 / Expo SDK 52]
|
|
75
|
+
**UI component library**: [e.g.: RN Paper / NativeWind / NativeBase / native components]
|
|
76
|
+
**Navigation**: [e.g.: React Navigation 7 / Expo Router / Go Router]
|
|
77
|
+
**Native capabilities**: [e.g.: camera, push notifications, biometrics — list what's needed]
|
|
78
|
+
**Distribution**: [e.g.: App Store + Play Store / Expo Go / TestFlight]
|
|
79
|
+
**OTA updates**: [e.g.: Expo Updates / CodePush / not needed]
|
|
80
|
+
<!-- @end -->
|
|
81
|
+
|
|
82
|
+
<!-- @tech:miniapp -->
|
|
83
|
+
**Mini program platform**: [e.g.: WeChat / Alipay / Douyin / uni-app (multi-platform)]
|
|
84
|
+
**Base library version**: [e.g.: WeChat base library 3.x / uni-app Vue3]
|
|
85
|
+
**UI component library**: [e.g.: Vant Weapp / TDesign MiniProgram / native components]
|
|
86
|
+
**Cloud development**: [e.g.: WeChat CloudBase / not used]
|
|
87
|
+
**Publishing**: [e.g.: WeChat Public Platform / review cycle expectations]
|
|
88
|
+
<!-- @end -->
|
|
89
|
+
|
|
90
|
+
<!-- @style:miniapp -->
|
|
91
|
+
## Style & Tone
|
|
92
|
+
|
|
93
|
+
**Visual guidelines**: [Follow platform design spec (WeChat Weui / Alipay / Douyin) / custom brand style]
|
|
94
|
+
**Color direction**: [brand primary color / follow platform defaults / dark mode (if platform supports)]
|
|
95
|
+
**Component style**: [native components first / custom components / mixed]
|
|
96
|
+
**Motion preference**: [system default page transitions / custom transitions / no special requirement]
|
|
97
|
+
<!-- @end -->
|
|
98
|
+
|
|
99
|
+
<!-- @tech:desktop -->
|
|
100
|
+
**Desktop runtime**: [e.g.: Tauri 2 / Electron 33]
|
|
101
|
+
**IPC communication**: [e.g.: Tauri invoke/command / Electron ipcMain+ipcRenderer]
|
|
102
|
+
**System-level capabilities**: [e.g.: system tray, global hotkeys, file associations, clipboard — list what's needed]
|
|
103
|
+
**Packaging & distribution**: [e.g.: tauri-bundler (.dmg/.msi/.deb) / electron-builder / GitHub Releases]
|
|
104
|
+
**Auto-update**: [e.g.: tauri-updater / electron-updater / not needed]
|
|
105
|
+
<!-- @end -->
|
|
106
|
+
|
|
107
|
+
<!-- @tech:extension -->
|
|
108
|
+
**Target browsers**: [e.g.: Chrome + Edge / Firefox / all platforms]
|
|
109
|
+
**Manifest version**: [V3 (recommended) / V2 (Firefox compatibility)]
|
|
110
|
+
**Extension structure**: [e.g.: Popup only / Popup + Content Script / Background + Content Script + Popup]
|
|
111
|
+
**Permission declarations**: [e.g.: storage, tabs, activeTab — list what's needed]
|
|
112
|
+
**Publishing channel**: [e.g.: Chrome Web Store / Firefox Add-ons / private distribution]
|
|
113
|
+
<!-- @end -->
|
|
114
|
+
|
|
115
|
+
<!-- @tech:realtime -->
|
|
116
|
+
**Real-time transport**: [e.g.: Socket.io / native WebSocket / SSE / WebRTC]
|
|
117
|
+
**Real-time framework/hosting**: [e.g.: Ably / Pusher / Liveblocks / self-hosted]
|
|
118
|
+
**Room/channel model**: [e.g.: subscribe by user ID / room by document ID / broadcast]
|
|
119
|
+
**[?CRDT] Conflict resolution**: [e.g.: Yjs / Automerge / not needed (broadcast only)]
|
|
120
|
+
**Offline support**: [e.g.: offline queue + reconnect sync / not needed]
|
|
121
|
+
<!-- @end -->
|
|
122
|
+
|
|
123
|
+
<!-- @tech:ai -->
|
|
124
|
+
**LLM provider**: [e.g.: OpenAI GPT-4o / Anthropic Claude / Gemini / local Ollama]
|
|
125
|
+
**AI framework**: [e.g.: Vercel AI SDK / LangChain / LlamaIndex / direct API calls]
|
|
126
|
+
**Tool/Function Calling**: [e.g.: needed (list tool names) / not needed]
|
|
127
|
+
**Memory approach**: [e.g.: vector DB (pgvector/Pinecone) / sliding window history / none]
|
|
128
|
+
**[?MCP] MCP protocol**: [e.g.: @modelcontextprotocol/sdk / not needed]
|
|
129
|
+
**Streaming output**: [e.g.: SSE streaming / batch response]
|
|
130
|
+
<!-- @end -->
|
|
131
|
+
|
|
132
|
+
<!-- @style:mobile -->
|
|
133
|
+
## Style & Tone
|
|
134
|
+
|
|
135
|
+
**Visual keywords**: [e.g.: native feel, lightweight, immersive]
|
|
136
|
+
**Sizing approach**: [responsive dp/sp / fixed 375pt design base]
|
|
137
|
+
**Dark mode**: [follow system / light only / dark only]
|
|
138
|
+
**Motion preference**: [system native animations / custom transitions / no special requirement]
|
|
139
|
+
**Accessibility**: [e.g.: VoiceOver / TalkBack support / no special requirement]
|
|
140
|
+
<!-- @end -->
|
|
141
|
+
|
|
142
|
+
<!-- @style:desktop -->
|
|
143
|
+
## Style & Tone
|
|
144
|
+
|
|
145
|
+
**Visual style**: [e.g.: native OS style (Fluent/HIG) / custom brand style]
|
|
146
|
+
**Window management**: [e.g.: single main window + tray / multi-window / fullscreen-first]
|
|
147
|
+
**Dark mode**: [follow system / dark only / light only]
|
|
148
|
+
**Menu bar / system tray**: [e.g.: menu bar icon + quick actions / tray icon only / not needed]
|
|
149
|
+
<!-- @end -->
|
|
150
|
+
|
|
151
|
+
<!-- @style:extension -->
|
|
152
|
+
## Style & Tone
|
|
153
|
+
|
|
154
|
+
**Popup size convention**: [e.g.: 320×480px / 400×600px / adaptive]
|
|
155
|
+
**Visual style**: [e.g.: minimal card / blend with host page / independent brand]
|
|
156
|
+
**Content script injection style**: [e.g.: floating button / sidebar / highlight overlay]
|
|
157
|
+
<!-- @end -->
|
|
158
|
+
|
|
159
|
+
<!-- @style:realtime -->
|
|
160
|
+
## Style & Tone
|
|
161
|
+
|
|
162
|
+
**Collaboration awareness UI**: [e.g.: live cursors, user avatar list, typing indicators — list what's needed]
|
|
163
|
+
**Sync/conflict state display**: [e.g.: optimistic update + silent sync / explicit "syncing" indicator]
|
|
164
|
+
**Offline notification**: [e.g.: top banner / silent reconnect]
|
|
165
|
+
<!-- @end -->
|
|
166
|
+
|
|
167
|
+
<!-- @style:ai -->
|
|
168
|
+
## Style & Tone
|
|
169
|
+
|
|
170
|
+
**Interaction mode**: [conversational (chat UI) / tool-style (command + result) / hybrid]
|
|
171
|
+
**Streaming output display**: [e.g.: character-by-character typewriter / chunked loading / batch response]
|
|
172
|
+
**Error / fallback UX**: [e.g.: show fallback model name / retry button / silent degradation]
|
|
173
|
+
<!-- @end -->
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
{
|
|
2
|
+
"scope": "[?Data]",
|
|
3
|
+
"models": [
|
|
4
|
+
{
|
|
5
|
+
"name": "[ModelName]",
|
|
6
|
+
"description": "[One-line description]",
|
|
7
|
+
"fields": [
|
|
8
|
+
{
|
|
9
|
+
"name": "id",
|
|
10
|
+
"type": "string",
|
|
11
|
+
"modifiers": "PK",
|
|
12
|
+
"description": "Unique identifier"
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
"name": "[fieldName]",
|
|
16
|
+
"type": "[type]",
|
|
17
|
+
"modifiers": "[nullable | unique | index | ...]",
|
|
18
|
+
"description": "[Field description]"
|
|
19
|
+
}
|
|
20
|
+
]
|
|
21
|
+
}
|
|
22
|
+
],
|
|
23
|
+
"relationships": [
|
|
24
|
+
{
|
|
25
|
+
"from": "[ModelA]",
|
|
26
|
+
"to": "[ModelB]",
|
|
27
|
+
"type": "[1:1 | 1:N | M:N | self-ref]",
|
|
28
|
+
"description": "[Relationship description]"
|
|
29
|
+
}
|
|
30
|
+
]
|
|
31
|
+
}
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
{
|
|
2
|
+
"_comment": "Generated by /archi.start from Brief 'Style & Tone' and 'Visual Reference'. All values must be derived from the Brief — never copy template defaults.",
|
|
3
|
+
"scope": "[?UI]",
|
|
4
|
+
"status": "drafting",
|
|
5
|
+
|
|
6
|
+
"aestheticDirection": {
|
|
7
|
+
"preset": "",
|
|
8
|
+
"_presetOptions": "saas-dark | saas-light | dashboard | marketing | mobile-app | editorial | brutalist | custom",
|
|
9
|
+
"customDescription": ""
|
|
10
|
+
},
|
|
11
|
+
|
|
12
|
+
"primitivePalette": {
|
|
13
|
+
"neutral": {
|
|
14
|
+
"50": "",
|
|
15
|
+
"100": "",
|
|
16
|
+
"200": "",
|
|
17
|
+
"300": "",
|
|
18
|
+
"400": "",
|
|
19
|
+
"500": "",
|
|
20
|
+
"600": "",
|
|
21
|
+
"700": "",
|
|
22
|
+
"800": "",
|
|
23
|
+
"900": "",
|
|
24
|
+
"950": ""
|
|
25
|
+
},
|
|
26
|
+
"brand": {}
|
|
27
|
+
},
|
|
28
|
+
|
|
29
|
+
"semanticTokens": {
|
|
30
|
+
"colors": [
|
|
31
|
+
{
|
|
32
|
+
"token": "Background",
|
|
33
|
+
"light": "",
|
|
34
|
+
"dark": "",
|
|
35
|
+
"usage": "page background"
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"token": "Surface",
|
|
39
|
+
"light": "",
|
|
40
|
+
"dark": "",
|
|
41
|
+
"usage": "cards, modals, sidebars"
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"token": "Primary",
|
|
45
|
+
"light": "Brand-?00",
|
|
46
|
+
"dark": "Brand-?00",
|
|
47
|
+
"usage": "primary buttons, active state"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"token": "Text-Main",
|
|
51
|
+
"light": "",
|
|
52
|
+
"dark": "",
|
|
53
|
+
"usage": "body, headings"
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
"token": "Text-Muted",
|
|
57
|
+
"light": "",
|
|
58
|
+
"dark": "",
|
|
59
|
+
"usage": "secondary text, captions"
|
|
60
|
+
},
|
|
61
|
+
{
|
|
62
|
+
"token": "Border",
|
|
63
|
+
"light": "",
|
|
64
|
+
"dark": "",
|
|
65
|
+
"usage": "borders, dividers"
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
"token": "Destructive",
|
|
69
|
+
"light": "",
|
|
70
|
+
"dark": "",
|
|
71
|
+
"usage": "delete, error states"
|
|
72
|
+
}
|
|
73
|
+
],
|
|
74
|
+
"typography": [
|
|
75
|
+
{
|
|
76
|
+
"role": "H1",
|
|
77
|
+
"fontFamily": "",
|
|
78
|
+
"size": "",
|
|
79
|
+
"weight": "",
|
|
80
|
+
"lineHeight": ""
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"role": "H2",
|
|
84
|
+
"fontFamily": "",
|
|
85
|
+
"size": "",
|
|
86
|
+
"weight": "",
|
|
87
|
+
"lineHeight": ""
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
"role": "Body",
|
|
91
|
+
"fontFamily": "",
|
|
92
|
+
"size": "",
|
|
93
|
+
"weight": "",
|
|
94
|
+
"lineHeight": ""
|
|
95
|
+
},
|
|
96
|
+
{
|
|
97
|
+
"role": "Small",
|
|
98
|
+
"fontFamily": "",
|
|
99
|
+
"size": "",
|
|
100
|
+
"weight": "",
|
|
101
|
+
"lineHeight": ""
|
|
102
|
+
}
|
|
103
|
+
]
|
|
104
|
+
},
|
|
105
|
+
|
|
106
|
+
"layout": {
|
|
107
|
+
"radius": {
|
|
108
|
+
"sm": "",
|
|
109
|
+
"md": "",
|
|
110
|
+
"lg": "",
|
|
111
|
+
"full": "9999px"
|
|
112
|
+
},
|
|
113
|
+
"shadow": {
|
|
114
|
+
"sm": "",
|
|
115
|
+
"md": ""
|
|
116
|
+
},
|
|
117
|
+
"spacing": {
|
|
118
|
+
"unit": "4px",
|
|
119
|
+
"scale": [1, 2, 3, 4, 6, 8, 12, 16]
|
|
120
|
+
}
|
|
121
|
+
},
|
|
122
|
+
|
|
123
|
+
"mode": {
|
|
124
|
+
"default": "",
|
|
125
|
+
"support": []
|
|
126
|
+
},
|
|
127
|
+
|
|
128
|
+
"motion": {
|
|
129
|
+
"preference": "",
|
|
130
|
+
"easing": {
|
|
131
|
+
"standard": "",
|
|
132
|
+
"decelerate": "",
|
|
133
|
+
"accelerate": ""
|
|
134
|
+
},
|
|
135
|
+
"duration": {
|
|
136
|
+
"instant": "",
|
|
137
|
+
"fast": "",
|
|
138
|
+
"normal": "",
|
|
139
|
+
"slow": "",
|
|
140
|
+
"pageTransition": ""
|
|
141
|
+
},
|
|
142
|
+
"patterns": {}
|
|
143
|
+
},
|
|
144
|
+
|
|
145
|
+
"illustration": {
|
|
146
|
+
"style": "",
|
|
147
|
+
"iconLibrary": "",
|
|
148
|
+
"emptyStateAsset": ""
|
|
149
|
+
}
|
|
150
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
{
|
|
2
|
+
"entities": [
|
|
3
|
+
{
|
|
4
|
+
"term": "[Business Term]",
|
|
5
|
+
"definition": "[One-line definition]",
|
|
6
|
+
"codeName": "[PascalCase / camelCase]",
|
|
7
|
+
"forbiddenSynonyms": [],
|
|
8
|
+
"reference": "[Source: spec / vision / task ID]"
|
|
9
|
+
}
|
|
10
|
+
],
|
|
11
|
+
"verbs": [
|
|
12
|
+
{
|
|
13
|
+
"verb": "[Business Action]",
|
|
14
|
+
"definition": "[One-line definition]",
|
|
15
|
+
"codeName": "[camelCase]",
|
|
16
|
+
"context": "[Usage context]",
|
|
17
|
+
"reference": "[Source]"
|
|
18
|
+
}
|
|
19
|
+
],
|
|
20
|
+
"utilities": [
|
|
21
|
+
{
|
|
22
|
+
"name": "[Utility name, e.g. logger]",
|
|
23
|
+
"path": "[File path, e.g. src/utils/logger.ts]",
|
|
24
|
+
"purpose": "[Purpose]",
|
|
25
|
+
"replaces": "[Raw API it replaces, e.g. console.log]"
|
|
26
|
+
}
|
|
27
|
+
],
|
|
28
|
+
"components [?UI]": [
|
|
29
|
+
{
|
|
30
|
+
"name": "[Component Name]",
|
|
31
|
+
"path": "[File Path]",
|
|
32
|
+
"purpose": "[Purpose]"
|
|
33
|
+
}
|
|
34
|
+
]
|
|
35
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
{
|
|
2
|
+
"protocolMapping [?API]": [
|
|
3
|
+
{
|
|
4
|
+
"statusCode": "[400 | EXIT_1 | ...]",
|
|
5
|
+
"code": "[ERR_VALIDATION]",
|
|
6
|
+
"meaning": "[Meaning]",
|
|
7
|
+
"action": "[Caller behavior: Toast / Exit / Retry / ...]"
|
|
8
|
+
}
|
|
9
|
+
],
|
|
10
|
+
"businessErrors": [
|
|
11
|
+
{
|
|
12
|
+
"module": "[MODULE]",
|
|
13
|
+
"code": "ERR_[MODULE]_[REASON]",
|
|
14
|
+
"statusCode": "",
|
|
15
|
+
"message": "[User/developer-facing error description]",
|
|
16
|
+
"recovery": "[Recovery suggestion]"
|
|
17
|
+
}
|
|
18
|
+
]
|
|
19
|
+
}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
{
|
|
2
|
+
"governance": {
|
|
3
|
+
"coreRules": [
|
|
4
|
+
{
|
|
5
|
+
"file": "00_system.md",
|
|
6
|
+
"role": "System Role",
|
|
7
|
+
"when": "At the start of every session (Identity, Core Principles)"
|
|
8
|
+
},
|
|
9
|
+
{
|
|
10
|
+
"file": "01_workflow.md",
|
|
11
|
+
"role": "SOP",
|
|
12
|
+
"when": "Decides current task flow (Task vs Fix) & Acceptance Criteria"
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
"file": "02_tech_stack.md",
|
|
16
|
+
"role": "Tech Stack",
|
|
17
|
+
"when": "Tech choices, coding standards, engineering governance"
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"file": "03_data_governance.md",
|
|
21
|
+
"role": "Data Governance",
|
|
22
|
+
"when": "When reading/writing global JSON data files"
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"file": "04_cli_tools.md",
|
|
26
|
+
"role": "CLI Reference",
|
|
27
|
+
"when": "When executing Terminal Gate commands (npx archi task/plan/render syntax reference)"
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"file": "99_context_glue.md",
|
|
31
|
+
"role": "Context Bridge",
|
|
32
|
+
"when": "Automatically links context docs when touching code"
|
|
33
|
+
}
|
|
34
|
+
],
|
|
35
|
+
"globalReference": [
|
|
36
|
+
{
|
|
37
|
+
"file": "roadmap.json",
|
|
38
|
+
"role": "Roadmap",
|
|
39
|
+
"content": "Progress tracking, milestones, technical debt management"
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
"file": "vision.md",
|
|
43
|
+
"role": "Vision",
|
|
44
|
+
"content": "Vision, North Star Metric, Design Philosophy"
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"file": "map.json",
|
|
48
|
+
"role": "Map (This file)",
|
|
49
|
+
"content": "Directory structure, file index, logical topology"
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
"file": "dictionary.json",
|
|
53
|
+
"role": "Dictionary",
|
|
54
|
+
"content": "Business glossary, shared component registry"
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"file": "design_tokens.json",
|
|
58
|
+
"role": "Visuals [?UI]",
|
|
59
|
+
"content": "Colors, typography, spacing variables"
|
|
60
|
+
},
|
|
61
|
+
{
|
|
62
|
+
"file": "data_snapshot.json",
|
|
63
|
+
"role": "Data [?Data]",
|
|
64
|
+
"content": "Database Schema snapshot"
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"file": "error_codes.json",
|
|
68
|
+
"role": "Errors",
|
|
69
|
+
"content": "Error codes & protocol contracts"
|
|
70
|
+
}
|
|
71
|
+
]
|
|
72
|
+
},
|
|
73
|
+
"featureDocs": [
|
|
74
|
+
{
|
|
75
|
+
"file": "spec.md",
|
|
76
|
+
"category": "Specification",
|
|
77
|
+
"purpose": "Business Logic, Algorithms, Acceptance Criteria (Logic)"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"file": "ui.md",
|
|
81
|
+
"category": "UI/UX",
|
|
82
|
+
"purpose": "Task-level UI scope declaration — references screen IDs from ui_context.md to define this task's screen/component scope"
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"file": "plan.json",
|
|
86
|
+
"category": "Plan",
|
|
87
|
+
"purpose": "Detailed Step Breakdown & Test Cases (Execution)"
|
|
88
|
+
}
|
|
89
|
+
],
|
|
90
|
+
"directoryMapping": [],
|
|
91
|
+
"logicalTopology": [],
|
|
92
|
+
"criticalUserJourneys": [],
|
|
93
|
+
"featureRelations": []
|
|
94
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 1,
|
|
3
|
+
"projectStatus": "planning",
|
|
4
|
+
"lastUpdated": "YYYY-MM-DD",
|
|
5
|
+
"phases": [
|
|
6
|
+
{
|
|
7
|
+
"id": "phase-1",
|
|
8
|
+
"name": "Infrastructure",
|
|
9
|
+
"tasks": [
|
|
10
|
+
{
|
|
11
|
+
"id": "INF-01",
|
|
12
|
+
"title": "Project Scaffolding",
|
|
13
|
+
"status": "pending",
|
|
14
|
+
"description": "",
|
|
15
|
+
"goal": "",
|
|
16
|
+
"deps": [],
|
|
17
|
+
"tag": "Infra",
|
|
18
|
+
"slug": "Project_Scaffolding"
|
|
19
|
+
}
|
|
20
|
+
]
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
"id": "phase-2",
|
|
24
|
+
"name": "Core Features",
|
|
25
|
+
"tasks": [
|
|
26
|
+
{
|
|
27
|
+
"id": "FEAT-01",
|
|
28
|
+
"title": "Example Task",
|
|
29
|
+
"status": "blocked",
|
|
30
|
+
"description": "",
|
|
31
|
+
"goal": "",
|
|
32
|
+
"deps": ["INF-01"],
|
|
33
|
+
"tag": "Core",
|
|
34
|
+
"slug": "Example_Task"
|
|
35
|
+
}
|
|
36
|
+
]
|
|
37
|
+
}
|
|
38
|
+
]
|
|
39
|
+
}
|