docs: 建立通用规则目录并落 todo 收口纪律
This commit is contained in:
@@ -33,13 +33,13 @@
|
||||
|
||||
| 目录 | 用途 |
|
||||
|------|------|
|
||||
| `lpt-docs` | 概念与设计文档项目,只维护系统概念和设计思路 |
|
||||
|
||||
> 工作区级代理技能在 `.agents/skills/`,图表评审产物在 `docs/diagrams/`。
|
||||
| `lpt-be` | Java Spring Boot 后端,提供 REST API、认证、数据库访问 |
|
||||
| `lpt-fe` | Vue 3 + TypeScript 前端 |
|
||||
| `lpt-ai` | TypeScript + Fastify 独立 AI 服务 |
|
||||
| `lpt-infra` | Kubernetes / Traefik 部署与基础设施清单 |
|
||||
| `lpt-docs` | 概念与设计文档项目,只维护系统概念和设计思路 |
|
||||
|
||||
> 工作区级代理技能在 `.agents/skills/`,跨仓库通用规则在 `.agents/roles/`,图表评审产物在 `docs/diagrams/`。
|
||||
|
||||
## 子项目 Git 仓库
|
||||
|
||||
@@ -77,13 +77,25 @@ clone 完成后,进入或修改某个子项目前,先读取该子项目根
|
||||
- 可并行的工作优先用 `subagent` 派到对应子项目执行;同一仓库/工作目录同时只允许一个写入者(第二个写入者要么等,要么用 worktree 隔离)。
|
||||
- 只有存在真实依赖(后一步要用前一步的产出)时才串行,并在派发说明里写明依赖点;不要凭「感觉」串行。
|
||||
- 派发子任务时把已确认口径、涉及文件、验收命令、提交信息写清楚;`OPTIMIZATION_BACKLOG.md` 只由主代理更新,子代理不要改(避免 meta 仓库并发写)。
|
||||
- 本 meta 仓库只维护 `AGENTS.md`、`.gitignore`、`.agents/`(代理技能)和 `docs/diagrams/`(图表评审产物),不要在本仓库根目录创建业务代码或系统文档。
|
||||
- 本 meta 仓库只维护 `AGENTS.md`、`.gitignore`、`.agents/`(代理技能与通用规则)和 `docs/diagrams/`(图表评审产物),不要在本仓库根目录创建业务代码或系统文档。
|
||||
- `.gitignore` 忽略所有子项目目录,只放行上述根级条目,避免把独立 Git 仓库提交进本 meta 仓库。
|
||||
- 不要删除子项目内的 `.git`,也不要对子项目执行跨仓库的 `git add .`。
|
||||
- 对子项目执行 Git 操作时使用 `git -C lpt-be <command>` 这类形式。
|
||||
- 如果某个子项目目录已存在但不是 Git 仓库,或 clone 因 SSH 权限/网络失败,应停止并说明原因,不要用空目录或本地副本替代。
|
||||
|
||||
## 代理技能与图表
|
||||
## 代理技能、规则与图表
|
||||
|
||||
### 规则放在哪
|
||||
|
||||
判断标准只有一句:**这条规则换到另一个仓库还成立吗?**
|
||||
|
||||
- **通用规则(不限仓库)** 放在 `.agents/roles/`,由本仓库统一管理;例如 todo 收口纪律。
|
||||
- **项目专属规则** 留在各仓库自己的 `AGENTS.md`(后端迁移写法、前端测试隔离之类)。
|
||||
- 新增通用规则时,记得在 `AGENTS.md` 里挂上入口:`.agents/roles/` **不是自动加载目录**,
|
||||
只有 `AGENTS.md`(与按描述触发的 skills)会被读到,不引用等于不生效。
|
||||
- 现行通用规则:`todo-discipline.md`(提交后收口 / 轮末对账 / 压缩后对账)。
|
||||
|
||||
### 技能
|
||||
|
||||
- 工作区级技能放在 `.agents/skills/<技能名>/`,不放进子项目;子项目专用技能才留在各仓库 `skills/`。
|
||||
- `mermaid-diagram`:按业务主题在 `docs/diagrams/<主题>/` 生成 `.mmd` 图源与渲染页,起本地服务在线评审。
|
||||
@@ -94,7 +106,7 @@ clone 完成后,进入或修改某个子项目前,先读取该子项目根
|
||||
## 文档维护
|
||||
|
||||
- 所有系统文档统一在 `lpt-docs` 仓库维护,代码仓库不保留 README、`docs/` 等文档文件。
|
||||
- 代理协作规范保留在各仓库 `AGENTS.md`。
|
||||
- 代理协作规范:通用规则在 `.agents/roles/`,各仓库专属规则保留在该仓库 `AGENTS.md`。
|
||||
- `lpt-docs` 只维护系统概念描述和设计思路,不保存开发记录、系统中间态和开发过程产物。
|
||||
- 跨仓库的实现优化清单记录在本仓库 `OPTIMIZATION_BACKLOG.md`(只放待办、依据与验收标准);概念与设计仍归 `lpt-docs`。
|
||||
- 修改 `lpt-docs` 后,如需在 meta 仓库补充说明,保持 meta 仓库不复制文档正文。
|
||||
|
||||
Reference in New Issue
Block a user