Files
nexus/Project/fonrey/VIBE_CODING_开工前缺失清单.md
Shen Wei 712a33fbac docs: 新增系统配置模块PRD及数据模型文档,更新TASK.md
- 新增 PRD/系统配置/系统配置模块PRD.md(v0.1 Draft)
  - MVP 范围:US-SETTING-001-A(Lookup Items)、B(房源字段必填规则)、C(客源录入规则)
- 新增 PRD/系统配置/系统配置数据模型设计说明_for_Atlas.md
- 新增 PRD/系统配置/系统配置参数数据.md(竞品参数数据)
- 删除旧版 PRD/系统配置/系统配置.md(已被新PRD替代)
- 新增 DATA_MODEL/DATA_MODEL_SETTING.md(系统配置数据模型)
- 新增 DATA_MODEL/ENUMS.md(枚举定义与约定)
- 新增 AGENTS.md(AI Agent 开发规范)
- 更新 PRD/TASK.md:US-SETTING-001 拆分为 A/B/C 三个子任务,修正参考文档路径与验收标准
- 新增 VIBE_CODING_开工前缺失清单.md
- 新增 TECH_STACK/房源管理技术方案.md
- 更新 DATA_MODEL/DATA_MODEL.md、DATA_MODEL_CLIENT.md、DATA_MODEL_LOGIN.md
- 更新 PRD/PRD_MVP.md、PRD/权限管理/权限管理模块PRD.md
- 更新 TECH_STACK/TECH_STACK.md、权限管理系统技术方案.md
- 更新 UI_DESIGN/preview.html、UI_SYSTEM/UI_SYSTEM.md
- 新增 prompt/PRD - 为系统设置生成PRD设计文档.md、更新 prompt 模板
2026-04-27 15:33:12 +08:00

2.5 KiB
Raw Permalink Blame History

Fonrey Web Coding 开工前缺失清单

记录时间2026-04-26
目的:在开始 Web Coding 落地前,把缺失但会直接卡住实施的文档一次补齐。

一、必须补齐的 6 份关键文档

1. 项目入口文档

  • README.md / 项目总览
  • 本地启动步骤
  • 环境变量说明
  • 数据库初始化与迁移说明
  • 种子数据说明

2. ADR 架构决策记录

需要冻结以下决策:

  • 登录态session / token / 混合方案
  • django-tenants 本地开发模式
  • 单租户 MVP 与多租户架构共存方式
  • HTMX 页面局刷约定
  • 目录结构最终落点
  • 状态机与枚举字典权威来源

3. 枚举字典 / 状态字典

建议新增:

  • ENUMS.md
  • STATE_MACHINE.md

至少冻结:

  • 客源状态
  • 客源等级
  • 房源状态
  • 操作日志类型
  • 租户状态机

要求统一:

  • 中文值
  • 英文值
  • 数据库 CHECK 值
  • UI 展示值
  • 允许的状态迁移

4. 页面路由 + 组件映射

需要明确:

  • 每个模块有哪些页面
  • 每个页面对应什么 URL
  • 每个页面复用哪些组件
  • 哪些页面是列表 / 详情 / 弹窗 / 抽屉 / partial
  • 每个页面的空态、加载态、错误态、权限态

5. API 契约规范

需要明确:

  • 请求 / 响应格式
  • 错误码规范
  • 分页规范
  • 搜索 / 筛选规范
  • 上传规范
  • 文件下载规范
  • 权限拒绝返回规范

6. 本地开发与验证手册

需要明确:

  • 本地环境启动方式
  • PostgreSQL / Redis / Celery 启动方式
  • django-tenants 初始化方式
  • 测试租户创建方式
  • 管理员账号 seed 方式
  • 静态资源与对象存储本地替代方案
  • dev / staging / production 配置差异

二、建议优先级

P0先补不补就不能稳定开工

  • 项目入口文档
  • ADR
  • 枚举字典 / 状态字典
  • 页面路由 + 组件映射

P1随后补直接影响实现质量

  • API 契约规范
  • 本地开发与验证手册

三、当前项目的直接风险

  • 需求、数据模型、任务表已经较完整,但“可执行工程包”还不够
  • Review 已指出枚举不一致、分页规范缺位、性能基准缺位等问题
  • 没有启动手册和种子数据Web Coding 容易停留在文档层,无法稳定进入实现层

四、建议的落地顺序

  1. 先补 README / 启动手册
  2. 冻结 ADR
  3. 冻结 ENUMS / STATE_MACHINE
  4. 补页面路由与组件映射
  5. 补 API 契约
  6. 补本地开发与验证手册
  7. 再开始正式 Web Coding

这份清单的目标不是增加文档数量,而是减少实现时的来回返工。