diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index 1e22005..37c2cd9 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -34,7 +34,7 @@ graph TB subgraph L2 ["🧰 工具链层 (Tooling)"] CLI[tools/cli/ · epcode CLI
10 个子命令] - SCRIPTS[tools/cross-platform/scripts/
15 个零依赖脚本] + SCRIPTS[tools/cross-platform/scripts/
16 个零依赖脚本] METRICS[tools/metrics/
四场景 collect + dashboard] INTEG[tools/integrations/
9 个系统连接器] end @@ -293,7 +293,7 @@ flowchart LR | 项 | 现状 | 差距 | 优先级 | 目标 | |----|------|------|--------|-----| | CLI 10 个命令 | ✅ | - | - | - | -| 脚本 15 个 | ✅ | - | - | - | +| 脚本 16 个 | ✅ | - | - | - | | 度量 4 场景 | ✅ | - | - | - | | **类型定义(TS 或 JSON Schema)** | ❌ 纯 JS | 模板/PRD/用例无结构校验 Schema | P1 | S8 | | **插件机制** | ❌ | 企业想加自己的 check 要 fork | P2 | Phase 3 | diff --git a/CHANGELOG.md b/CHANGELOG.md index 143e85a..0be42be 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,7 +18,7 @@ Phase 2 第一 Sprint (S6) 完成。S7 启动: macOS Beta 打包 + 跨平台栈 **主题**: 架构盘点 + UI/UX 设计稿 + 信息共享文档化 + 用户手册起步 -- 🎨 **UI/UX 设计稿完整铺开**(17 个 HTML 原型 + 10 wireframes + 5 Mermaid flows + 映射表): +- 🎨 **UI/UX 设计稿完整铺开**(17 个 HTML 原型 + 13 wireframes 文档 · 覆盖 17 个主题 · 其中 `12-15` 和 `16-17` 为合并文档 · 5 Mermaid flows + 映射表): - 核心页面(10):主视图 / 向导 / 设置 / 命令面板 / Artifact / 供应商切换 / 搜索 / 右键菜单 / 空态 / 状态栏 - 用户旅程:**登录 → 项目列表 → 新建项目(4 模式 A/B/C/D)→ 主视图** - 四大场景工作流(业务/开发/测试/运维)含 Prompt 一键操作 @@ -189,6 +189,14 @@ CLI 位于 `tools/cli/`,通过根 `package.json` bin 字段暴露,支持 `npx ep **主题**: 业务 + 开发场景工具补齐 +### 范围调整 · 不做 Jenkins(用 GitLab CI 替代) + +PLAN.md 原计划 `tools/integrations/jenkins/` + 示例 `Jenkinsfile`。Sprint 2 启动时用户 +明确"我们用 GitLab CI",因此 Jenkins 相关工作改为扩展 `workflows/gitlab/.gitlab-ci.example.yml` +的 4 个 job(prd-check / testability-score / adr-index / business-metrics)实现等价功能。 + +PLAN.md 对应位置已用 ~~删除线~~ + 注记方式标注此调整。 + ### 新增 · 校验脚本（零依赖 Node 18+） - `tools/cross-platform/scripts/check-prd.js` — PRD 结构校验（必备章节 / 验收标准 / 非功能量化 / 模糊词检测） diff --git a/METRICS-business.md b/METRICS-business.md new file mode 100644 index 0000000..e6eff11 --- /dev/null +++ b/METRICS-business.md @@ -0,0 +1,43 @@ +# 业务度量周报 + +> 自动生成自 `tools/metrics/business/collect.js` +> 数据区间：自 60 days ago +> 生成时间：2026-04-20T08:14:06Z + +## 一、总览 + +| 指标 | 数值 | +|------|------| +| 业务文档相关 commit | 7 | +| CR（变更请求）相关 commit | 0 | +| 业务侧贡献者 | 2 人 | +| CR 占业务 commit 比 | 0% | + +## 二、业务文档按月变更 + +| 月份 | commit 数 | +|------|-----------| +| 2026-04 | 7 | + +## 三、业务侧贡献者（Top 10） + +| 作者 | 提交数 | +|------|--------| +| zhangkunshi | 5 | +| JohnC-stack | 2 | + +## 四、最近 10 次 CR / 变更相关 commit + +_无_ + +## 五、参考基线（业务篇建议值） + +| 指标 | 期望范围 | 说明 | +|------|---------|------| +| 版本内 CR 次数 | ≤ 3 | 过多说明需求不稳定 | +| 紧急变更占比 | ≤ 10% | 过高说明计划不充分 | +| 变更驳回率 | 30-50% | 过低说明把关不严 | + +--- + +_本报告由 `tools/metrics/business/collect.js` 自动生成,请勿手动编辑。_ \ No newline at end of file diff --git a/METRICS-development.md b/METRICS-development.md new file mode 100644 index 0000000..c3efaf3 --- /dev/null +++ b/METRICS-development.md @@ -0,0 +1,49 @@ +# 开发度量周报 + +> 自动生成自 `tools/metrics/development/collect.js` +> 数据区间：自 60 days ago +> 生成时间：2026-04-20T08:14:07Z + +## 一、总览 + +| 指标 | 数值 | +|------|------| +| 总 commit 数（不含 Merge） | 49 | +| Conventional Commits 规范率 | 88% | +| 不合规 commit | 6 | +| Merge commit 数 | 9 | +| 平均每次合入包含的 commit 数 | 1.0 | +| ADR 总数（全仓库） | 1 | +| 采样 commit 的总改动行数 | +60294 / -501 | + +## 二、Commit 类型分布（Conventional Commits） + +| 类型 | 数量 | 占合规 commit | +|------|------|--------------| +| `feat` | 15 | 35% | +| `fix` | 13 | 30% | +| `docs` | 10 | 23% | +| `test` | 4 | 9% | +| `chore` | 1 | 2% | +| _不合规_ | 6 | — | + +## 三、代码变更规模分布（采样 100 个最近 commit） + +| 规模 | 数量 | 占比 | +|------|------|------| +| 小（< 50 行） | 20 | 41% | +| 中（50-499 行） | 6 | 12% | +| 大（500-1999 行） | 11 | 22% | +| 超大（≥ 2000 行） | 12 | 24% | + +## 四、参考基线（开发篇建议值） + +| 指标 | 期望 | 当前 | 达标 | +|------|------|------|------| +| Conventional Commits 合规率 | ≥ 90% | 88% | ⚠️ | +| 单次 MR 合入的 commit 数 | 1-3 | 1.0 | ✅ | +| 单个 commit 大小 | 多数 < 500 行 | 53% 在 < 500 行 | ⚠️ | + +--- + +_本报告由 `tools/metrics/development/collect.js` 自动生成,请勿手动编辑。_ \ No newline at end of file diff --git a/METRICS-operations.md b/METRICS-operations.md new file mode 100644 index 0000000..2353edc --- /dev/null +++ b/METRICS-operations.md @@ -0,0 +1,29 @@ +# 运维度量周报 + +- 采集窗口: since **60 days ago** +- 生成时间: 2026-04-20 + +## 运维产出 + +| 类别 | commit 数 | +|------|----------| +| Runbook | 4 | +| 发布计划 | 3 | +| 故障报告 | 5 | +| 复盘 | 4 | +| **运维产出 commit 合计** | **6** | + +## 稳定性指标（粗估） + +| 指标 | 值 | 说明 | +|------|----|------| +| 回滚数 | 0 | subject 以 `Revert` 开头的 commit | +| Hotfix 数 | 0 | subject 含 hotfix/emergency/紧急 的 commit | +| 复盘产出 | 4 | 如复盘数 < 故障数,提示复盘欠账 | + +## 贡献者 Top-5（运维产出） + +| 作者 | commit 数 | +|------|----------| +| zhangkunshi | 12 | +| JohnC-stack | 5 | diff --git a/METRICS-testing.md b/METRICS-testing.md new file mode 100644 index 0000000..549e80a --- /dev/null +++ b/METRICS-testing.md @@ -0,0 +1,37 @@ +# 测试度量周报 + +- 采集窗口: since **60 days ago** +- 生成时间: 2026-04-20 + +## 测试产出 + +| 类别 | commit 数 | +|------|----------| +| 测试用例 | 2 | +| 测试策略 | 1 | +| 测试报告 | 3 | +| 提测申请 | 5 | +| Bug 报告 | 4 | +| **测试产出 commit 合计** | **7** | + +## 最近 fix/bug 提交 (Top 10) + +| 日期 | 作者 | Subject | +|------|------|---------| +| 2026-04-20 | JohnC-stack | fix(architecture): 数据流改为业务分叉到开发+测试并行(非串行链) (#23) | +| 2026-04-20 | JohnC-stack | fix(sprint-6): 原型深度打磨 + 补齐 4 种接入模式入口(A/B/C/D) (#21) | +| 2026-04-18 | JohnC-stack | fix(ci): submission-check 排除 docs/chapters/ 方法论文章 (#14) | +| 2026-04-18 | JohnC-stack | fix(docs): submission-gate L102 长行改短 (#13) | +| 2026-04-18 | JohnC-stack | fix(docs-site): 忽略 broken links + 外部代码文件链接转 GitHub URL (#12) | +| 2026-04-18 | JohnC-stack | fix(docs): 转义 Markdown 表格中的 窗口: **60 days ago** · 生成时间: 2026-04-20 + +本看板由 `tools/metrics/generate-dashboard.js` 汇总四大场景 `METRICS-*.md` 生成。 + +## 场景关键指标 + +### 💼 业务 + +| 指标 | 值 | +|------|-----| +| 业务文档相关 commit | 7 | +| CR（变更请求）相关 commit | 0 | +| CR 占业务 commit 比 | 0% | +| 2026-04 | 7 | +| zhangkunshi | 5 | +| JohnC-stack | 2 | + +
+完整 METRICS-business.md + +# 业务度量周报 + +> 自动生成自 `tools/metrics/business/collect.js` +> 数据区间：自 60 days ago +> 生成时间：2026-04-20T08:14:06Z + +## 一、总览 + +| 指标 | 数值 | +|------|------| +| 业务文档相关 commit | 7 | +| CR（变更请求）相关 commit | 0 | +| 业务侧贡献者 | 2 人 | +| CR 占业务 commit 比 | 0% | + +## 二、业务文档按月变更 + +| 月份 | commit 数 | +|------|-----------| +| 2026-04 | 7 | + +## 三、业务侧贡献者（Top 10） + +| 作者 | 提交数 | +|------|--------| +| zhangkunshi | 5 | +| JohnC-stack | 2 | + +## 四、最近 10 次 CR / 变更相关 commit + +_无_ + +## 五、参考基线（业务篇建议值） + +| 指标 | 期望范围 | 说明 | +|------|---------|------| +| 版本内 CR 次数 | ≤ 3 | 过多说明需求不稳定 | +| 紧急变更占比 | ≤ 10% | 过高说明计划不充分 | +| 变更驳回率 | 30-50% | 过低说明把关不严 | + +--- + +_本报告由 `tools/metrics/business/collect.js` 自动生成,请勿手动编辑。_ + +
+ +### 💻 开发 + +| 指标 | 值 | +|------|-----| +| 总 commit 数（不含 Merge） | 49 | +| Conventional Commits 规范率 | 88% | +| 不合规 commit | 6 | +| Merge commit 数 | 9 | +| 平均每次合入包含的 commit 数 | 1.0 | +| ADR 总数（全仓库） | 1 | +| `feat` | 15 | +| `fix` | 13 | + +
+完整 METRICS-development.md + +# 开发度量周报 + +> 自动生成自 `tools/metrics/development/collect.js` +> 数据区间：自 60 days ago +> 生成时间：2026-04-20T08:14:07Z + +## 一、总览 + +| 指标 | 数值 | +|------|------| +| 总 commit 数（不含 Merge） | 49 | +| Conventional Commits 规范率 | 88% | +| 不合规 commit | 6 | +| Merge commit 数 | 9 | +| 平均每次合入包含的 commit 数 | 1.0 | +| ADR 总数（全仓库） | 1 | +| 采样 commit 的总改动行数 | +60294 / -501 | + +## 二、Commit 类型分布（Conventional Commits） + +| 类型 | 数量 | 占合规 commit | +|------|------|--------------| +| `feat` | 15 | 35% | +| `fix` | 13 | 30% | +| `docs` | 10 | 23% | +| `test` | 4 | 9% | +| `chore` | 1 | 2% | +| _不合规_ | 6 | — | + +## 三、代码变更规模分布（采样 100 个最近 commit） + +| 规模 | 数量 | 占比 | +|------|------|------| +| 小（< 50 行） | 20 | 41% | +| 中（50-499 行） | 6 | 12% | +| 大（500-1999 行） | 11 | 22% | +| 超大（≥ 2000 行） | 12 | 24% | + +## 四、参考基线（开发篇建议值） + +| 指标 | 期望 | 当前 | 达标 | +|------|------|------|------| +| Conventional Commits 合规率 | ≥ 90% | 88% | ⚠️ | +| 单次 MR 合入的 commit 数 | 1-3 | 1.0 | ✅ | +| 单个 commit 大小 | 多数 < 500 行 | 53% 在 < 500 行 | ⚠️ | + +--- + +_本报告由 `tools/metrics/development/collect.js` 自动生成,请勿手动编辑。_ + +
+ +### 🧪 测试 + +| 指标 | 值 | +|------|-----| +| 测试用例 | 2 | +| 测试策略 | 1 | +| 测试报告 | 3 | +| 提测申请 | 5 | +| Bug 报告 | 4 | +| 测试产出 commit 合计 | 7 | +| zhangkunshi | 13 | +| JohnC-stack | 3 | + +
+完整 METRICS-testing.md + +# 测试度量周报 + +- 采集窗口: since **60 days ago** +- 生成时间: 2026-04-20 + +## 测试产出 + +| 类别 | commit 数 | +|------|----------| +| 测试用例 | 2 | +| 测试策略 | 1 | +| 测试报告 | 3 | +| 提测申请 | 5 | +| Bug 报告 | 4 | +| **测试产出 commit 合计** | **7** | + +## 最近 fix/bug 提交 (Top 10) + +| 日期 | 作者 | Subject | +|------|------|---------| +| 2026-04-20 | JohnC-stack | fix(architecture): 数据流改为业务分叉到开发+测试并行(非串行链) (#23) | +| 2026-04-20 | JohnC-stack | fix(sprint-6): 原型深度打磨 + 补齐 4 种接入模式入口(A/B/C/D) (#21) | +| 2026-04-18 | JohnC-stack | fix(ci): submission-check 排除 docs/chapters/ 方法论文章 (#14) | +| 2026-04-18 | JohnC-stack | fix(docs): submission-gate L102 长行改短 (#13) | +| 2026-04-18 | JohnC-stack | fix(docs-site): 忽略 broken links + 外部代码文件链接转 GitHub URL (#12) | +| 2026-04-18 | JohnC-stack | fix(docs): 转义 Markdown 表格中的 + +### 🚀 运维 + +| 指标 | 值 | +|------|-----| +| Runbook | 4 | +| 发布计划 | 3 | +| 故障报告 | 5 | +| 复盘 | 4 | +| 运维产出 commit 合计 | 6 | +| 回滚数 | 0 | +| Hotfix 数 | 0 | +| 复盘产出 | 4 | + +
+完整 METRICS-operations.md + +# 运维度量周报 + +- 采集窗口: since **60 days ago** +- 生成时间: 2026-04-20 + +## 运维产出 + +| 类别 | commit 数 | +|------|----------| +| Runbook | 4 | +| 发布计划 | 3 | +| 故障报告 | 5 | +| 复盘 | 4 | +| **运维产出 commit 合计** | **6** | + +## 稳定性指标（粗估） + +| 指标 | 值 | 说明 | +|------|----|------| +| 回滚数 | 0 | subject 以 `Revert` 开头的 commit | +| Hotfix 数 | 0 | subject 含 hotfix/emergency/紧急 的 commit | +| 复盘产出 | 4 | 如复盘数 < 故障数,提示复盘欠账 | + +## 贡献者 Top-5（运维产出） + +| 作者 | commit 数 | +|------|----------| +| zhangkunshi | 12 | +| JohnC-stack | 5 | + + +
+ +## 联动脚本（Sprint 4 产出） + +| 场景 → | 脚本 | 作用 | +|--------|------|------| +| 业务 → 开发 | `link-prd-to-design.js` | PRD 变更 → 影响面 | +| 开发 → 测试 | `recommend-regression.js` | git diff → 回归用例推荐 | +| 测试 → 运维 | `generate-release-plan.js` | 测试报告 → 发布计划草稿 | +| 运维 → 业务 | `incident-to-requirement.js` | 复盘改进项 → Jira/GH Issue | diff --git a/PLAN.md b/PLAN.md index b6cd3d9..45d6d13 100644 --- a/PLAN.md +++ b/PLAN.md @@ -304,11 +304,14 @@ **开发场景产出**： - `tools/cross-platform/scripts/generate-adr-index.js` - 扫 `docs/adr/*.md` 自动生成 `docs/adr/README.md` 索引 -- `tools/integrations/jenkins/` 目录 - - `README.md` 接入指南 - - `create-pipeline.js` 通过 API 创建 Pipeline Job - - `trigger-job.js` 触发构建 - - 示例 `Jenkinsfile`（含提测门禁） +- ~~`tools/integrations/jenkins/` 目录~~ + - ~~`README.md` 接入指南~~ + - ~~`create-pipeline.js` 通过 API 创建 Pipeline Job~~ + - ~~`trigger-job.js` 触发构建~~ + - ~~示例 `Jenkinsfile`（含提测门禁）~~ + - ❌ **未实施 · 用户选 GitLab CI 替代** + - Sprint 2 启动时确认,详见 [CHANGELOG v0.3.0](./CHANGELOG.md#030---2026-04-18--sprint-2-完成) "不做 Jenkins" 说明 + - 对应 Jenkins 要做的事,已在 `workflows/gitlab/.gitlab-ci.example.yml` 扩展的 4 个 job 里实现 - `tools/metrics/development/` 目录 - MR 平均响应时长、评审轮次、Bug 重开率 @@ -322,7 +325,7 @@ **验收**： - 对 examples/ 下现有 PRD 跑校验和打分，确认合理 - ADR 索引可复现生成 -- Jenkins 示例 Pipeline 能在真实 Jenkins 上 dry-run +- ~~Jenkins 示例 Pipeline 能在真实 Jenkins 上 dry-run~~ → 改为 **GitLab CI example 4 个新 job 能通过 lint + dry-run** --- @@ -517,7 +520,7 @@ Week 5: 复盘 + 反馈 → 改进 backlog - `tools/cross-platform/scripts/check-prd.js` 🆕 - `tools/cross-platform/scripts/score-testability.js` 🆕 - `tools/cross-platform/scripts/generate-adr-index.js` 🆕 -- `tools/integrations/jenkins/` 🆕 +- ~~`tools/integrations/jenkins/`~~ ❌ 未做(GitLab CI 替代) - `tools/metrics/business/`、`tools/metrics/development/` 🆕 **Sprint 3**: diff --git a/ROADMAP.md b/ROADMAP.md index ddb9475..e851d6e 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -29,7 +29,7 @@ ## 近期变更 ### 2026-04-20（Sprint 6 完成 · Phase 2 第一 Sprint） -- **⑥ UI/UX 设计稿**: 17 张 HTML 原型 + 10 wireframes + 5 Mermaid flows + modules map +- **⑥ UI/UX 设计稿**: 17 张 HTML 原型 + 13 wireframes 文档(覆盖 17 个主题)+ 5 Mermaid flows + 映射表 - 核心: 主视图 / 向导 / 设置 / 命令面板 / Artifact / 供应商切换 / 搜索 / 右键菜单 / 空态 / 状态栏 - 角色: 登录 / 项目列表 / 新建项目向导(4 模式 A/B/C/D) · 四大场景工作流(业务/开发/测试/运维 + Prompt 一键操作) - **① 架构图 + 技术盘点**: `ARCHITECTURE.md` 含 4 张 Mermaid(四层 / 数据流 / 依赖 / 部署)+ 技术盘点清单 20+ 项