36 lines
2.2 KiB
Markdown
36 lines
2.2 KiB
Markdown
# 小白复盘 · 交接手册首页（首页说明）
|
|
|
|
> 一句话：这是「小白复盘」项目的交接手册入口。新来的智能体（或人）先看这一页，再按下面顺序读四份文档，就能知道这个项目是干什么的、干到哪了、下一步做什么。
|
|
|
|
## 先读哪些文件（按顺序）
|
|
|
|
1. `项目需求.md` —— 这个项目是干什么的、要解决什么问题、有哪些功能。
|
|
2. `最新进度.md` —— 目前整体做到哪一步了。
|
|
3. `任务清单.md` —— 正在做 / 已做完 / 还没安排，三栏一目了然。
|
|
4. 本文件 `README.md` —— 就是你现在看的这一页。
|
|
|
|
读完上面四份，就算“接手”了。想深入了解实现细节，再往下读。
|
|
|
|
## 想深入了解时再读这些
|
|
|
|
- `product/小白复盘-完整产品规格说明书.md` —— 最完整、最权威的“产品需求”说明书，从零重建项目都用它。
|
|
- `maintenance/人工维护指南.md` —— 怎么启动、怎么改代码、怎么跑测试、怎么备份和回退。
|
|
- `governance/` —— 架构决策和历次结构治理记录。
|
|
- `migration/` —— 从旧代码保真迁进 `app/` 的历史账本和证据，只用于审计和追溯，不参与运行。
|
|
- 根目录的 `AGENTS.md`（维护硬规矩）、`ARCHITECTURE.md`（技术架构）。
|
|
|
|
## 更新规矩（每完成或新增一个任务都要做）
|
|
|
|
任何智能体完成或新增一个任务后，必须顺手把这份手册更新到位，不能只改代码：
|
|
|
|
1. 任务做完或新增 → 更新 `任务清单.md`：把任务从「正在做」挪到「已做完」，或把新任务加进对应栏目。
|
|
2. 整体进度变了 → 更新 `最新进度.md`。
|
|
3. 需求或功能变了 → 更新 `项目需求.md`（重大变化还要同步 `product/` 里的完整说明书）。
|
|
4. 更新完提交并推送进仓库（保存并上传到放代码的网站），不能只留在自己电脑里。
|
|
|
|
## 注意事项
|
|
|
|
- 旧文档不能删：被替代的旧文档开头要加一行「⚠️ 本文档已过时，仅留档备查，请勿删除」，再写新版。
|
|
- 用中文大白话写，专业词要带通俗解释，让不懂代码的人也能看懂。
|
|
- 「问天」板块是冻结区，任何改动都不许碰；写文档时别误导后来人去改它。
|