docs: align vision with reusable desktop template

This commit is contained in:
QiuSW
2026-07-08 15:45:01 +08:00
parent d2eeb049d0
commit 47d3c653c6
15 changed files with 493 additions and 112 deletions
+26 -18
View File
@@ -4,16 +4,16 @@
## 一句话定位
`cmbone` 是一个 Wails v3 + Vue 3 + SQLite 的本地桌面应用骨架,当前重点是保持可运行、可构建、可维护。
`cmbone` 是一个 Windows-first、可扩展到其他平台的 Wails v3 + Vue 3 + SQLite 可复用桌面应用模板。
第一版 MVP 只做:桌面主窗口、设置页、多语言、主题、本地配置、热键、托盘和 OCR 示例窗口的稳定闭环。
模板目标不是做空泛框架,而是沉淀桌面端常用模块:应用壳、设置、登录、主业务模块、操作日志、数据统计和常用业务组件。第一批业务样例使用“电商商品图片 AI 优化”来验证模板是否能支撑真实业务闭环。
## 必读顺序
每次开始写代码前,按这个顺序建立上下文:
1. [`01-vision.md`](01-vision.md):为什么做、为谁做、什么不做。
2. [`02-requirements.md`](02-requirements.md):MVP 要什么、怎么算达成。
2. [`02-requirements.md`](02-requirements.md):模板 MVP 要什么、怎么算达成。
3. [`03-tech-stack.md`](03-tech-stack.md):既定技术选型。
4. [`04-architecture.md`](04-architecture.md):系统结构、职责划分、数据模型和关键难点。
5. [`05-coding-rules.md`](05-coding-rules.md):写代码前必须遵守的规则。
@@ -34,14 +34,14 @@
## 当前阶段
当前项目处于:MVP 基线整理与文档接入阶段。
当前项目处于:可复用桌面应用模板的产品定位校准阶段。
优先路径:
1. Phase 0:保持可运行、可测试、可构建。
2. Phase 1:收敛 Wails 服务、前端绑定和本地存储边界。
3. Phase 2:完善主窗口和第二窗口的真实用户流程。
4. Phase 3:补齐最小测试和发布文档。
1. Phase 0:保持迁移后的 Wails/Vue/SQLite 基线可运行、可测试、可构建。
2. Phase 1:建立 Windows-first 的应用壳、主布局、设置和登录边界。
3. Phase 2:实现商品图片 AI 优化样例、审计日志、运行日志和数据统计。
4. Phase 3:补齐组件示例、测试、打包和交接文档。
## 领取任务规则
@@ -52,21 +52,25 @@
- 完成后把执行记录追加到 [`../progress.md`](../progress.md),并覆盖更新 [`current-state.md`](current-state.md) 的当前快照。
- 结束会话前过一遍 [`clean-state-checklist.md`](clean-state-checklist.md)。
## MVP 边界
## 模板 MVP 边界
MVP 只做:
- 主窗口能启动并展示设置、快捷键、标签、关于等基础页面。
- 本地 SQLite 能初始化并保存配置和热键。
- 托盘菜单、语言切换、主题切换、快捷键和第二窗口能按现有设计工作。
- 前端构建、后端测试和后端编译保持通过。
- 应用壳:主窗口、侧边导航、顶部用户区、内容区,Windows 10+ 优先。
- 登录:本地固定账号 provider 和真实后端 provider 的可替换边界。
- 设置:主题、语言、窗口行为、快捷键、数据目录和日志策略。
- 主业务样例:电商商品图片 AI 优化的任务列表、状态、结果和失败反馈。
- 操作日志:审计日志用于记录用户动作,运行日志用于排错。
- 数据统计:今日处理图片数、AI 优化成功率、平均耗时、失败任务数、今日操作日志数、最近 7 天处理趋势。
- 常用组件示例:输入框、多选框、下拉框、多行文本、表格、筛选和分页。
MVP 不做:
- 云端账号、同步、付费和远程 API。
- 复杂任务管理或业务工作流。
- 未确认产品方向前的大型 UI 重构。
- 未验证兼容性的 Wails / Go / Vite 大版本升级。
- 完整权限系统、角色系统或企业 SSO。
- 完整 macOS / Linux 体验承诺;当前是 Windows-first,其他平台保持结构可扩展。
- 自研 UI 组件库;优先复用 Ant Design Vue。
- 复杂 BI 报表、自动更新和插件市场。
- 未确认接口前的真实 AI 服务深度集成。
## 常见任务该看哪里
@@ -74,7 +78,11 @@ MVP 不做:
做后端服务:先看 [`api.md`](api.md)、[`04-architecture.md`](04-architecture.md),再看 `internal/services/`。
做数据模型:先看 [`04-architecture.md`](04-architecture.md),改 schema 后必须同步更新相关文档和测试。
做登录:先看 [`04-architecture.md`](04-architecture.md) 的 AuthProvider 边界,不把账号密码写死在前端。
做日志:区分审计日志和运行日志,先看 [`04-architecture.md`](04-architecture.md) 的数据模型。
做统计:只围绕 MVP 指标,不提前做复杂报表平台。
做运行 / 打包:先看 [`03-tech-stack.md`](03-tech-stack.md) 和 [`current-state.md`](current-state.md)。