docs: align vision with reusable desktop template

2026-07-08 15:45:01 +08:00
parent d2eeb049d0
commit 47d3c653c6
15 changed files with 493 additions and 112 deletions
@@ -2,38 +2,64 @@

 ## 项目目标

-`cmbone` 的目标是提供一个简单、可维护的 Wails v3 桌面应用基础工程，让后续功能可以在稳定的 Go 后端、Vue 前端和本地 SQLite 存储上继续演进。
+`cmbone` 的目标是成为一个可复用桌面应用模板：以 Wails v3 承载跨平台桌面能力，以 Windows 10+ 作为主要体验目标，以 Vue 3 构建稳定的业务界面，以 SQLite 承载本地配置、业务数据、日志和统计。

-当前最重要的结果是：
+它不是单一业务产品，也不是大而空的框架。它要提供一套能被复制、裁剪和扩展的桌面端基础能力，让后续具体业务模块可以快速接入。

- 新成员能按 README 和 Harness Coding 文档启动项目。
- 初级程序员能看懂目录职责和常用命令。
- 每次改动都有明确任务、验证命令和提交记录。
+## 模板定位
+
+核心定位：
+
+- Windows-first：优先保证 Windows 10+ 上的启动、窗口、热键、托盘、打包和用户体验。
+- 可扩展跨平台：代码结构保留 macOS / Linux 适配边界，但不在 MVP 承诺完整体验。
+- 本地优先：配置、日志、任务和统计默认落 SQLite 或本地文件。
+- 业务可替换：登录、AI 服务、主业务模块通过 provider / service 边界替换。
+- 初级程序员可维护：模块职责清楚，任务小步推进，不追求抽象炫技。

 ## 目标用户

- 项目维护者：需要快速判断当前状态、任务边界和验证方式。
- 初级前端 / 后端程序员：需要沿着清晰模块做小范围改动。
+- 项目维护者：需要一套可复用的桌面应用起点。
+- 初级前端 / 后端程序员：需要沿着清晰模块做设置、表单、表格、日志和统计类功能。
 - AI coding agent：需要稳定的上下文入口、任务看板和质量规则。
+- 后续业务团队：需要把具体业务模块插入模板，而不是从零搭桌面壳。

-## 产品方向
+## 第一批业务样例

-短期方向是桌面工具壳和设置中心：
+第一批主业务模块使用“电商商品图片 AI 优化”。

- 主窗口负责常驻设置、快捷键和信息展示。
- 第二窗口用于快捷打开轻量功能，如 OCR 示例。
- 后端服务负责平台能力、本地配置和数据持久化。
+这个样例用于验证模板是否具备真实业务所需的基本能力：
+
+- 登录后进入主应用。
+- 上传或选择商品图片。
+- 创建 AI 优化任务。
+- 查看任务状态、结果和失败原因。
+- 记录用户操作和系统错误。
+- 在数据统计页看到处理量、成功率、耗时和失败趋势。
+
+## 核心模块
+
+- 应用壳：主窗口、侧边导航、顶部用户区、内容区。
+- 设置：主题、语言、窗口行为、快捷键、数据目录、日志策略。
+- 登录：本地固定账号 provider 和真实后端 provider。
+- 主业务：商品图片 AI 优化样例。
+- 操作日志：审计日志和运行日志分开。
+- 数据统计：围绕业务任务和日志生成基础指标。
+- 常用组件：输入框、多选框、下拉框、多行文本、表格、筛选、分页和状态反馈。

 ## 非目标

- 现在不做云端账号、远程同步、复杂权限、支付或 SaaS 化。
- 现在不把项目改造成大型前端单页应用。
- 现在不引入 Electron、Tauri 或其他桌面框架替代 Wails。
- 现在不追逐 latest 依赖版本，优先保持当前 Go 1.23.0 可构建。
+- 不自研完整 UI 组件库，优先使用 Ant Design Vue 和项目级组合封装。
+- 不在 MVP 做复杂权限、角色、组织、企业 SSO。
+- 不在 MVP 做复杂 BI 平台、报表设计器或插件市场。
+- 不在 MVP 承诺完整 macOS / Linux 体验。
+- 不在没有真实接口前重度绑定某个 AI 服务商。
+- 不追逐 latest 依赖版本，优先保持当前 Go 1.23.0 可构建。

 ## 成功标准

- 文档、目录、命令和代码事实一致。
+- 新项目可以基于模板快速保留或删除登录、设置、日志、统计和业务样例。
+- Windows 10+ 上可以稳定启动、构建和打包。
 - `.\init.ps1` 可以完成依赖安装、测试、前端构建和后端编译。
- 新增功能能落在明确模块内，不需要跨多层猜测。
+- 文档、目录、命令、接口和当前代码事实一致。
+- 新增模块都有清楚 service / model / route 边界。
 - 提交历史能看出每次改动的意图和验证结果。