Add harness coding documentation

This commit is contained in:
QiuSW
2026-07-06 10:25:29 +08:00
commit f68d443c0d
23 changed files with 1336 additions and 0 deletions
+46
View File
@@ -0,0 +1,46 @@
# 已有项目接入 / 恢复清单
> 本项目当前是空目录起步,已完成 harness 文档初始化。本文用于两种情况:后续已经有 Wagtail 代码后恢复上下文,或把本项目文档接入到另一个已有代码库。
## 适用场景
- 已经初始化 Wagtail,但下一轮 agent 不清楚真实启动命令。
- 文档、代码和当前可运行状态出现偏差。
- 想把 Skelet 的 harness 文档迁移到另一个骨架介绍网站项目。
## 最小接入文件
| 文件 | 作用 |
| --- | --- |
| `AGENTS.md` | 仓库级 agent 入口和总规则。 |
| `CLAUDE.md` | Claude Code 薄入口,指向 `AGENTS.md`。 |
| `docs/00-ai-start-here.md` | 每轮开工流程。 |
| `docs/05-coding-rules.md` | 编码纪律和验证底线。 |
| `docs/06-tasks.md` | 任务看板。 |
| `docs/current-state.md` | 当前实现状态快照。 |
| `progress.md` | 只追加的执行流水。 |
| `init.sh` 或 `init.ps1` | 标准启动与验证入口,按操作系统二选一。 |
## 当前项目恢复步骤
1. 确认仓库根目录是 `D:\OPC\skelet`。
2. 读取 `AGENTS.md`、`docs/00-ai-start-here.md`、`docs/current-state.md`。
3. 查看 `docs/06-tasks.md`,领取第一个 `TODO` 且依赖均为 `DONE` 的任务。
4. 如果生产代码尚未初始化,先做 `T-001`,不要提前实现业务页面。
5. 初始化 Wagtail 后,立刻更新 `init.ps1`、`init.sh`、`docs/03-tech-stack.md`、`docs/current-state.md` 中的真实命令。
6. 运行标准验证,把结果追加到 `progress.md`。
7. 如果验证失败,第一轮任务应先修基线,不做新功能。
## 代码现实与文档冲突时
- 以当前可运行代码和真实验证结果为事实起点。
- 文档描述旧功能但代码不存在时,先把差异记录到 `current-state.md`,不要直接补实现。
- 代码已有行为但文档没写时,先补 `02-requirements.md`、`04-architecture.md`、`api.md` 或 `routes.md`,再继续修改代码。
- 命令不可运行时,不要标记任务完成;在 `progress.md` 记录失败命令和错误摘要。
## 不建议做的事
- 不要一次性实现首页、模型、筛选、SEO 和部署。
- 不要把聊天记录当事实来源。
- 不要为了让验证通过而降低测试或验收标准。
- 不要在接入 harness 的同一轮顺手重构无关代码。