docs: 补充项目文档体系,完善 AI 工具配置
变更内容: - 新增 AGENTS.md:为 Codex 等 AI 工具提供项目开发指南 - 更新 CLAUDE.md:优化文档阅读层级结构 - 新增 docs/ref/平台需求文档-v3.md:平台整体需求和功能范围 - 新增 docs/ref/架构文档-v3.md:系统架构设计和技术选型 文档阅读层级(P1-P4): - P1: MVP 方案文档(优先阅读) - P2: 原型文档(交互细节) - P3: 架构文档(整体设计) - P4: 需求文档(需求范围) 只有需要时才往下阅读下一层级文档。
This commit is contained in:
@@ -0,0 +1,38 @@
|
||||
# AGENTS.md
|
||||
|
||||
## MVP 实现阶段指南
|
||||
|
||||
在 MVP 实现阶段,解决问题时请遵循以下文档阅读层级(由高到低,只有需要时才往下阅读):
|
||||
|
||||
### 文档阅读层级
|
||||
|
||||
- **P1 - MVP 方案文档** (`docs/mvp-skeleton-plan.md`)
|
||||
- 项目骨架结构、模块划分、接口定义
|
||||
- 技术实现要点和代码规范
|
||||
- **优先阅读**:大部分问题应首先在此文档中寻找答案
|
||||
|
||||
- **P2 - 原型文档** (`docs/ref/xinfra-prototype.v3.html`)
|
||||
- 完整的页面交互流程和 UI 规范
|
||||
- 组件行为、状态管理、API 调用时机
|
||||
- 异常处理和用户体验细节
|
||||
- **当需要理解具体交互时阅读**
|
||||
|
||||
- **P3 - 架构文档** (`docs/ref/架构文档-v3.md`)
|
||||
- 系统架构设计和技术选型
|
||||
- 模块划分和依赖关系
|
||||
- 数据流向和接口规范
|
||||
- **当需要理解整体架构时阅读**
|
||||
|
||||
- **P4 - 需求文档** (`docs/ref/平台需求文档-v3.md`)
|
||||
- 平台整体需求和功能范围
|
||||
- 用户故事和验收标准
|
||||
- **当需要明确需求范围时阅读**
|
||||
|
||||
### 实现原则
|
||||
|
||||
- **先读文档,再看代码**:理解设计意图后再动手实现
|
||||
- **层级优先**:P1 能解决的问题不要去看 P2、P3、P4
|
||||
- 严格遵循 MVP 文档中定义的目录结构和模块划分
|
||||
- 参考原型文档中的交互流程和状态管理
|
||||
- 保持代码简洁,聚焦 MVP 核心功能
|
||||
- 遵循项目既定的技术栈和编码规范
|
||||
Reference in New Issue
Block a user