docs: establish ShopHelm harness coding baseline
This commit is contained in:
@@ -1,3 +1,66 @@
|
||||
# shop_helm
|
||||
# 店小航 ShopHelm
|
||||
|
||||
外贸电商助手
|
||||
ShopHelm 是面向小团队跨境卖家的 Windows 本地运营工作台。首发版本按以下顺序交付:
|
||||
|
||||
1. 多店铺运营台:管理店铺、独立 Chrome profile、快捷入口和普通代理。
|
||||
2. 商品运营助手:管理商品草稿、文案模板、价格、图片素材,并完成单张图片叠加预览与导出。
|
||||
3. 客服助手:管理多语言话术、买家问题和跟进提醒。
|
||||
|
||||
产品不以“防关联”或全自动 RPA 为卖点。不同 `user-data-dir` 只用于隔离本地登录会话;平台操作优先采用官方 API、CSV/XLSX 和人工确认流程。
|
||||
|
||||
## 当前状态
|
||||
|
||||
- Harness Coding 文档已初始化。
|
||||
- Git 仓库已初始化并配置 `origin`;生产代码和 `go.mod` 尚未初始化。
|
||||
- 本机已安装 `go1.23.0 windows/amd64`;第一项开发任务会验证 Gio 兼容性并锁定依赖版本。
|
||||
- 下一个任务是 [`T-001`](docs/06-tasks.md):初始化 Go module 和 Go + Gio 最小可运行骨架。
|
||||
|
||||
当前代码现实以 [`docs/current-state.md`](docs/current-state.md) 为准。
|
||||
|
||||
## Agent 入口
|
||||
|
||||
AI coding agent 进入仓库后按此顺序读取:
|
||||
|
||||
1. [`AGENTS.md`](AGENTS.md)
|
||||
2. [`docs/00-ai-start-here.md`](docs/00-ai-start-here.md)
|
||||
3. [`docs/05-coding-rules.md`](docs/05-coding-rules.md)
|
||||
4. [`docs/06-tasks.md`](docs/06-tasks.md)
|
||||
5. [`progress.md`](progress.md)
|
||||
6. [`docs/current-state.md`](docs/current-state.md)
|
||||
|
||||
完整文档索引见 [`docs/README.md`](docs/README.md)。
|
||||
|
||||
## 标准命令
|
||||
|
||||
T-001 完成后,Windows PowerShell 使用:
|
||||
|
||||
```powershell
|
||||
./init.ps1
|
||||
```
|
||||
|
||||
脚本执行 `go mod download` 和 `go test ./...`,然后打印开发启动命令。当前没有 `go.mod`,脚本会主动失败并指向 T-001,这是预期状态。
|
||||
|
||||
常用命令:
|
||||
|
||||
```powershell
|
||||
go run ./cmd/shophelm
|
||||
go test ./...
|
||||
go vet ./...
|
||||
go build -o build/shophelm.exe ./cmd/shophelm
|
||||
```
|
||||
|
||||
## 文档分工
|
||||
|
||||
| 文件 | 唯一职责 |
|
||||
| --- | --- |
|
||||
| [`docs/01-vision.md`](docs/01-vision.md) | 产品为什么做、服务谁、什么不做 |
|
||||
| [`docs/02-requirements.md`](docs/02-requirements.md) | 用户需求、优先级和可观察验收标准 |
|
||||
| [`docs/03-tech-stack.md`](docs/03-tech-stack.md) | 技术选型、版本策略和运行命令 |
|
||||
| [`docs/04-architecture.md`](docs/04-architecture.md) | 模块边界、数据模型和关键数据流 |
|
||||
| [`docs/api.md`](docs/api.md) | 本地 Go 服务、事件和错误合约 |
|
||||
| [`docs/routes.md`](docs/routes.md) | Gio 页面、导航状态和组件归属 |
|
||||
| [`docs/06-tasks.md`](docs/06-tasks.md) | 单 agent 任务看板 |
|
||||
| [`progress.md`](progress.md) | 只追加的执行与验证证据 |
|
||||
| [`docs/current-state.md`](docs/current-state.md) | 可覆盖的仓库当前快照 |
|
||||
|
||||
核心原则:需求和架构先成为仓库内事实,代码再按任务逐步实现;没有验证证据的任务不能标记完成。
|
||||
|
||||
Reference in New Issue
Block a user