Private
Public Access
1
0
Files
u-desk/docs/04-功能迭代/GO-DESK-2.数据库客户端/知识库/规范/AI协作检查清单.md
绝尘 a5d30684ed 重构:文件系统模块化架构,增强 Markdown 渲染
- 拆分 FileSystem.vue 为模块化组件架构
- 新增 Markdown Mermaid 图表渲染支持
- 新增 180+ 编程语言代码高亮
- 修复编辑/预览模式切换渲染问题
- 优化亮色/暗色模式主题适配
- 新增 TypeScript 类型定义
2026-02-04 03:32:46 +08:00

3.2 KiB
Raw Blame History

AI协作检查清单

状态:已确定
最后更新2026-01-28


一、开始任务前检查

1.1 读取约束

1.2 检查决策

  • 已检查 决策记录/ 中相关决策
  • 已理解相关决策的约束和影响

1.3 检查问题

  • 已检查 问题追踪/ 中相关问题
  • 已理解待解决问题和待实现功能

二、设计阶段检查

2.1 设计文档

  • 设计文档符合模板格式
  • 引用了相关的知识库规范
  • 关联了相关的决策记录ADR
  • 列出了待讨论问题

2.2 决策记录

  • 重要决策已创建ADR
  • ADR格式符合标准模板
  • 决策理由清晰明确

三、实现阶段检查

3.1 代码规范

  • 方法参数不超过3个
  • 不返回 RetResult<Void> 类型
  • 代码简洁,易于维护
  • 必要注释已添加

3.2 架构规范

  • 符合分层架构
  • 职责分离明确
  • 事件参数使用对象格式
  • 所有事件有类型定义

3.3 样式规范

  • 使用Arco基础样式
  • 避免过度自定义样式
  • 确保主题兼容

四、文档更新检查

4.1 知识库更新

  • 新确定的知识已加入知识库
  • 知识库内容已验证

4.2 问题追踪更新

  • 已解决问题已关闭
  • 新问题已创建
  • 问题状态已更新

4.3 决策记录更新

  • 新决策已创建ADR
  • 相关ADR已更新

五、完成检查

5.1 代码检查

  • 编译通过
  • 无Linter错误
  • 符合编码规范

5.2 文档检查

  • 设计文档已更新
  • 决策记录已更新
  • 问题追踪已更新

5.3 测试检查

  • 功能测试通过
  • 测试用例已更新

六、常见错误避免

6.1 代码错误

  • 方法参数超过3个
  • 返回 RetResult<Void> 类型
  • 过度设计,增加不必要复杂度

6.2 架构错误

  • 违反分层架构
  • 事件参数使用多个参数
  • 缺少类型定义

6.3 文档错误

  • 问题与知识混淆
  • 决策未记录
  • 约束未明确

七、引用规范

7.1 引用格式

  • 知识库:[知识库/规范/编码规范.md](../../知识库/规范/编码规范.md)
  • 决策记录:[ADR-001](../决策记录/ADR-001-事件系统设计.md)
  • 问题追踪:[问题-001](../../问题追踪/待讨论/问题-001-右键菜单实现方式.md)
  • 设计文档:[设计文档/架构设计/事件系统设计.md](../../设计文档/架构设计/事件系统设计.md)

7.2 引用原则

  • 引用要准确,使用相对路径
  • 引用要明确,说明引用内容
  • 引用要完整,包含路径和说明

八、协作流程

8.1 开始任务

  1. 读取约束(知识库/规范)
  2. 检查决策(决策记录)
  3. 检查问题(问题追踪)

8.2 执行任务

  1. 遵循约束
  2. 记录决策
  3. 更新问题

8.3 完成任务

  1. 更新文档
  2. 创建检查报告
  3. 更新任务状态