ShopHelm 项目文档导航
本目录是 ShopHelm 的产品与工程事实来源。AI coding agent 每次从
00-ai-start-here.md进入。
一句话定位
店小航 ShopHelm 是面向小团队跨境卖家的 Windows 本地运营工作台,首发跑通“找到正确店铺并打开独立 Chrome 环境 -> 整理商品与图片 -> 复用客服话术并跟进”的日常闭环。
核心文档
| 文档 | 职责 |
|---|---|
../AGENTS.md |
仓库级 agent 规则和安全边界 |
00-ai-start-here.md |
每轮开工、领任务和收尾流程 |
01-vision.md |
产品目标、用户、原则和非目标 |
02-requirements.md |
功能范围、优先级、用户故事和验收 |
03-tech-stack.md |
技术选型、依赖纪律和命令 |
04-architecture.md |
分层、模块、数据模型和关键数据流 |
05-coding-rules.md |
Go、Gio、SQLite、文件和进程硬规则 |
06-tasks.md |
单 agent 任务看板和依赖 |
api.md |
本地应用服务、事件和错误合约 |
routes.md |
桌面页面、导航状态和组件归属 |
current-state.md |
当前代码现实和下一个可领取任务 |
执行与质量文档
| 文档 | 职责 |
|---|---|
../progress.md |
只追加的任务执行和验证证据 |
clean-state-checklist.md |
每轮结束前的干净收尾检查 |
adoption-checklist.md |
当前空项目从文档进入代码的基线清单 |
method-map.md |
常见失败模式到修复工件的导航 |
evaluator-rubric.md |
单次交付质量评分 |
quality-document.md |
产品域和架构层长期健康度 |
tasks/README.md |
多 agent 时的一任务一文件规则 |
职责边界
- “做什么、怎么算完成”只在
02-requirements.md定义。 - “用什么”只在
03-tech-stack.md定义。 - “模块和数据如何组织”只在
04-architecture.md定义。 - “公开服务如何调用”只在
api.md定义。 - “页面放在哪里”只在
routes.md定义。 - “现在代码实际是什么状态”只在
current-state.md维护。 - 历史命令和结果只追加到
../progress.md。
同一事实不要在多个文件各写一个版本。需要摘要时链接到权威文档。