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,135 @@
|
|
|
1
|
+
{
|
|
2
|
+
"_comment": "由 /archi.start 基于 Brief「风格与调性」和「视觉参考」生成。所有值须从 Brief 推导,禁直接复用任何模板默认值。",
|
|
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
|
+
{ "token": "Background", "light": "", "dark": "", "usage": "页面背景" },
|
|
32
|
+
{
|
|
33
|
+
"token": "Surface",
|
|
34
|
+
"light": "",
|
|
35
|
+
"dark": "",
|
|
36
|
+
"usage": "卡片, 弹窗, 侧边栏"
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"token": "Primary",
|
|
40
|
+
"light": "Brand-?00",
|
|
41
|
+
"dark": "Brand-?00",
|
|
42
|
+
"usage": "主按钮, 激活状态"
|
|
43
|
+
},
|
|
44
|
+
{ "token": "Text-Main", "light": "", "dark": "", "usage": "正文, 标题" },
|
|
45
|
+
{
|
|
46
|
+
"token": "Text-Muted",
|
|
47
|
+
"light": "",
|
|
48
|
+
"dark": "",
|
|
49
|
+
"usage": "次要信息, 注释"
|
|
50
|
+
},
|
|
51
|
+
{ "token": "Border", "light": "", "dark": "", "usage": "边框, 分割线" },
|
|
52
|
+
{
|
|
53
|
+
"token": "Destructive",
|
|
54
|
+
"light": "",
|
|
55
|
+
"dark": "",
|
|
56
|
+
"usage": "删除, 错误提示"
|
|
57
|
+
}
|
|
58
|
+
],
|
|
59
|
+
"typography": [
|
|
60
|
+
{
|
|
61
|
+
"role": "H1",
|
|
62
|
+
"fontFamily": "",
|
|
63
|
+
"size": "",
|
|
64
|
+
"weight": "",
|
|
65
|
+
"lineHeight": ""
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
"role": "H2",
|
|
69
|
+
"fontFamily": "",
|
|
70
|
+
"size": "",
|
|
71
|
+
"weight": "",
|
|
72
|
+
"lineHeight": ""
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"role": "Body",
|
|
76
|
+
"fontFamily": "",
|
|
77
|
+
"size": "",
|
|
78
|
+
"weight": "",
|
|
79
|
+
"lineHeight": ""
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"role": "Small",
|
|
83
|
+
"fontFamily": "",
|
|
84
|
+
"size": "",
|
|
85
|
+
"weight": "",
|
|
86
|
+
"lineHeight": ""
|
|
87
|
+
}
|
|
88
|
+
]
|
|
89
|
+
},
|
|
90
|
+
|
|
91
|
+
"layout": {
|
|
92
|
+
"radius": {
|
|
93
|
+
"sm": "",
|
|
94
|
+
"md": "",
|
|
95
|
+
"lg": "",
|
|
96
|
+
"full": "9999px"
|
|
97
|
+
},
|
|
98
|
+
"shadow": {
|
|
99
|
+
"sm": "",
|
|
100
|
+
"md": ""
|
|
101
|
+
},
|
|
102
|
+
"spacing": {
|
|
103
|
+
"unit": "4px",
|
|
104
|
+
"scale": [1, 2, 3, 4, 6, 8, 12, 16]
|
|
105
|
+
}
|
|
106
|
+
},
|
|
107
|
+
|
|
108
|
+
"mode": {
|
|
109
|
+
"default": "",
|
|
110
|
+
"support": []
|
|
111
|
+
},
|
|
112
|
+
|
|
113
|
+
"motion": {
|
|
114
|
+
"preference": "",
|
|
115
|
+
"easing": {
|
|
116
|
+
"standard": "",
|
|
117
|
+
"decelerate": "",
|
|
118
|
+
"accelerate": ""
|
|
119
|
+
},
|
|
120
|
+
"duration": {
|
|
121
|
+
"instant": "",
|
|
122
|
+
"fast": "",
|
|
123
|
+
"normal": "",
|
|
124
|
+
"slow": "",
|
|
125
|
+
"pageTransition": ""
|
|
126
|
+
},
|
|
127
|
+
"patterns": {}
|
|
128
|
+
},
|
|
129
|
+
|
|
130
|
+
"illustration": {
|
|
131
|
+
"style": "",
|
|
132
|
+
"iconLibrary": "",
|
|
133
|
+
"emptyStateAsset": ""
|
|
134
|
+
}
|
|
135
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
{
|
|
2
|
+
"entities": [
|
|
3
|
+
{
|
|
4
|
+
"term": "[业务术语]",
|
|
5
|
+
"definition": "[一句话定义]",
|
|
6
|
+
"codeName": "[PascalCase / camelCase]",
|
|
7
|
+
"forbiddenSynonyms": [],
|
|
8
|
+
"reference": "[来源: spec / vision / task ID]"
|
|
9
|
+
}
|
|
10
|
+
],
|
|
11
|
+
"verbs": [
|
|
12
|
+
{
|
|
13
|
+
"verb": "[业务动作]",
|
|
14
|
+
"definition": "[一句话定义]",
|
|
15
|
+
"codeName": "[camelCase]",
|
|
16
|
+
"context": "[使用场景]",
|
|
17
|
+
"reference": "[来源]"
|
|
18
|
+
}
|
|
19
|
+
],
|
|
20
|
+
"utilities": [
|
|
21
|
+
{
|
|
22
|
+
"name": "[工具名, 如 logger]",
|
|
23
|
+
"path": "[文件路径, 如 src/utils/logger.ts]",
|
|
24
|
+
"purpose": "[用途说明]",
|
|
25
|
+
"replaces": "[替代的原始 API, 如 console.log]"
|
|
26
|
+
}
|
|
27
|
+
],
|
|
28
|
+
"components [?UI]": [
|
|
29
|
+
{
|
|
30
|
+
"name": "[组件名]",
|
|
31
|
+
"path": "[文件路径]",
|
|
32
|
+
"purpose": "[用途说明]"
|
|
33
|
+
}
|
|
34
|
+
]
|
|
35
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
{
|
|
2
|
+
"protocolMapping [?API]": [
|
|
3
|
+
{
|
|
4
|
+
"statusCode": "[400 | EXIT_1 | ...]",
|
|
5
|
+
"code": "[ERR_VALIDATION]",
|
|
6
|
+
"meaning": "[含义]",
|
|
7
|
+
"action": "[调用方行为: Toast / Exit / Retry / ...]"
|
|
8
|
+
}
|
|
9
|
+
],
|
|
10
|
+
"businessErrors": [
|
|
11
|
+
{
|
|
12
|
+
"module": "[MODULE]",
|
|
13
|
+
"code": "ERR_[MODULE]_[REASON]",
|
|
14
|
+
"statusCode": "",
|
|
15
|
+
"message": "[用户/开发者可见的错误描述]",
|
|
16
|
+
"recovery": "[恢复建议]"
|
|
17
|
+
}
|
|
18
|
+
]
|
|
19
|
+
}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
{
|
|
2
|
+
"governance": {
|
|
3
|
+
"coreRules": [
|
|
4
|
+
{
|
|
5
|
+
"file": "00_system.md",
|
|
6
|
+
"role": "System Role",
|
|
7
|
+
"when": "每次对话开始时 (身份设定, 核心原则)"
|
|
8
|
+
},
|
|
9
|
+
{
|
|
10
|
+
"file": "01_workflow.md",
|
|
11
|
+
"role": "SOP",
|
|
12
|
+
"when": "决定当前任务流程 (Task vs Fix) 与验收标准"
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
"file": "02_tech_stack.md",
|
|
16
|
+
"role": "Tech Stack",
|
|
17
|
+
"when": "技术选型、代码规范、工程治理标准"
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"file": "03_data_governance.md",
|
|
21
|
+
"role": "Data Governance",
|
|
22
|
+
"when": "读写全局 JSON 数据文件时"
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
"file": "04_cli_tools.md",
|
|
26
|
+
"role": "CLI Reference",
|
|
27
|
+
"when": "执行 Terminal Gate 命令时 (npx archi task/plan/render 语法速查)"
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"file": "99_context_glue.md",
|
|
31
|
+
"role": "Context Bridge",
|
|
32
|
+
"when": "触碰代码时,自动关联上下文文档"
|
|
33
|
+
}
|
|
34
|
+
],
|
|
35
|
+
"globalReference": [
|
|
36
|
+
{
|
|
37
|
+
"file": "roadmap.json",
|
|
38
|
+
"role": "Roadmap",
|
|
39
|
+
"content": "进度追踪、里程碑、技术债管理"
|
|
40
|
+
},
|
|
41
|
+
{
|
|
42
|
+
"file": "vision.md",
|
|
43
|
+
"role": "Vision",
|
|
44
|
+
"content": "愿景、北极星指标、设计哲学"
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"file": "map.json",
|
|
48
|
+
"role": "Map (本文件)",
|
|
49
|
+
"content": "目录结构、文件索引、逻辑拓扑"
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
"file": "dictionary.json",
|
|
53
|
+
"role": "Dictionary",
|
|
54
|
+
"content": "业务术语、公共组件注册表"
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"file": "design_tokens.json",
|
|
58
|
+
"role": "Visuals [?UI]",
|
|
59
|
+
"content": "颜色、字体、间距变量"
|
|
60
|
+
},
|
|
61
|
+
{
|
|
62
|
+
"file": "data_snapshot.json",
|
|
63
|
+
"role": "Data [?Data]",
|
|
64
|
+
"content": "数据库 Schema 镜像"
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"file": "error_codes.json",
|
|
68
|
+
"role": "Errors",
|
|
69
|
+
"content": "错误码与协议契约"
|
|
70
|
+
}
|
|
71
|
+
]
|
|
72
|
+
},
|
|
73
|
+
"featureDocs": [
|
|
74
|
+
{
|
|
75
|
+
"file": "spec.md",
|
|
76
|
+
"category": "Specification",
|
|
77
|
+
"purpose": "业务逻辑、算法、验收标准 (Logic)"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"file": "ui.md",
|
|
81
|
+
"category": "UI/UX",
|
|
82
|
+
"purpose": "任务级 UI 范围声明 — 引用 ui_context.md 中的屏幕 ID,指定本任务涵盖的屏幕/组件范围"
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"file": "plan.json",
|
|
86
|
+
"category": "Plan",
|
|
87
|
+
"purpose": "详细步骤拆解与测试用例 (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
|
+
}
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Project Constitution: Vision, Personas, Principles & Boundaries.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Product Vision: [项目名称]
|
|
6
|
+
|
|
7
|
+
> **Version:** 1.0.0
|
|
8
|
+
> **Status:** Active
|
|
9
|
+
> **Role:** The "Constitution" of the project. All Tasks and Specs must align with this.
|
|
10
|
+
|
|
11
|
+
## 1. Core Vision (核心愿景)
|
|
12
|
+
|
|
13
|
+
**Elevator Pitch:**
|
|
14
|
+
[产品名称] 是一个 [目标市场/类别] 平台,旨在帮助 [目标用户] 解决 [核心痛点],通过 [核心解决方案/独特点] 实现 [最终价值]。
|
|
15
|
+
|
|
16
|
+
**North Star Metric (北极星指标):**
|
|
17
|
+
|
|
18
|
+
* [指标名称]: [描述 - 例如:用户每日专注时长]
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 2. Target Audience (目标用户与画像)
|
|
23
|
+
|
|
24
|
+
### Primary Persona (核心用户)
|
|
25
|
+
|
|
26
|
+
* **Role:** [例如:备考的学生]
|
|
27
|
+
* **Key Traits:** [关键词]
|
|
28
|
+
* **Pain Points:**
|
|
29
|
+
* [痛点 1]
|
|
30
|
+
* [痛点 2]
|
|
31
|
+
* **Goals:**
|
|
32
|
+
* [希望达成的结果]
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## 3. Product Principles (产品原则)
|
|
37
|
+
|
|
38
|
+
* **[原则 1]:** [例如:极简优先 - 任何增加点击的操作都需要额外理由]
|
|
39
|
+
* **[原则 2]:** [例如:鼓励而非惩罚 - 完不成任务时给鼓励,而不是红色的警告]
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## 4. Design & Experience (设计与体验语言) [?UI]
|
|
44
|
+
|
|
45
|
+
> **Note:** 本节仅适用于有 UI 的项目。具体色值和圆角定义请严格参阅 `[[__DOCS_DIR__]]/global/design_tokens.json`。
|
|
46
|
+
|
|
47
|
+
### Visual Style (视觉风格)
|
|
48
|
+
|
|
49
|
+
* **Keywords:** [例如:温暖、专注、无干扰]
|
|
50
|
+
* **Density:** [例如:大留白,沉浸式]
|
|
51
|
+
* **Animation:** [例如:轻微的微交互,不要花哨的转场]
|
|
52
|
+
|
|
53
|
+
### Tone of Voice (文案语调)
|
|
54
|
+
|
|
55
|
+
* **Personality:** [例如:像一个陪读的伙伴,而不是严厉的老师]
|
|
56
|
+
* **Do's:** [例如:用"我们一起"代替"你应该"]
|
|
57
|
+
* **Don'ts:** [例如:不要使用机械的错误码报错]
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## 5. Boundaries (边界与反目标)
|
|
62
|
+
|
|
63
|
+
### In Scope (核心范围)
|
|
64
|
+
|
|
65
|
+
* [核心功能 A]
|
|
66
|
+
* [核心功能 B]
|
|
67
|
+
|
|
68
|
+
### Out of Scope (明确不做)
|
|
69
|
+
|
|
70
|
+
* **[反目标 1]:** [例如:不做社交排行榜]
|
|
71
|
+
* **[反目标 2]:** [例如:不提供深色模式切换(默认即深色)]
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## 🤖 AI Maintenance Guide
|
|
76
|
+
|
|
77
|
+
**Trigger**: 仅在项目初始化 (`/archi.start`) 或重大战略转型 (`/archi.revise`) 时修改。
|
|
78
|
+
|
|
79
|
+
**Action**:
|
|
80
|
+
1. **Alignment**: 确保 Section 3 (Principles) 与 `02_tech_stack.md` 中的技术选型不冲突。
|
|
81
|
+
2. **Completeness**: 必须填满所有 `[ ]` 占位符,严禁保留 "Example" 字样。
|
|
82
|
+
3. **Consistency**: 所有的 Task Spec (`.spec.md`) 都必须引用此文件的 Vision 以确保不跑题。
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
<protocol_audit>
|
|
2
|
+
**Trigger**: `/archi.audit [id]`
|
|
3
|
+
**Goal**: 独立深度代码审查。带 `<id>` 审查该任务的代码实现;无 `<id>` 执行项目级体检。不修改代码,仅输出审查报告与修复工单。
|
|
4
|
+
|
|
5
|
+
<meta>
|
|
6
|
+
<style>Investigative, Thorough, Evidence-Based</style>
|
|
7
|
+
<language>简体中文</language>
|
|
8
|
+
<principles>
|
|
9
|
+
1. **Read-Only**: 禁改任何代码文件。审查 ≠ 修复。
|
|
10
|
+
2. **Evidence-Based**: 每个发现须附文件路径、行号、代码片段。
|
|
11
|
+
3. **Actionable Output**: 每个问题须附推荐修复命令(`/archi.fix`, `/archi.edit` 等)。
|
|
12
|
+
4. **Vision Anchored**: 始终以 `vision.md` 为方向基准,检测偏离。
|
|
13
|
+
5. **Report Persistence**: 审查结果须写入文件 — 任务级 → `tasks/<id>_*/audit.md`(覆盖),项目级 → `audits/YYYY-MM-DD.md`(按日期存档,同日覆盖)。
|
|
14
|
+
</principles>
|
|
15
|
+
</meta>
|
|
16
|
+
|
|
17
|
+
<step_1_resolve>
|
|
18
|
+
**Role**: 系统分析师
|
|
19
|
+
**Mode Gate**:
|
|
20
|
+
|
|
21
|
+
| 输入 | 模式 | 后续步骤 |
|
|
22
|
+
|:---|:---|:---|
|
|
23
|
+
| `/archi.audit <id>` | 任务级深度审查 | step_2_task → step_3_report |
|
|
24
|
+
| `/archi.audit` | 项目级体检 | step_2_project → step_3_report |
|
|
25
|
+
|
|
26
|
+
**任务级 — Resolve ID**:
|
|
27
|
+
1. 从 `[[__DOCS_DIR__]]/global/roadmap.json` 解析 `<id>` → Task Name、Slug、状态。
|
|
28
|
+
2. **Status Gate** — 仅 `active` 或 `done` 可审查:
|
|
29
|
+
|
|
30
|
+
| 状态 | 处理 |
|
|
31
|
+
|:---|:---|
|
|
32
|
+
| `active` / `done` | 通过 |
|
|
33
|
+
| `pending` | 拒绝 — 无代码可审查,先运行 `/archi.plan` + `/archi.code` |
|
|
34
|
+
| `blocked` | 拒绝 — 前置依赖未完成 |
|
|
35
|
+
|
|
36
|
+
3. **Load Context**:
|
|
37
|
+
- `[[__DOCS_DIR__]]/global/vision.md` — 项目方向基准
|
|
38
|
+
- `[[__DOCS_DIR__]]/tasks/<id>_<Slug>/spec.md` — 功能逻辑
|
|
39
|
+
- `[[__DOCS_DIR__]]/tasks/<id>_<Slug>/plan.json` — 任务清单
|
|
40
|
+
- `[[__DOCS_DIR__]]/tasks/<id>_<Slug>/ui.md` — 任务 UI 范围声明(如存在)
|
|
41
|
+
- [?UI] `[[__DOCS_DIR__]]/global/ui_context.md` — AI 屏幕索引(定位对应屏幕 ID)
|
|
42
|
+
- [?UI] `[[__DOCS_DIR__]]/global/ui_concept.html` — 只读视觉参考(#10 合规对比的视觉标准源)
|
|
43
|
+
- `[[__DOCS_DIR__]]/tasks/<id>_<Slug>/audit.md` — 上次审计报告(如存在,用于对比)
|
|
44
|
+
- `02_tech_stack.md` — 技术红线
|
|
45
|
+
- [?UI] `[[__DOCS_DIR__]]/global/design_tokens.json`
|
|
46
|
+
- [?Data] `[[__DOCS_DIR__]]/global/data_snapshot.json`
|
|
47
|
+
4. 读取该任务对应的所有代码文件。
|
|
48
|
+
|
|
49
|
+
**项目级 — Load Overview**:
|
|
50
|
+
1. 读取 `[[__DOCS_DIR__]]/global/vision.md`、`roadmap.json`、`map.json`。
|
|
51
|
+
2. 读取 `02_tech_stack.md`。
|
|
52
|
+
3. 扫描 `[[__DOCS_DIR__]]/tasks/` 目录结构。
|
|
53
|
+
4. 读取项目代码入口文件与关键模块。
|
|
54
|
+
|
|
55
|
+
**Output**: 审查范围与上下文清单。
|
|
56
|
+
</step_1_resolve>
|
|
57
|
+
|
|
58
|
+
<step_2_task>
|
|
59
|
+
**Role**: 首席审计官
|
|
60
|
+
**Scope**: 任务级深度代码审查(仅 `/archi.audit <id>` 时执行)。
|
|
61
|
+
|
|
62
|
+
逐维度审查,每个发现须附 `文件:行号` + 代码片段 + 严重级别:
|
|
63
|
+
|
|
64
|
+
| # | 维度 | 审查要点 |
|
|
65
|
+
|:---|:---|:---|
|
|
66
|
+
| 1 | **Vision 对齐** | 实现方向与 `vision.md` 有无冲突或偏离 |
|
|
67
|
+
| 2 | **Spec 完整性** | 代码是否覆盖 `spec.md` 全部场景与边界 |
|
|
68
|
+
| 3 | **Plan 真实性** | 标记 `done` 的任务是否在代码中落地(防虚标) |
|
|
69
|
+
| 4 | **逻辑正确性** | 业务逻辑错误、矛盾、遗漏分支、状态机缺陷 |
|
|
70
|
+
| 5 | **Bug 猎杀** | 空值/undefined、竞态、资源泄漏、死循环、off-by-one |
|
|
71
|
+
| 6 | **错误处理** | 吞错、静默失败、错误传播链完整性、用户可见反馈 |
|
|
72
|
+
| 7 | **Tech Stack 合规** | 对照 `02_tech_stack.md`:违禁模式、过时 API、硬编码 |
|
|
73
|
+
| 8 | **安全性** | 敏感信息泄露、输入未校验、注入风险、权限检查 |
|
|
74
|
+
| 9 | **性能** | 不必要全量导入/大循环/无用计算/内存泄漏/N+1 查询 |
|
|
75
|
+
| 10 | [?UI] **Design 合规** | 样式是否用 Token 定义的视觉模式;无硬编码魔法值;实现与 `ui_concept.html` 对应屏幕视觉一致 |
|
|
76
|
+
| 11 | [?Data] **数据一致性** | 字段名/类型与 `data_snapshot.json` 是否一致 |
|
|
77
|
+
| 12 | [?I18n] **I18n 合规** | 无硬编码字符串;须用 Key/字典引用 |
|
|
78
|
+
| 13 | **Orphan .gitkeep** | 目录已有其他文件时仍存在 `.gitkeep` — 须删除 |
|
|
79
|
+
| 14 | **Spec-Code 漂移** | 代码中的接口/类型/行为是否与 `spec.md` 一致;手动变更是否已同步到文档 |
|
|
80
|
+
| 15 | [?UI] **UI 引用完整性** | `ui.md` 中的 `ref: ui_concept.html#S-XX` 指针是否仍然有效;被引用的屏幕/组件是否因 edit/revise 后已改名或删除 |
|
|
81
|
+
|
|
82
|
+
**Output**: 按维度分组的发现列表,每项含级别、位置、描述。
|
|
83
|
+
</step_2_task>
|
|
84
|
+
|
|
85
|
+
<step_2_project>
|
|
86
|
+
**Role**: 首席审计官
|
|
87
|
+
**Scope**: 项目级健康体检(仅 `/archi.audit` 无参数时执行)。
|
|
88
|
+
|
|
89
|
+
| # | 检查项 | 说明 |
|
|
90
|
+
|:---|:---|:---|
|
|
91
|
+
| 1 | **Vision 漂移** | `roadmap.json` 任务方向与 `vision.md` 是否一致 |
|
|
92
|
+
| 2 | **架构一致性** | `map.json` vs 实际目录结构,有无漂移或未注册模块 |
|
|
93
|
+
| 3 | **Roadmap 健康度** | 一致性 + 进度统计 + 长期 blocked 任务 + 依赖环检测 |
|
|
94
|
+
| 4 | **文档完整度** | 各 Task 是否有 spec.md + plan.json;有无孤儿目录 |
|
|
95
|
+
| 5 | **Tech Stack 全局合规** | 抽查关键入口与模块,检测全局性违规 |
|
|
96
|
+
| 6 | **跨 Task 一致性** | 重复逻辑、命名冲突、接口不一致 |
|
|
97
|
+
| 7 | **Orphan .gitkeep** | 目录已有其他文件时仍存在 `.gitkeep` — 须删除 |
|
|
98
|
+
|
|
99
|
+
扫描后标注优先级,推荐需深度审查的 Task:
|
|
100
|
+
- `done` 但 plan 未全部完成的
|
|
101
|
+
- 代码量大但无测试的
|
|
102
|
+
- 长期 `active` 未推进的
|
|
103
|
+
|
|
104
|
+
**Output**: 项目健康概览 + 深度审查推荐列表。
|
|
105
|
+
</step_2_project>
|
|
106
|
+
|
|
107
|
+
<step_3_report>
|
|
108
|
+
**Role**: 报告撰写员
|
|
109
|
+
**Action**:
|
|
110
|
+
|
|
111
|
+
**Issue Classification**:
|
|
112
|
+
|
|
113
|
+
| 级别 | 含义 | 示例 |
|
|
114
|
+
|:---|:---|:---|
|
|
115
|
+
| `CRITICAL` | 须修复,阻塞发布 | 逻辑错误、安全漏洞、数据损坏风险 |
|
|
116
|
+
| `WARNING` | 应修复,有风险 | 缺少错误处理、性能隐患、Spec 覆盖不全 |
|
|
117
|
+
| `INFO` | 建议优化 | 命名不规范、缺少注释、可简化的代码 |
|
|
118
|
+
|
|
119
|
+
**Issue Format** (每项须包含):
|
|
120
|
+
```
|
|
121
|
+
[LEVEL] 文件路径:行号 — 维度名
|
|
122
|
+
描述:具体问题
|
|
123
|
+
-> 推荐修复:/archi.fix <ID> <描述> 或 /archi.edit <ID> <描述>
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
**Action Routing** (根据问题类型推荐命令):
|
|
127
|
+
|
|
128
|
+
| 问题类型 | 推荐命令 |
|
|
129
|
+
|:---|:---|
|
|
130
|
+
| Bug(逻辑错误、边界遗漏) | `/archi.fix <ID> <描述>` |
|
|
131
|
+
| Spec 缺漏(功能未完整实现) | `/archi.edit <ID> <补充描述>` |
|
|
132
|
+
| 架构级问题(全局违规) | `/archi.revise <描述>` |
|
|
133
|
+
| 功能未完成(plan 虚标 done) | `/archi.code <ID>` |
|
|
134
|
+
| 小问题(命名、注释、简化) | 下次 `/archi.code` 时一并处理 |
|
|
135
|
+
|
|
136
|
+
**Report Structure**:
|
|
137
|
+
1. 审查概要(模式、范围、日期)
|
|
138
|
+
2. 发现列表(按级别排序:CRITICAL → WARNING → INFO)
|
|
139
|
+
3. 统计摘要(各级别数量)
|
|
140
|
+
4. 修复工单汇总(可直接执行的命令列表)
|
|
141
|
+
5. Next Steps 表格
|
|
142
|
+
|
|
143
|
+
**Write Report File**:
|
|
144
|
+
- 任务级 → `[[__DOCS_DIR__]]/tasks/<id>_<Slug>/audit.md`(覆盖式)
|
|
145
|
+
- 项目级 → `[[__DOCS_DIR__]]/audits/YYYY-MM-DD.md`(按日期存档,同日覆盖)
|
|
146
|
+
|
|
147
|
+
**Output**: 完整审查报告(同时输出到对话和写入文件)。
|
|
148
|
+
</step_3_report>
|
|
149
|
+
|
|
150
|
+
</protocol_audit>
|