@zeyue0329/xiaoma-cli 1.11.0 → 1.13.0

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.
Files changed (81) hide show
  1. package/.playwright-cli/console-2026-05-13T06-36-26-793Z.log +2 -0
  2. package/.playwright-cli/page-2026-05-13T06-36-27-725Z.yml +1 -0
  3. package/CLAUDE.md +25 -7
  4. package/XiaoMa-CLI-2026H2-/350/277/255/344/273/243/350/247/204/345/210/222.pptx +0 -0
  5. package/demo/xiaoma-bug-circle-resolve/SKILL.md +6 -0
  6. package/demo/xiaoma-bug-circle-resolve/workflow.md +254 -0
  7. package/demo/xiaoma-bug-resolve/SKILL.md +6 -0
  8. package/demo/xiaoma-bug-resolve/workflow.md +269 -0
  9. package/demo/xiaoma-prd-saas-zh/README.md +57 -0
  10. package/demo/xiaoma-prd-saas-zh/domain-research.md +128 -0
  11. package/demo/xiaoma-prd-saas-zh/epics.md +303 -0
  12. package/demo/xiaoma-prd-saas-zh/market-research-2026-q1.md +183 -0
  13. package/demo/xiaoma-prd-saas-zh/prd-bad-examples.md +268 -0
  14. package/demo/xiaoma-prd-saas-zh/prd.md +409 -0
  15. package/demo/xiaoma-prd-saas-zh/product-brief.md +97 -0
  16. package/demo/xiaoma-prd-saas-zh/validation-report.md +279 -0
  17. package/docs/roadshow/01-/351/241/271/347/233/256/346/246/202/350/247/210/344/270/216/346/236/266/346/236/204.md +189 -0
  18. package/docs/roadshow/02-/346/231/272/350/203/275/344/275/223/347/263/273/347/273/237/350/257/246/350/247/243.md +464 -0
  19. package/docs/roadshow/03-/346/231/272/350/203/275/344/275/223/344/272/244/344/272/222/346/265/201/347/250/213/345/233/276.md +334 -0
  20. package/docs/roadshow/04-/345/267/245/344/275/234/346/265/201/346/211/247/350/241/214/350/257/246/350/247/243.md +1038 -0
  21. package/docs/roadshow/05-/346/212/200/346/234/257/345/256/236/347/216/260/344/270/216/345/210/233/346/226/260/344/272/256/347/202/271.md +205 -0
  22. package/docs/roadshow/06-/350/267/257/346/274/224/346/200/273/347/273/223/344/270/216/346/274/224/347/244/272/345/273/272/350/256/256.md +167 -0
  23. package/media/doc1_fig1.png +0 -0
  24. package/media/doc1_fig2.png +0 -0
  25. package/media/doc1_fig3.png +0 -0
  26. package/media/doc1_fig4.png +0 -0
  27. package/media/doc2_fig1.png +0 -0
  28. package/media/doc2_fig2.png +0 -0
  29. package/media/doc2_fig3.png +0 -0
  30. package/media/doc2_fig4.png +0 -0
  31. package/media/doc3_fig1.png +0 -0
  32. package/media/doc3_fig2.png +0 -0
  33. package/media/doc3_fig3.png +0 -0
  34. package/media/doc3_fig4.png +0 -0
  35. package/media/doc4_fig1.png +0 -0
  36. package/media/doc4_fig2.png +0 -0
  37. package/media/doc4_fig3.png +0 -0
  38. package/media/doc5_fig1.png +0 -0
  39. package/media/doc5_fig2.png +0 -0
  40. package/media/doc5_fig3.png +0 -0
  41. package/package.json +1 -1
  42. package/patent-disclosure-optimized/SKILL.md +416 -0
  43. package/patent-disclosure-optimized/references/disclosure-template.md +84 -0
  44. package/patent-disclosure-optimized/references/docx-format-spec.md +183 -0
  45. package/patent-disclosure-optimized/references/mining-principles.md +168 -0
  46. package/patent-disclosure-optimized/scripts/md2docx.js +777 -0
  47. package/src/core/tasks/xiaoma-create-prd/data/prd-purpose.md +157 -0
  48. package/src/core/tasks/xiaoma-create-prd/data/upstream-input-contract.md +168 -0
  49. package/src/core/tasks/xiaoma-create-prd/templates/prd-skeleton-reference.md +428 -0
  50. package/src/core/tasks/xiaoma-create-prd/templates/prd-template.md +101 -3
  51. package/src/xmc/agents/sm.agent.yaml +9 -1
  52. package/src/xmc/workflows/2-plan-workflows/xiaoma-validate-prd/data/prd-quality-rubric.csv +14 -0
  53. package/src/xmc/workflows/4-implementation/auto-story-pipeline/SKILL.md +1 -1
  54. package/src/xmc/workflows/4-implementation/auto-story-pipeline/steps/step-01-init-and-validate.md +10 -13
  55. package/src/xmc/workflows/4-implementation/auto-story-pipeline/steps/step-02-create-story.md +0 -1
  56. package/src/xmc/workflows/4-implementation/auto-story-pipeline/steps/step-08-complete-story.md +3 -4
  57. package/src/xmc/workflows/4-implementation/auto-story-pipeline/steps/step-09-finalize.md +69 -0
  58. package/src/xmc/workflows/4-implementation/auto-story-pipeline/workflow.md +9 -14
  59. package/src/xmc/workflows/4-implementation/auto-story-pipeline/xiaoma-skill-manifest.yaml +1 -1
  60. package/src/xmc/workflows/4-implementation/auto-story-pipeline-batch/SKILL.md +6 -0
  61. package/src/xmc/workflows/4-implementation/auto-story-pipeline-batch/workflow.md +333 -0
  62. package/src/xmc/workflows/4-implementation/auto-story-pipeline-batch/xiaoma-skill-manifest.yaml +3 -0
  63. package/src/xmc/workflows/5-full-pipeline/auto-full-pipeline/steps/step-01-init-and-validate.md +2 -2
  64. package/src/xmc/workflows/5-full-pipeline/auto-full-pipeline/steps/step-04-run-story-pipeline.md +30 -41
  65. package/src/xmc/workflows/5-full-pipeline/auto-full-pipeline/steps/step-05-finalize.md +2 -2
  66. package/src/xmc/workflows/5-full-pipeline/auto-full-pipeline/workflow.md +7 -9
  67. package/src/xmc/workflows/5-full-pipeline/auto-prd-to-stories/SKILL.md +6 -0
  68. package/src/xmc/workflows/5-full-pipeline/auto-prd-to-stories/checklist.md +43 -0
  69. package/src/xmc/workflows/5-full-pipeline/auto-prd-to-stories/steps/step-01-init-and-validate.md +155 -0
  70. package/src/xmc/workflows/5-full-pipeline/auto-prd-to-stories/steps/step-02-create-epics.md +156 -0
  71. package/src/xmc/workflows/5-full-pipeline/auto-prd-to-stories/steps/step-03-bridge-sprint-planning.md +143 -0
  72. package/src/xmc/workflows/5-full-pipeline/auto-prd-to-stories/steps/step-04-batch-create-stories.md +309 -0
  73. package/src/xmc/workflows/5-full-pipeline/auto-prd-to-stories/steps/step-05-finalize.md +311 -0
  74. package/src/xmc/workflows/5-full-pipeline/auto-prd-to-stories/workflow.md +105 -0
  75. package/src/xmc/workflows/5-full-pipeline/auto-prd-to-stories/xiaoma-skill-manifest.yaml +3 -0
  76. package//344/270/223/345/210/251/344/272/244/345/272/225/344/271/246_1_/351/235/242/345/220/221AI/346/231/272/350/203/275/344/275/223/347/232/204/345/244/232/351/200/232/351/201/223/344/276/235/350/265/226_20260318.md +483 -0
  77. package//344/270/223/345/210/251/344/272/244/345/272/225/344/271/246_2_/345/237/272/344/272/216/351/205/215/347/275/256/351/251/261/345/212/250/347/232/204/350/267/250/345/271/263/345/217/260IDE/346/231/272/350/203/275_20260318.md +592 -0
  78. package//344/270/223/345/210/251/344/272/244/345/272/225/344/271/246_3_AI/346/231/272/350/203/275/344/275/223/345/243/260/346/230/216/345/274/217/345/256/232/344/271/211/347/232/204/347/274/226/350/257/221/346/265/201/346/260/264_20260318.md +624 -0
  79. package//344/270/223/345/210/251/344/272/244/345/272/225/344/271/246_4_/345/237/272/344/272/216/345/223/210/345/270/214/346/214/207/347/272/271/347/232/204/346/231/272/350/203/275/344/275/223/351/231/204/345/261/236/350/265/204/346/272/220/351/200/211_20260318.md +628 -0
  80. package//344/270/223/345/210/251/344/272/244/345/272/225/344/271/246_5_AI/346/231/272/350/203/275/344/275/223/350/247/246/345/217/221/346/214/207/344/273/244/347/232/204/345/244/215/345/220/210/346/240/274/345/274/217/346/240/241_20260318.md +652 -0
  81. package/src/xmc/workflows/4-implementation/auto-story-pipeline/steps/step-09-cycle-check.md +0 -147
@@ -0,0 +1,97 @@
1
+ ---
2
+ stepsCompleted:
3
+ - step-01-init
4
+ - step-02-vision
5
+ - step-03-users
6
+ - step-04-metrics
7
+ - step-05-scope
8
+ - step-06-complete
9
+ inputDocuments: []
10
+ date: '2026-04-22'
11
+ author: 张明远
12
+ ---
13
+
14
+ # Product Brief: 灵协 Linkly
15
+
16
+ ## Vision
17
+
18
+ **愿景:** 让中型企业的客户成功(CS)团队在统一画布上看见、解读并干预客户旅程,把流失预警的"发现到触达"从平均 7 天压到 24 小时内。
19
+
20
+ **核心问题:** 中型企业 CS 团队同时使用 4-6 个系统(CRM、客服、数据看板、IM、工单、合同),客户信号分散,CSM 平均每天花 90 分钟手动汇集信息,流失预警延迟 5-7 天,单人服务客户数受限。
21
+
22
+ **价值主张:**
23
+
24
+ - 跨系统聚合的客户旅程视图,单页可视化 ≥ 12 个月历史
25
+ - LLM 自动摘要近 30 天高风险对话,CSM 平均处理时间从 18 分钟降至 6 分钟
26
+ - 风险评分与触达建议同源,CSM 单人服务客户数从 30 提升至 40
27
+
28
+ **差异化:**
29
+
30
+ - 唯一同时整合"旅程画布 + LLM 摘要 + 风险评分"三能力的国内 SaaS
31
+ - 国内同类产品(聚客云、客成 Pro)只覆盖其中 1-2 项
32
+
33
+ ## Target Users
34
+
35
+ 主要用户(primary):
36
+
37
+ - **客户成功经理(CSM)** — 直接对客户健康度负责,每日检视高风险客户并介入
38
+ - **客服主管** — 负责团队 KPI、SLA、人力调度
39
+ - **数据分析师** — 季度健康度报告、流失预测模型迭代
40
+
41
+ 次要用户(secondary):
42
+
43
+ - **租户管理员(Admin)** — 配置权限、订阅、集成
44
+ - **产品经理(PM)** — 月度功能反馈分析
45
+
46
+ 不在目标用户中:
47
+
48
+ - 一线客服坐席(已有 Salesforce Service Cloud / 钉钉客服覆盖)
49
+ - 销售团队(CRM 主战场,本产品仅消费 CRM 数据)
50
+
51
+ ## Success Metrics
52
+
53
+ 候选指标(PM 在 PRD §2 中需补全 baseline / target / measurement / window):
54
+
55
+ - 流失预警触达率:从 30% 提升至 ≥ 95%
56
+ - CSM 单人服务客户数:从 30 提升至 40
57
+ - LLM 摘要采纳率:人工标注后采纳 ≥ 80%
58
+ - 月度 SLA:99.9%
59
+ - 试点客户 NPS:≥ 45(季度调研)
60
+ - 12 个月内付费客户数:≥ 80
61
+ - 单客户平均合同金额(ACV):≥ 18 万元/年
62
+
63
+ ## Scope
64
+
65
+ **In-Scope(MVP,2026 H2 上线):**
66
+
67
+ - 客户档案管理:多源聚合 · 标签 · 检索
68
+ - 旅程画布:单租户视图 · 12 个月历史 · 时间轴
69
+ - 风险预警:3 类规则引擎 · 工单系统单向集成
70
+ - AI 摘要:近 30 天对话摘要 · 触达建议
71
+ - 工单整合:钉钉 / 飞书 / Salesforce 单向同步
72
+ - 租户与权限:4 角色 RBAC · 基础订阅层级(Starter/Team/Business)
73
+
74
+ **Out-of-Scope:**
75
+
76
+ - 海外多语:首期客户均为国内中型企业,海外需求量 < 5%
77
+ - 自营客服坐席系统:与现有合作伙伴 Salesforce/钉钉客服重叠
78
+ - 自营 CRM:仅消费现有 CRM 数据,不替代
79
+ - 移动原生 App:MVP 仅 Web;移动需求由 PWA 满足
80
+
81
+ **Future Phases:**
82
+
83
+ - Growth(2027 Q1):客户健康度模型可调校 · 移动 PWA · 多 LLM 厂商抽象层
84
+ - Vision(2027 H2+):自动触达执行(IM 推送 / 邮件)· 跨租户行业基准对比 · 海外多语
85
+
86
+ **Constraints:**
87
+
88
+ - 团队规模:2026 H2 前 8 人(含 PM、设计、前端 2、后端 3、数据 1)
89
+ - 预算:年化研发投入 ¥6M
90
+ - 时间:2026 H2 上线,节点:2026/06 内测、2026/09 公测、2026/12 GA
91
+ - 数据本地化:所有客户数据仅存储于中国大陆 IDC
92
+
93
+ ## Differentiation
94
+
95
+ - 国内同类产品对比:见 market-research-2026-q1.md §3 竞争分析
96
+ - 技术新颖度:LLM 摘要 + 风险评分 + 旅程画布的三位一体集成在国内为首
97
+ - 核心壁垒:旅程画布的多源聚合管线(≥ 12 个月历史)+ 可解释风险评分模型
@@ -0,0 +1,279 @@
1
+ ---
2
+ workflowType: 'prd-validation'
3
+ prdFile: ./prd.md
4
+ prdVersion: '1.0.0'
5
+ rubricFile: '../../src/xmc/workflows/2-plan-workflows/xiaoma-validate-prd/data/prd-quality-rubric.csv'
6
+ validationIteration: 1
7
+ date: '2026-05-08'
8
+ verdict: 'pass'
9
+ totalScore: 97.5
10
+ gatePassed: true
11
+ ---
12
+
13
+ # PRD Validation Report — 灵协 Linkly v1.0.0
14
+
15
+ > 本报告是 [prd.md](./prd.md) 跑完 `xiaoma-validate-prd` 13 步校验后的得分卡,演示 `prd-quality-rubric.csv` 的 13 维量化打分逻辑。
16
+
17
+ ## Verdict
18
+
19
+ | 项 | 值 | 备注 |
20
+ | ----------------- | ----------- | --------------------------------------------------- |
21
+ | **Total Score** | 97.5 / 100 | 加权总分(partial 按 50% 权重计入) |
22
+ | **Blockers Failed** | 0 | D05 / D06 / D08 / D10 全 pass |
23
+ | **Verdict** | **pass** ✅ | 无 blocker 且总分 ≥ 80 |
24
+ | Validation Iteration | 1 / 3 | 首轮即 pass,无需重试 |
25
+ | Gate Threshold | 80 | 已通过 |
26
+
27
+ 可进入下游 `xiaoma-create-epics-and-stories` 工作流。
28
+
29
+ ---
30
+
31
+ ## 13 维得分卡
32
+
33
+ | ID | 维度 | step_ref | 权重 | 状态 | 得分 | 严重度 |
34
+ | --- | ------------------------- | ------------------------------------------------ | ---- | -------- | ------- | ------- |
35
+ | D01 | Discovery Completeness | step-v-01-discovery | 5 | pass | 5.0 | minor |
36
+ | D02 | Format & Parity | step-v-02-format-detection + step-v-02b | 6 | pass | 6.0 | major |
37
+ | D03 | Information Density | step-v-03-density-validation | 10 | pass | 10.0 | major |
38
+ | D04 | Brief Coverage | step-v-04-brief-coverage-validation | 8 | pass | 8.0 | major |
39
+ | D05 | **Measurability** | step-v-05-measurability-validation | 12 | pass | 12.0 | blocker |
40
+ | D06 | **Traceability** | step-v-06-traceability-validation | 12 | pass | 12.0 | blocker |
41
+ | D07 | Implementation Leakage | step-v-07-implementation-leakage-validation | 8 | pass | 8.0 | major |
42
+ | D08 | **Domain Compliance** | step-v-08-domain-compliance-validation | 10 | pass | 10.0 | blocker |
43
+ | D09 | Project-Type Fit | step-v-09-project-type-validation | 7 | pass | 7.0 | major |
44
+ | D10 | **SMART (FR/NFR)** | step-v-10-smart-validation | 12 | pass | 12.0 | blocker |
45
+ | D11 | Holistic Quality | step-v-11-holistic-quality-validation | 5 | partial | 2.5 | minor |
46
+ | D12 | Completeness | step-v-12-completeness-validation | 5 | pass | 5.0 | major |
47
+ | D13 | Dual-Audience Readiness | step-v-13-report-complete (fused) | 0 | pass | (info) | minor |
48
+ | | | **TOTAL** | 100 | | **97.5**| |
49
+
50
+ ---
51
+
52
+ ## 维度详情
53
+
54
+ ### D01 Discovery Completeness — pass
55
+
56
+ - inputDocuments:3 个文件全部加载成功(product-brief.md / market-research-2026-q1.md / domain-research.md)
57
+ - frontmatter `workflowType: 'prd'`:✅
58
+ - frontmatter `templateVersion: '2.0-m1'`:✅
59
+
60
+ ### D02 Format & Parity — pass
61
+
62
+ 9 个必需章节全部以 `## N. <Name>` 形式存在:
63
+
64
+ ```
65
+ ## 1. Executive Summary
66
+ ## 2. Success Criteria
67
+ ## 3. Product Scope
68
+ ## 4. User Journeys
69
+ ## 5. Domain Requirements
70
+ ## 6. Innovation Analysis
71
+ ## 7. Project-Type Requirements
72
+ ## 8. Functional Requirements
73
+ ## 9. Non-Functional Requirements
74
+ ```
75
+
76
+ 格式:XiaoMa 2.0-m1(无需 parity check)。
77
+
78
+ ### D03 Information Density — pass
79
+
80
+ | 信号关键词 | 命中数 | 阈值 |
81
+ | ----------------- | ------ | ---- |
82
+ | 打造 | 0 | < 3 |
83
+ | 业界领先 | 0 | < 3 |
84
+ | 一站式 | 0 | < 3 |
85
+ | 赋能 | 0 | < 3 |
86
+ | 数字化转型 | 0 | < 3 |
87
+ | 智能化 | 0 | < 3 |
88
+ | 全方位 | 0 | < 3 |
89
+ | the system will | 0 | < 3 |
90
+ | in order to | 0 | < 3 |
91
+ | **Total fluff/100 lines** | **0** | **< 3** |
92
+
93
+ §1 Executive Summary 直接量化("7 天压到 24 小时"),无口号化。
94
+
95
+ ### D04 Brief Coverage — pass
96
+
97
+ `contract-check.json` 验证通过:
98
+
99
+ ```json
100
+ {
101
+ "passed": true,
102
+ "missing_required": [],
103
+ "missing_conditional": [],
104
+ "applied_policies": {},
105
+ "tbds": []
106
+ }
107
+ ```
108
+
109
+ product-brief.md 中所有 `required: yes` 字段均映射到 PRD 对应章节:
110
+
111
+ | Brief 字段 | PRD 章节 |
112
+ | ----------------------- | --------------------------------------------------------------- |
113
+ | vision_statement | §1 Executive Summary(行 24) |
114
+ | core_problem | §1 Executive Summary(行 26) |
115
+ | target_personas | §1 + §4 全部 4 个 journey(CSM/Manager/分析师/Admin) |
116
+ | value_propositions | §1 价值主张三条 |
117
+ | success_metrics_draft | §2(SC-01..08 全覆盖 brief 中候选指标 + 添加 baseline/target) |
118
+ | mvp_scope | §3 MVP 列表 |
119
+ | out_of_scope | §3 Out-of-Scope(6 条) |
120
+ | differentiation | §1 What Makes Special + §6 Innovation Analysis |
121
+
122
+ ### D05 Measurability — pass(blocker)
123
+
124
+ **FR 分析(24 条):**
125
+
126
+ | 检查项 | 违规数 |
127
+ | -------------------- | ------ |
128
+ | 格式 `[Actor] can` | 0 |
129
+ | 主观形容词 | 0 |
130
+ | 模糊量词 | 0 |
131
+ | 实现泄漏 | 0 |
132
+ | **FR violations** | **0** |
133
+
134
+ **NFR 分析(10 条):**
135
+
136
+ | 检查项 | 违规数 |
137
+ | ------------------------ | ------ |
138
+ | 缺测量方法 | 0 |
139
+ | 缺数值阈值 | 0 |
140
+ | 缺前置条件 | 0 |
141
+ | **NFR violations** | **0** |
142
+
143
+ 总违规数 = 0(< 5 阈值),状态 pass。
144
+
145
+ ### D06 Traceability — pass(blocker)
146
+
147
+ §Traceability Matrix([prd.md 行 314-339](./prd.md))含 24 行:
148
+
149
+ - 24/24 FR 含 `Maps to Vision`
150
+ - 22/24 FR 含 `Maps to Success Criteria`(FR-PROFILE-04 / FR-JOURNEY-04 / FR-RISK-04 / FR-SUMMARY-04 / FR-TENANT-01 / FR-TENANT-03 标注 "-" — Admin/Manager 配置类 FR 无直接 SC 映射,已合理化)
151
+ - 24/24 FR 含 `Maps to Journey Step`
152
+
153
+ 无空 mapping 比例:0% < 20% 阈值,pass。
154
+
155
+ ### D07 Implementation Leakage — pass
156
+
157
+ 跨 §1, §2, §4, §8 扫描技术栈关键词:
158
+
159
+ | 关键词 | §1 | §2 | §4 | §8 |
160
+ | ------------------ | -- | -- | -- | -- |
161
+ | Redis/Postgres/... | 0 | 0 | 0 | 0 |
162
+ | React/Vue/... | 0 | 0 | 0 | 0 |
163
+ | Docker/K8s/... | 0 | 0 | 0 | 0 |
164
+ | AWS/GCP/Azure | 0 | 0 | 0 | 0 |
165
+
166
+ §7 Project-Type Requirements 出现 "K8s HPA"(NFR-SCALE-02)属于可接受位置(基础设施约束)。
167
+
168
+ ### D08 Domain Compliance — pass(blocker)
169
+
170
+ domain 检测:`general` + medium complexity(来自 frontmatter `domainTier: 'medium'` + project_type saas_b2b)。
171
+
172
+ `domain-complexity.csv` 对 `general` 域要求 `special_sections: standard_requirements`。
173
+ PRD §5 含 6 条具体可验证条款(5.1.1-5.1.6),且 §5.2 行业术语表 + §5.3 外部依赖均完整。
174
+
175
+ 虽然 domain=general 不是 high-complexity,但 PRD 主动覆盖了等保二级 + 个保法 + 数据本地化 + 审计日志 + 数据备份 + 数据导出 + 数据删除 7 个合规维度,超出 general 域要求。
176
+
177
+ ### D09 Project-Type Fit — pass
178
+
179
+ `project-types.csv` 中 `saas_b2b` 行的 `required_sections`:
180
+
181
+ ```
182
+ tenant_model;rbac_matrix;subscription_tiers;integration_list;compliance_reqs
183
+ ```
184
+
185
+ PRD §7 覆盖:
186
+
187
+ | required_section | §7 子节 | 状态 |
188
+ | ------------------- | ------------------------ | ---- |
189
+ | tenant_model | §7.1 多租户模型 | ✅ |
190
+ | rbac_matrix | §7.2 RBAC 角色矩阵 | ✅ |
191
+ | subscription_tiers | §7.3 订阅层级 | ✅ |
192
+ | integration_list | §7.4 集成清单(MVP) | ✅ |
193
+ | compliance_reqs | §7.6 合规需求摘要 | ✅ |
194
+
195
+ `skip_sections: cli_interface;mobile_first` — PRD 在 §3 Out-of-Scope 明确"MVP 仅 Web,移动需求由 PWA 满足",已显式处理。
196
+
197
+ ### D10 SMART (FR/NFR) — pass(blocker)
198
+
199
+ | FR/NFR 总数 | Specific | Measurable | Attainable | Relevant | Traceable | 复合需求 |
200
+ | ----------- | -------- | ---------- | ---------- | -------- | --------- | -------- |
201
+ | FR (24) | 24/24 | 24/24 | 24/24 | 24/24 | 24/24 | 0 |
202
+ | NFR (10) | 10/10 | 10/10 | 10/10 | 10/10 | 10/10 | 0 |
203
+
204
+ 无单条 FR 含 `且|并|同时|以及`。所有 NFR 含 baseline + threshold + measurement method。
205
+
206
+ ### D11 Holistic Quality — partial ⚠️
207
+
208
+ 发现 1 处轻度跨节不一致:
209
+
210
+ - §3 Out-of-Scope 列出 "自动触达执行(自动外呼 / 自动 IM):MVP 仅生成建议,CSM 手动确认后执行"
211
+ - §8.5 工单整合 包含 FR-TICKET-02(系统同步工单到外部)— 同步工单本身可视为"系统侧自动触达"
212
+ - 风险:读者可能将 FR-TICKET-02 误读为"自动触达执行"被偷偷加回 MVP
213
+
214
+ 建议:在 §3 Out-of-Scope 第一条加注释,明确"自动触达执行"特指对客户的主动外呼/IM 推送,不含工单同步动作。修正后可升级为 pass。
215
+
216
+ 权重计算:5 × 50% = 2.5(partial 折半)。
217
+
218
+ ### D12 Completeness — pass
219
+
220
+ | 章节 | 字符数 | 阈值 | 状态 |
221
+ | ------------------- | ------ | -------- | ------- |
222
+ | §1 Executive Summary| ~750 | > 200 | ✅ |
223
+ | §2 Success Criteria | ~620 | > 200 | ✅ |
224
+ | §3 Product Scope | ~960 | > 200 | ✅ |
225
+ | §4 User Journeys | ~1850 | > 200 | ✅ |
226
+ | §5 Domain Reqs | ~1100 | > 200 | ✅ |
227
+ | §6 Innovation | ~580 | > 200 | ✅ |
228
+ | §7 Project-Type | ~880 | > 200 | ✅ |
229
+ | §8 FR (24 items) | ~1500 | > 200 | ✅ |
230
+ | §9 NFR (10 items) | ~720 | > 200 | ✅ |
231
+
232
+ frontmatter 完整性:所有 M1 新增字段 (`templateVersion`, `densityLevel`, `domainTier`, `projectType`, `version`) 均填写。
233
+
234
+ 无残留 `{{...}}` 占位。
235
+
236
+ ### D13 Dual-Audience Readiness — pass(informational)
237
+
238
+ | 检查项 | 状态 |
239
+ | ---------------------------------------- | ---- |
240
+ | Skim — 仅看 ## 头能理解结构 | ✅ |
241
+ | Skip — 每节有 1-2 句开场总结 | ✅ |
242
+ | Scan — 表格/列表/加粗承载密度数据 | ✅ |
243
+ | Chunk — 一段一概念 | ✅ |
244
+ | Anchor — 所有 §N / FR-AREA-NN 引用一致 | ✅ |
245
+ | Cite — 跨引使用全 ID | ✅ |
246
+ | Forward-reference free | ✅ |
247
+ | Section-local terminology | ✅ |
248
+
249
+ 8/8 通过。informational 维度,不计入加权得分。
250
+
251
+ ---
252
+
253
+ ## 修复建议(按优先级)
254
+
255
+ | # | 维度 | 问题 | 建议 | 工作量 |
256
+ | - | ----- | ------------------------------------------ | ------------------------------------------------------------------------------------- | ------ |
257
+ | 1 | D11 | §3 自动触达描述与 §8.5 工单同步可能混淆 | §3 第一条 Out-of-Scope 加注释,明确"自动触达"特指对客户主动外呼/IM 推送,不含工单同步 | XS |
258
+
259
+ 修复后预期总分:100 / 100。
260
+
261
+ ---
262
+
263
+ ## 与 prd-bad-examples.md 的对比
264
+
265
+ 将 [prd-bad-examples.md](./prd-bad-examples.md) 中 8 个反模式片段拼成的"坏 PRD"喂给同一份 rubric,预期得分卡完全不同:
266
+
267
+ | 维度 | good 版本(本报告) | bad 版本(预期) |
268
+ | ---- | ------------------- | ---------------------- |
269
+ | D03 | pass (10) | partial (5) — AP-01 命中 |
270
+ | D05 | pass (12) | **fail (0)** — blocker |
271
+ | D06 | pass (12) | **fail (0)** — blocker |
272
+ | D07 | pass (8) | major (4) — Redis/React |
273
+ | D08 | pass (10) | **fail (0)** — blocker |
274
+ | D10 | pass (12) | **fail (0)** — blocker |
275
+ | ... | ... | ... |
276
+ | 总分 | 97.5 | < 50 |
277
+ | Verdict | **pass** | **reject**(≥ 4 blockers) |
278
+
279
+ 这一对比是 rubric 设计的核心校准目标。
@@ -0,0 +1,189 @@
1
+ # XiaoMa-CLI 项目概览与架构
2
+
3
+ ## 1. 项目定位与价值主张
4
+
5
+ XiaoMa-CLI (`@zeyue0329/xiaoma-cli`) 是一个 AI 驱动的敏捷开发框架/CLI 工具。它将专业化的 AI 智能体角色、工作流和技能安装到用户的项目目录中,与 AI IDE(Claude Code、Cursor 等)协同工作。
6
+
7
+ **核心价值:**
8
+
9
+ - 将软件开发全生命周期(需求 → 设计 → 架构 → 开发 → 测试 → 交付)全面 AI 化
10
+ - 9 个专业智能体协同,模拟真实敏捷团队
11
+ - 26 个结构化工作流覆盖开发全阶段
12
+ - 支持 25+ 主流 AI IDE 平台
13
+ - 一键安装,即插即用
14
+
15
+ ---
16
+
17
+ ## 2. 整体架构
18
+
19
+ XiaoMa-CLI 采用**两层架构**设计,将内容与工具彻底分离,确保高扩展性和可维护性。
20
+
21
+ ```mermaid
22
+ graph TB
23
+ subgraph ContentLayer["内容层 (src/)"]
24
+ subgraph CoreModule["Core 模块"]
25
+ CS["核心技能<br/>12个"]
26
+ CT["核心任务<br/>创建PRD等"]
27
+ end
28
+ subgraph XMCModule["XMC 模块 - 小马敏捷方法"]
29
+ AG["智能体<br/>9个"]
30
+ WF["工作流<br/>26个"]
31
+ TM["团队定义"]
32
+ end
33
+ end
34
+
35
+ subgraph ToolLayer["工具层 (tools/)"]
36
+ subgraph CLITools["CLI 命令行工具"]
37
+ CMD["命令系统<br/>install / status / uninstall"]
38
+ INS["安装器<br/>模块管理 / 配置收集 / 清单生成"]
39
+ IDE["IDE 管理器<br/>25+ 平台适配"]
40
+ end
41
+ SCH["Schema 验证<br/>Zod"]
42
+ FLT["代码扁平化工具"]
43
+ end
44
+
45
+ CS --> CMD
46
+ CT --> CMD
47
+ AG --> CMD
48
+ WF --> CMD
49
+ AG --> SCH
50
+ CMD --> IDE
51
+ INS --> IDE
52
+ ```
53
+
54
+ **架构要点:**
55
+
56
+ - **内容层**负责定义"做什么"——智能体的角色、工作流的步骤、技能的能力
57
+ - **工具层**负责实现"怎么做"——CLI 交互、文件安装、Schema 校验、IDE 适配
58
+ - 两层通过模块系统(`module.yaml`)连接,支持独立扩展
59
+
60
+ ---
61
+
62
+ ## 3. 模块系统
63
+
64
+ 模块是 XiaoMa-CLI 的核心组织单元,每个模块通过 `module.yaml` 定义配置变量、提示语和目录声明。
65
+
66
+ ### Core 模块 (src/core/)
67
+
68
+ - **模块代码:** `core`
69
+ - **职责:** 提供基础技能和通用任务
70
+ - **配置收集:** 用户名称、沟通语言、文档输出语言、输出目录
71
+ - **12 个核心技能:** brainstorming、distillator、party-mode、editorial-review 等
72
+
73
+ ### XMC 模块 (src/xmc/) — 小马敏捷方法
74
+
75
+ - **模块代码:** `xmc`
76
+ - **职责:** 提供完整的敏捷开发智能体和工作流
77
+ - **配置收集:** 项目名称、用户技能等级、规划产物路径、实施产物路径
78
+ - **自动创建目录结构:** `planning_artifacts`、`implementation_artifacts`、`project_knowledge`
79
+
80
+ ---
81
+
82
+ ## 4. CLI 安装流程
83
+
84
+ 以下时序图展示了用户执行 `npx xiaoma-cli install` 时的完整安装流程:
85
+
86
+ ```mermaid
87
+ sequenceDiagram
88
+ participant U as 用户
89
+ participant CLI as xiaoma-cli
90
+ participant DET as 安装检测器
91
+ participant CFG as 配置收集器
92
+ participant MOD as 模块管理器
93
+ participant MAN as 清单生成器
94
+ participant IDE as IDE管理器
95
+
96
+ U->>CLI: npx xiaoma-cli install
97
+ CLI->>DET: 检测已有安装
98
+ DET-->>CLI: 安装状态
99
+ CLI->>CFG: 收集用户配置
100
+ CFG->>U: 交互式提问(项目名/语言/路径等)
101
+ U-->>CFG: 配置回答
102
+ CFG-->>CLI: 配置数据
103
+ CLI->>MOD: 安装模块(core + xmc)
104
+ MOD->>MOD: 复制文件 + 占位符替换
105
+ MOD->>MOD: 处理智能体 Sidecar
106
+ MOD-->>CLI: 模块安装完成
107
+ CLI->>MAN: 生成 CSV 清单
108
+ MAN->>MAN: agent-manifest / workflow-manifest / files-manifest
109
+ MAN-->>CLI: 清单生成完成
110
+ CLI->>IDE: 安装到选定 IDE
111
+ IDE->>IDE: 技能文件写入 .claude/skills/ 等
112
+ IDE-->>CLI: IDE 配置完成
113
+ CLI-->>U: 安装成功
114
+ ```
115
+
116
+ **关键步骤说明:**
117
+
118
+ 1. **安装检测** — 自动识别项目中是否已安装 XiaoMa,支持升级和重装
119
+ 2. **配置收集** — 通过 `@clack/prompts` 提供交互式终端体验,收集项目和用户配置
120
+ 3. **模块安装** — 按依赖顺序安装 core 和 xmc 模块,执行占位符替换和 Sidecar 处理
121
+ 4. **清单生成** — 生成三份 CSV 清单(智能体/工作流/文件),用于运行时查询和完整性校验
122
+ 5. **IDE 配置** — 根据用户选择的 IDE 平台,写入对应的技能文件和配置
123
+
124
+ ---
125
+
126
+ ## 5. 支持的 IDE 平台
127
+
128
+ XiaoMa-CLI 采用**配置驱动**的 IDE 适配方案,通过 `platform-codes.yaml` 统一管理所有平台,无需为每个 IDE 编写定制代码。
129
+
130
+ | 类别 | 平台 | 优先级 |
131
+ |------|------|--------|
132
+ | CLI | Claude Code | ⭐ 首选 |
133
+ | IDE | Cursor | ⭐ 首选 |
134
+ | IDE | Cline, Windsurf, Roo Code | 支持 |
135
+ | IDE | Codex, OpenCode | 支持 |
136
+ | 云端 | Google Antigravity, Kiro, Rovo Dev | 支持 |
137
+ | CLI | Auggie, Gemini, Pi | 支持 |
138
+ | 其他 | CodeBuddy, Crush, GitHub Copilot, iFlow, Trae 等 | 支持 |
139
+
140
+ > 所有 IDE 的安装均通过 `platform-codes.yaml` 配置驱动,无需为单个 IDE 编写定制代码。新增 IDE 支持只需添加配置条目。
141
+
142
+ ---
143
+
144
+ ## 6. 技术栈
145
+
146
+ | 技术 | 用途 |
147
+ |------|------|
148
+ | Node.js >= 20 | 运行时环境 |
149
+ | Commander.js | CLI 命令框架 |
150
+ | @clack/prompts | 交互式终端 UI |
151
+ | Zod | Schema 验证(智能体 YAML 校验) |
152
+ | YAML | 配置和智能体定义格式 |
153
+ | Markdown | 工作流和技能定义格式 |
154
+ | Mermaid | 文档图表渲染 |
155
+ | ESLint + Prettier | 代码质量与格式化 |
156
+ | Husky + lint-staged | Git 钩子自动化 |
157
+
158
+ ---
159
+
160
+ ## 7. 项目安装后目录结构
161
+
162
+ 以下展示了 XiaoMa-CLI 安装完成后,在用户项目中生成的目录结构:
163
+
164
+ ```
165
+ {项目根目录}/
166
+ ├── _xiaoma/ # 安装目录
167
+ │ ├── core/config.yaml # 核心配置
168
+ │ ├── xmc/config.yaml # XMC 模块配置
169
+ │ ├── _config/ # 清单文件
170
+ │ │ ├── manifest.yaml # 安装元数据
171
+ │ │ ├── agent-manifest.csv # 智能体注册表
172
+ │ │ ├── workflow-manifest.csv # 工作流注册表
173
+ │ │ └── files-manifest.csv # 文件完整性清单
174
+ │ └── _memory/ # 智能体记忆(Sidecar)
175
+ ├── _xiaoma-output/ # 产出目录
176
+ │ ├── planning-artifacts/ # 规划产物(PRD/架构/史诗等)
177
+ │ └── implementation-artifacts/ # 实施产物(Sprint/Story等)
178
+ ├── .claude/skills/ # Claude Code 技能
179
+ ├── .cursor/skills/ # Cursor 技能
180
+ └── docs/ # 项目知识库
181
+ ```
182
+
183
+ **目录说明:**
184
+
185
+ - **`_xiaoma/`** — XiaoMa 框架核心安装目录,包含所有智能体、工作流、技能定义和配置
186
+ - **`_xiaoma/_config/`** — 安装清单和元数据,用于运行时查询和 `status` 命令
187
+ - **`_xiaoma/_memory/`** — 智能体 Sidecar 记忆文件,支持跨会话上下文保持
188
+ - **`_xiaoma-output/`** — 标准化的产出目录,分为规划阶段和实施阶段两大类
189
+ - **`.claude/skills/` / `.cursor/skills/`** — 各 IDE 平台的技能入口文件