项目为 PC 端管理系统的公共组件库,技术栈为 React 19 + TypeScript + Ant Design 6.x。组件来源参考 D:\AiSim\AdminManager\src\components,采用 git 子模块方式挂载到业务项目,不走 npm 发布。
当前文档状态:
- README.md: 仅包含基础技术栈说明,缺少项目定位
- CLAUDE.md: 已包含终端命令规范
- STRUCTURE.md: 不存在
Goals:
- 清晰描述项目定位(公共组件库、git 子模块引用)
- 建立规范的组件目录分类体系
- 明确各文档职责分工
Non-Goals:
- 不涉及组件实现细节
- 不制定测试框架规范(后续讨论)
- 不规划组件导出方式(保持现有直接 import)
| 文件 | 内容定位 |
|---|---|
| README.md | 项目概述、技术栈、快速开始、组件分类概述 |
| CLAUDE.md | Claude Code 工作指导(终端命令规范) |
| STRUCTURE.md | 详细目录结构说明、组件分类规范 |
理由: 遵循社区惯例,README 作为入口文档,CLAUDE.md 专门给 Claude Code 使用,结构文档独立更清晰。
采用 STRUCTURE.md(全大写),理由:
- 与 README、CHANGELOG 风格一致
- 简洁醒目,约定俗成
沿用参考项目的分类方式:
src/
├── framework/ # 框架组件 - 页面主结构
├── forms/ # 表单组件 - 用户输入
├── fragments/ # 页面片段 - 布局元素
├── plugins/ # 高级组件 - 复杂功能
├── bases/ # 业务组件 - 领域特定
├── assets/ # 静态资源
test/ # 测试案例(待定测试框架)