Files
cmbone/docs/quality-document.md
T

2.4 KiB

质量文档

当前质量概览

领域 当前等级 说明
项目结构 B 已从模板整理为普通工程,目录职责基本清楚
产品定位 B 已校准为 Windows-first 可复用桌面应用模板,后续需要代码落地
后端服务 B 现有服务边界清晰,登录、日志、统计和业务样例服务尚未实现
本地存储 B SQLite 初始化和基础测试已存在,目标新增表需要迁移和测试
前端结构 B- Vue 组件按功能拆分,但尚未形成模板化主布局和目标路由
构建验证 B Go 测试、前端构建、后端编译可运行
文档 B+ Harness Coding 文档已接入,并同步了模板愿景

主要风险

  • 模板范围膨胀:登录、设置、业务、日志、统计和组件示例都要做,但必须小步交付。
  • Wails v3 alpha 版本兼容性风险。
  • bindings 与 Go 服务签名不一致的运行时风险。
  • 登录 provider、AI provider、日志和统计如果没有边界,会导致后续替换困难。
  • 热键、托盘、OCR 等平台能力在 Windows 以外行为不完全一致。
  • 前端缺少专门单元测试,主要依赖构建和人工 smoke。

质量门槛

每个代码任务至少达到:

  • Go 代码 gofmt。
  • go test ./... 通过。
  • 涉及前端时 npm run build 通过。
  • 涉及后端启动时 go build -o bin/cmbone.exe . 通过。
  • 涉及 UI 时完成对应窗口的人工检查。
  • 涉及登录、日志、统计或业务样例时,同步更新 api.md、routes.md、current-state.md 和任务验收。

模板模块质量要求

  • 登录:本地 provider 和 remote provider 边界清楚,密码不写死在前端。
  • 设置:配置项有 key、类型、默认值、说明和迁移逻辑。
  • 主业务:商品图片 AI 优化可以先模拟,但任务状态、失败原因和结果结构要真实。
  • 审计日志:记录用户动作,字段可查询、可导出。
  • 运行日志:记录系统错误,能支持排错。
  • 数据统计:只做 P0 指标,不提前做复杂 BI。
  • 组件示例:复用 Ant Design Vue,不自研组件库。

改进方向

  • 建立 Windows-first 主窗口最大化和自适应布局策略。
  • 为登录、日志、图片任务和统计新增服务、模型、迁移和测试。
  • 为商品图片 AI 优化样例补充真实页面闭环。
  • 为 Wails bindings 生成流程补充完整操作说明。