Skip to content

Latest commit

 

History

History
20 lines (16 loc) · 776 Bytes

File metadata and controls

20 lines (16 loc) · 776 Bytes

Mini-Muse 项目规范

文档同步要求

每次通过 Claude Code 修改代码实现后,必须检查并同步更新 docs/design.md 设计文档:

  1. 新增功能:在设计文档中补充对应的模块描述、数据流、API 接口
  2. 架构变更:更新架构图(使用 Mermaid 语法)和模块关系
  3. 接口变更:更新 API 路由表、请求/响应格式
  4. 删除功能:从文档中移除对应描述,避免文档与代码不一致

设计文档 docs/design.md 应包含:

  • 项目概述与核心功能
  • 系统架构图(Mermaid)
  • 技术栈说明
  • 后端模块划分与职责
  • 前端页面与组件结构
  • API 接口定义
  • 数据流与核心流程(SSE、AI Agent Loop 等)
  • 关键设计决策及原因