# 项目启动初始 Prompt

你现在接手一个项目。请先不要直接修改业务代码，先完成项目上下文初始化。

目标：为当前项目建立或完善六个根目录文档：INIT.md、DEV.md、README.md、TODO.md、AGENTS.md、CLAUDE.md。

这些文档的职责如下：

1. INIT.md
   这是项目启动和接手时的初始化协议。
   需要说明：
   - 新项目或空项目如何建立项目上下文
   - 已存在项目如何先分析现状再完善文档
   - DEV.md、README.md、TODO.md、AGENTS.md、CLAUDE.md 的职责
   - 不确定信息如何标注
   - 初始化完成后的输出要求

2. DEV.md
   这是项目开发规范文档，面向开发者和 AI coding 工具。
   需要说明：
   - 项目的开发工作流
   - 修改代码前后的约束
   - git 快照/回退原则
   - code review 和用户测试的边界
   - 本地环境约定
   - 常用启动、检查、测试命令
   - AI 工具协作规则

3. README.md
   这是项目说明文档，面向第一次接触项目的人。
   需要说明：
   - 项目是什么
   - 解决什么问题
   - 主要功能
   - 技术栈
   - 目录结构
   - 如何安装依赖
   - 如何启动
   - 如何使用
   - 关键配置
   - 常见问题或注意事项

4. TODO.md
   这是项目任务和交接文档，面向开发、排查、code review 和后续交接。
   需要说明：
   - 当前需求
   - 已发现的问题
   - 问题原因分析
   - 修改计划
   - 修改内容
   - 验证状态
   - 部署/重启状态
   - code review 关注点
   - 已完成项和未完成项

5. AGENTS.md
   这是 Codex 的薄入口文件。
   只需要引用 INIT.md、DEV.md、README.md、TODO.md，并说明这些源文档的职责。
   不要在 AGENTS.md 中复制环境、命令、部署、任务状态等会变化的信息。

6. CLAUDE.md
   这是 Claude Code 的薄入口文件。
   只需要引用 INIT.md、DEV.md、README.md、TODO.md，并说明这些源文档的职责。
   不要在 CLAUDE.md 中复制环境、命令、部署、任务状态等会变化的信息。

请按以下规则执行：

一、如果当前项目已经存在代码或已有部分文档：

1. 先阅读项目根目录结构、已有 INIT.md、DEV.md、README.md、TODO.md、AGENTS.md、CLAUDE.md，以及主要配置文件。
2. 分析当前项目实际情况，不要凭空假设。
3. 如果已有文档：
   - 保留正确内容
   - 修正过期、错误或含糊的内容
   - 补充缺失信息
   - 删除明显不适用的模板化内容
4. 如果缺少某个文档，则新建。
5. 文档内容必须反映当前项目真实状态。
6. 对不确定的信息，用“待确认”标注，不要写成事实。
7. 不要修改业务代码，除非用户明确要求。
8. 完成后说明：
   - 新增或修改了哪些文档
   - 每个文档的主要内容
   - 哪些信息仍需用户确认

二、如果当前项目是空项目或几乎没有代码：

1. 先根据用户对项目的描述，推断项目目标、技术方向和初始开发流程。
2. 新建 INIT.md、DEV.md、README.md、TODO.md、AGENTS.md、CLAUDE.md。
3. INIT.md 应描述项目启动和接手时的初始化协议。
4. README.md 应描述项目愿景、预期功能、计划技术栈和初始使用方式。
5. DEV.md 应描述开发规范、协作流程、文档维护规则和 AI 工具使用约束。
6. TODO.md 应列出初始需求拆解、待确认问题、第一阶段开发任务和验证方式。
7. AGENTS.md 和 CLAUDE.md 应保持为薄入口文件，只引用 INIT.md、DEV.md、README.md、TODO.md。
8. 对用户未说明的信息，用“待确认”标注。
9. 不要编造已经存在的功能、命令、部署方式或测试结果。
10. 完成后提醒用户确认项目目标、技术栈、运行环境和第一阶段优先级。

三、核心文档建议模板如下：

INIT.md 模板：

# 项目启动初始 Prompt

```text
你现在接手一个项目。请先不要直接修改业务代码，先完成项目上下文初始化。

目标：为当前项目建立或完善 INIT.md、DEV.md、README.md、TODO.md、AGENTS.md、CLAUDE.md。

如果当前项目已经存在代码或已有部分文档，先分析当前项目实际情况，再补齐或修正文档。

如果当前项目是空项目或几乎没有代码，根据用户描述建立项目上下文，对不确定信息标注“待确认”。

AGENTS.md 和 CLAUDE.md 只作为 AI 工具入口文件，不复制项目环境和任务状态。
```

DEV.md 模板：

# 项目开发规范

## 工作流

发现问题或新需求 -> 写入 TODO.md -> 问题分析或需求拆分 -> git commit 快照 -> 修改代码 -> 语法/类型/测试检查 -> code review -> 用户测试 -> 测试通过 -> 关闭 TODO。

## 原则

- 最小变更：每个任务聚焦一个明确目标，不夹带无关重构。
- 先快照后改：修改前确认当前工作区状态，必要时先建立 git 快照。
- 检查前置：修改后先运行必要检查，再进入 review。
- 用户测试通过才关闭：code review 只代表技术审查通过，不等于需求完成。
- 不覆盖用户改动：发现未归属改动时，先说明，不擅自回退或覆盖。
- 文档同步：功能、部署、命令、流程变化时，同步更新 README.md、DEV.md 或 TODO.md。

## 环境约定

- 项目根目录：待确认
- 运行环境：待确认
- 依赖安装命令：待确认
- 启动命令：待确认
- 测试命令：待确认
- 日志位置：待确认
- 部署方式：待确认

## 常用命令

```bash
# 安装依赖
待确认

# 启动开发环境
待确认

# 运行测试
待确认

# 语法/类型检查
待确认
```

## AI 工具协作规则

本文件为通用开发规范，适用于 Claude Code、Cursor、Codex 等 AI coding 工具。

AI coding 工具开始工作前应先阅读：

- INIT.md
- DEV.md
- README.md
- TODO.md

AGENTS.md 和 CLAUDE.md 是工具专用的薄入口文件，只负责引导 Codex / Claude Code 阅读源文档，不承载环境、命令、部署、任务状态等会变化的信息。

工具特定的规则文件应引用源文档，而不是复制一份独立规则，避免多处规则长期不同步。

AGENTS.md 模板：

# AI 开发入口

本文件是 Codex 的项目入口文件。

开始任何任务前，必须先阅读并遵守：

1. INIT.md
2. DEV.md
3. README.md
4. TODO.md

## 文件职责

- INIT.md：项目启动和接手时的初始化协议。
- DEV.md：日常开发规范、协作流程、环境约定和检查规则。
- README.md：项目说明、功能、使用方式和部署说明。
- TODO.md：当前任务、问题分析、修改计划、验证状态和 code review 状态。

## 执行规则

- 新项目、空项目、首次接手已有项目时，优先遵守 INIT.md。
- 已有任务开发、修复、排查或 code review 时，优先遵守 DEV.md 和 TODO.md。
- 项目说明、启动方式、配置、环境信息以 README.md 和 DEV.md 为准。
- 当前需求、待办、验证状态、review 状态以 TODO.md 为准。
- 不要把 INIT.md、DEV.md、README.md、TODO.md 的内容复制到本文件。
- 如果文档内容冲突，先停止并向用户说明冲突，不要自行猜测。

CLAUDE.md 模板：

# AI 开发入口

本文件是 Claude Code 的项目入口文件。

开始任何任务前，必须先阅读并遵守：

1. INIT.md
2. DEV.md
3. README.md
4. TODO.md

## 文件职责

- INIT.md：项目启动和接手时的初始化协议。
- DEV.md：日常开发规范、协作流程、环境约定和检查规则。
- README.md：项目说明、功能、使用方式和部署说明。
- TODO.md：当前任务、问题分析、修改计划、验证状态和 code review 状态。

## 执行规则

- 新项目、空项目、首次接手已有项目时，优先遵守 INIT.md。
- 已有任务开发、修复、排查或 code review 时，优先遵守 DEV.md 和 TODO.md。
- 项目说明、启动方式、配置、环境信息以 README.md 和 DEV.md 为准。
- 当前需求、待办、验证状态、review 状态以 TODO.md 为准。
- 不要把 INIT.md、DEV.md、README.md、TODO.md 的内容复制到本文件。
- 如果文档内容冲突，先停止并向用户说明冲突，不要自行猜测。

README.md 模板：

# 项目名称

## 项目简介

待确认。

## 目标

待确认。

## 主要功能

- 待确认

## 技术栈

- 待确认

## 目录结构

```text
待确认
```

## 安装依赖

```bash
待确认
```

## 启动方式

```bash
待确认
```

## 测试与检查

```bash
待确认
```

## 配置说明

待确认。

## 使用说明

待确认。

## 注意事项

- 待确认

TODO.md 模板：

# TODO

## 当前状态

- 项目阶段：待确认
- 当前重点：待确认
- 阻塞问题：待确认

## 待确认问题

- [ ] 项目目标是否明确
- [ ] 技术栈是否确定
- [ ] 运行环境是否确定
- [ ] 第一阶段功能优先级是否确定
- [ ] 测试方式是否确定
- [ ] 部署方式是否确定

## 任务列表

### YYYY-MM-DD 初始项目梳理

#### 用户需求

- 待确认

#### 问题/背景

- 待确认

#### 修改计划

- [ ] 建立 INIT.md
- [ ] 建立 DEV.md
- [ ] 建立 README.md
- [ ] 建立 TODO.md
- [ ] 建立 AGENTS.md
- [ ] 建立 CLAUDE.md
- [ ] 确认项目目标
- [ ] 确认技术栈
- [ ] 确认第一阶段任务

#### 验证方式

- [ ] 用户确认文档内容
- [ ] 用户确认第一阶段优先级

#### Code Review 关注点

- 文档是否真实反映项目状态
- 是否存在未经确认但被写成事实的内容
- TODO 是否能支持后续交接和 review

四、输出要求：

1. 如果你进行了文件修改，请列出修改文件。
2. 如果你没有修改文件，只给出建议，也要明确说明。
3. 不要输出过长的解释，重点说明结论、改动和待确认事项。
4. 所有文档内容优先使用中文，除非项目已有明确语言约定。
5. 文档应简洁、可维护，不要写成冗长流程手册。

现在请开始执行项目上下文初始化。