2.2 KiB
1. 协作基线:建立“AI 协议”
-
README.md: 增加
## AI Context Root,明确标注docs/index.md是 Trae 的第一访问点。 -
CONTRIBUTING.md: 增加 “Canvas 维护规范”(规定修改代码逻辑必须同步更新
Authentication.canvas)。 -
提交:
git commit -m "chore: bootstrap SSOT framework with visual design support"
2. 文档中心:多维入口
-
docs/index.md: 增加 【视觉看板】 板块,置顶
docs/design/Authentication.canvas。 -
逻辑自洽: 所有的
docs/requirements必须有对应的docs/design链接。
3. 信息架构:资产目录
在原基础上增加视觉资产管理:
-
docs/design/(存放.canvas,.excalidraw,.svg) -
docs/design/maps/(存放对 Canvas 关键节点的文字补充描述)
4. ADR 模板 (优化版):增加“视觉锚点”
在 docs/decisions/adr/0000-template.md 增加:
-
Visual Reference: 引用 Canvas 的具体节点或快照(例如
[Login Flow](docs/design/Authentication.canvas))。 -
Status:
Draft / Accepted / Superceded。
目的: 确保每一项架构决策都能在画布上找到视觉对应物。
5. Prompt First 模板 (优化版):关联代码与视觉
在 docs/prompts/0000-template.md 增加:
-
Context Maps: 强制列出本次 Prompt 依赖的 Canvas 文件。
-
Rule Set:
"请严格参考 @Authentication.canvas 中的状态机转移逻辑,不要自行发挥。"
目的: 显式引导 Trae 读取 Canvas 的底层 JSON 数据。
6. 会话记录模板 (优化版):闭环反馈
在 docs/sessions/YYYYMMDD-template.md 增加:
-
Context Snapshot: 记录本次会话参考了哪些 Canvas 节点。
-
Design Update: 勾选框
[ ] 是否需要更新 Canvas?
目的: 防止代码演进后,Canvas 变成过时的“僵尸文档”。
7. 迭代复盘模板 (优化版):资产沉淀
在 docs/retros/YYYYMMDD-template.md 增加:
-
Visual Debt: 哪些代码修改了但还没来得及同步到 Canvas。
-
AI Tooling: Trae 读取 Canvas 时的表现(如:是否理解了复杂的嵌套逻辑)。