AI 工作规则 - TextToImageAndVideo 项目

项目背景

本项目是 TextToImageAndVideo（文本转图片和视频）的 Flask 后端 API 系统。为了让 AI 在修改本项目代码时减少误差、提高效率，所有参与本项目的 AI 都必须遵守以下规则。

核心规则（必须遵守）

规则1：修改文件前先查找关联文件

每当有AI修改本项目中的任何文件时，必须先找到跟本文件有关联性的文件。

每个模型文件（如 work.py、task.py 等）的开头都包含一个【本文件关联的外部文件】表格
AI 必须先阅读该表格，了解修改本文件会影响哪些其他文件

规则2：简要说明文件作用

简要说明该文件的具体内容与作用，该说明内容要优先符合AI的理解。

每个文件开头都有【本文件核心作用】说明
AI 修改文件时应该理解这个文件在整体架构中的作用

规则3：修改处添加备注

当本文件发生改变时，要在改变处添加备注与说明，方便后续AI接管本文件时能够快速理解。

AI修改本文件时，必须在修改的字段/函数/类旁边添加【AI修改备注】
备注应说明修改原因和可能的影响

示例：

status = db.Column(db.Enum(...), default='QUEUING')  # 【AI修改备注：新增FAILED状态，用于标记AI处理失败的作品】

规则4：同步检查关联文件

每当本文件因AI发生变动时，AI都需要去访问其他受关联的文件，检查是否需要同步调整。

每个文件开头都包含【关联文件详细说明】，列出了同步检查要点
AI 必须逐个检查关联文件是否需要同步更新

规则5：文件开头必须有关联说明

在文件开头添加注释，说明本文件与哪些文件有关联，关联信息要优先符合AI的理解。

每个核心文件（models、routes等）的开头都必须包含关联文件表格
表格包含：优先级、文件路径、关联方式、同步检查要点

规则6：尊重开发者的修改

每当AI修改本文件以后，如果开发者再进行调整与修改，AI不能删除开发者的修改内容，并理解开发者为什么要这么修改。如果不理解则先停止工作，向开发者提出疑问。

AI 的修改不能覆盖或删除开发者之前的手动修改
如果 AI 不理解开发者的修改意图，必须停止工作并询问

项目结构说明

end-clint-python/
├── app/                          # 应用主目录
│   ├── models/                   # 数据模型（核心业务实体）
│   │   ├── work.py              # 作品模型
│   │   ├── task.py              # 任务模型
│   │   ├── user.py              # 用户模型
│   │   ├── collection.py        # 收藏模型
│   │   ├── user_point.py        # 用户积分模型
│   │   ├── ai_model.py          # AI模型配置
│   │   ├── base.py              # 基类模型
│   │   └── ...
│   ├── routes/                   # API路由（HTTP接口）
│   │   ├── work.py              # 作品相关接口
│   │   ├── task.py              # 任务相关接口
│   │   └── ...
│   ├── auth.py                  # 认证相关
│   ├── config.py                # 配置
│   └── ...
├── scripts/                      # 脚本和schema定义
│   ├── schemas/                 # JSON Schema定义
│   │   ├── work_schema.py
│   │   ├── task_schema.py
│   │   └── ...
│   └── routes/                  # 路由脚本（OpenAPI描述）
│       ├── work_routes.py
│       ├── task_routes.py
│       └── ...
├── docs/                         # 文档
│   └── tables/                  # 数据库表文档
│       ├── works.md
│       ├── tasks.md
│       └── ...
└── openapi.json                # OpenAPI完整文档

数据模型关联图

User (用户)
  │
  ├─── Work (作品) ──── Task (任务)
  │       │                │
  │       └─── Collection (收藏)
  │       │
  │       └─── UserPoint (积分变动)
  │
  └─── UserMaterialUpload (用户素材)

AIModel (AI模型配置)

修改文件时的标准流程

读取目标文件：先读取要修改的文件完整内容
查看关联说明：阅读文件开头的【本文件关联的外部文件】表格
执行修改：按照需求修改文件内容
添加备注：在修改处添加【AI修改备注】说明
检查关联文件：逐个检查关联文件是否需要同步更新
更新关联文档：如有需要，更新 docs/tables/*.md 和 openapi.json

注意事项

不要删除开发者注释：任何标有【开发者修改记录】的区域，AI 不得修改
保持枚举值一致：如果修改枚举值，必须同步更新所有使用该枚举的文件
数据库变更需谨慎：修改模型字段可能影响数据库迁移
保持 API 兼容性：修改接口参数时要考虑向后兼容性

联系与反馈

如果 AI 在修改文件时遇到以下情况，必须停止工作并询问开发者：

不理解开发者之前的修改意图
修改可能影响多个关联文件，不确定如何处理
发现现有代码存在矛盾或不一致

最后更新：2026-04-27 版本：1.0

FilesExpand file tree

AI_RULES.md

Latest commit

History