Files
cmshoppe/docs/README.md
T

41 lines
3.2 KiB
Markdown
Raw Normal View History

# 项目文档导航
> cmshopee 的 harness coding 文档集合。agent 开始编程前从 [`00-ai-start-here.md`](00-ai-start-here.md) 进入。
## 一句话定位
2026-06-26 16:09:09 +08:00
cmshopee 是一个给**电商运营**使用的 Windows PySide6 桌面自动化工具,用于**管理多个 Shopee 卖家账号、并用 CDP 驱动 Chrome 批量修改商品标题、替换商品封面图**。V0 已验证单账号「改标题 + 换封面」闭环;当前 V1 目标是 5 Tab 流水线:导入采集 → AI 生成 → 点击「开始更新」并确认后批量提交 → 回写结果。
## 文档导航
- [`../AGENTS.md`](../AGENTS.md):Codex / 通用 AI coding agent 的仓库级入口。
- [`../CLAUDE.md`](../CLAUDE.md):Claude Code 的薄入口,具体规则以 `AGENTS.md` 为准。
- [`../progress.md`](../progress.md):执行历史流水,只追加记录任务执行、验证、阻塞和决策。
- [AI 开发入口](00-ai-start-here.md):agent 每次开始工作的入口、阅读顺序和任务领取规则。
- [项目愿景](01-vision.md):为什么做、为谁做、产品原则、非目标。
- [需求](02-requirements.md):要什么、用户故事、验收标准。
- [技术栈](03-tech-stack.md):语言、运行平台、CDP 方案、GUI 选型和运行命令。
- [架构设计](04-architecture.md):模块职责、账号与配置目录数据模型、CDP 已验证事实和开发顺序。
- [编码规则](05-coding-rules.md):写代码前必须遵守的硬约束。
- [任务看板](06-tasks.md):按依赖拆分的小任务,agent 每轮只做一个。
- [模块 / CLI 合约](api.md):本地模块接口、Chrome 启动参数、账号配置 schema。
- [界面与流程结构](routes.md):GUI 窗口、操作流程、按钮职责(无前端路由,用 GUI 流程替代)。
- [当前实现状态](current-state.md):当前代码现实、可运行命令、下一步可做任务。
- [常见问题排查](troubleshooting.md):本地配置、启动报错、敏感文件修复等排障记录。
2026-07-01 17:19:35 +08:00
- [产品与 UI 评估](ux-review.md):以 PM + UI 设计视角评估 5 Tab 模块 / 组件合理性,含优化方案与优先级清单。
- [界面配色设计](ui-color-design.md):语义色板与组件配色映射规范,指导给状态 / 按钮 / 校验 / 登录状态上色。
2026-07-02 15:48:22 +08:00
- [工程评估](engineering-review.md):全栈视角评估工程基础设施与可维护性(依赖清单 / CI / 打包 / gui.py 拆分 / lint),含 P0-P2 与优先级。
## 任务 / 进度 / 当前状态
- `06-tasks.md` 维护任务看板:任务 ID、依赖、验收要点和状态。
- `../progress.md` 维护执行进度:每轮实际做了什么、跑了什么验证、遇到什么阻塞、做了什么决策。
- `current-state.md` 维护当前快照:当前目录、可运行命令、已完成摘要和下一个可领取任务。
## 维护原则
- 需求变化先改文档,再改代码。
- CDP 交互的关键事实(选择器、就绪判断、上传/拖拽方式)一旦定稿,写入 `04-architecture.md`,代码不得另起一套。
- 涉及账号、登录凭证、Cookie 时,文档与代码只用占位符或路径引用,绝不写入真实值。
- agent 开始新任务前,必须从 `00-ai-start-here.md` 进入。