ALIGNMENT_Generate_Code_Wiki.md 1.8 KB

任务:Generate_Code_Wiki

1. 原始需求

分析并理解这个项目仓库,生成结构化的完整的Code Wiki文档(md文件)。这套文档需要包括项目整体架构、主要模块职责、关键类与函数说明、依赖关系以及项目运行方式等关键信息。

2. 边界确认

  • 范围: 仅通过读取项目现有文件(配置、源码结构、文档)进行分析,不修改任何业务代码。
  • 输出: 在 docs/ 目录下生成 Code_Wiki.md 文档。

3. 需求理解

该项目是一个基于 Vue 3 + Vite + Element Plus + Tailwind CSS 的后台管理系统(书嗨后台),业务涵盖书籍二手回收、商城订单、营销、财务等模块。系统架构采用了类似 RuoYi(若依)权限体系的底层逻辑。 文档需要全面反映:

  • 目录层级结构及职责
  • 各个主要模块(如 recycle, mallOrder, finance 等)的业务含义
  • 关键组件(如 CommonTable, ProSearch)和核心函数(如 request.js, userStore 等)
  • 依赖和运行方式(基于 pnpm 和 npm scripts)

4. 疑问澄清

  • 暂无疑问:现有项目的目录、配置文件(package.json)、环境文件(.env)以及开发指南(TRAE_CODING_GUIDELINES.md)已提供了充分的分析上下文。

5. 任务拆解

  1. 读取根目录结构与核心配置文件(package.json, .env.development 等)获取依赖和项目运行方式。
  2. 读取 src 目录下的核心框架结构(main.js, utils/request.js, store/modules/user.js, router/index.js 等)。
  3. 阅读项目自带开发指南 docs/TRAE_CODING_GUIDELINES.md 提取开发规范和约定。
  4. 分析并汇总 src/views 下各个模块职责。
  5. 撰写并生成完整的 docs/Code_Wiki.md 文档。