本目录包含了项目的详细技术文档，文档结构与 src 目录保持一致，便于开发者快速定位相关文档。
doc/
├── README.md # 本文档目录说明
├── App.md # 根组件文档
├── main.md # 应用入口文档
├── api/ # API接口文档
│ ├── index.md # API总览和统一配置
│ ├── auth.md # 认证相关API
│ ├── department.md # 部门管理API
│ ├── logs.md # 日志相关API
│ ├── menu.md # 菜单管理API
│ ├── role.md # 角色管理API
│ ├── setting.md # 系统设置API
│ └── theme.md # 主题相关API
├── common/ # 公共模块文档
│ └── isAuth.md # 权限验证文档
├── components/ # 组件文档
│ ├── Layout/ # 布局组件
│ │ ├── LayoutContainer.md # 布局容器组件
│ │ ├── AdminLayout.md # 管理员布局
│ │ ├── MixLayout.md # 混合布局
│ │ ├── TopLayout.md # 顶部布局
│ │ └── TabsView.md # 标签页视图
│ ├── common/ # 通用组件
│ │ ├── FontSizeSwitch.md # 字体大小切换
│ │ ├── LayoutSwitch.md # 布局切换
│ │ ├── ThemeSwitch.md # 主题切换
│ │ ├── WangEditor.md # 富文本编辑器
│ │ └── Watermark.md # 水印组件
│ └── employee/ # 员工相关组件
│ └── StaffDialog.md # 员工对话框
├── mock/ # Mock数据文档
│ ├── api.md # Mock API文档
│ └── data.md # Mock数据文档
├── router/ # 路由文档
│ └── index.md # 路由配置文档
├── stores/ # 状态管理文档
│ ├── layout.md # 布局状态管理
│ ├── tabs.md # 标签页状态管理
│ └── user.md # 用户状态管理
├── styles/ # 样式文档
│ ├── common.md # 通用样式
│ ├── responsive.md # 响应式样式
│ └── theme.md # 主题样式
├── utils/ # 工具函数文档
│ ├── dynamicRoutes.md # 动态路由工具
│ ├── echarts.md # 图表工具
│ ├── fontSize.md # 字体大小工具
│ ├── request.md # 请求工具
│ ├── theme.md # 主题工具
│ └── tools.md # 通用工具
└── views/ # 页面组件文档
├── ClearCache.md # 清理缓存页面
├── Home.md # 首页
├── Login.md # 登录页面
├── NotFound.md # 404页面
├── UnderDevelopment.md # 开发中页面
├── department/ # 部门管理模块
│ └── index.md # 部门管理页面
├── logs/ # 日志模块
│ ├── login.md # 登录日志
│ └── operation.md # 操作日志
├── menu/ # 菜单管理模块
│ └── index.md # 菜单管理页面
├── role/ # 角色管理模块
│ └── index.md # 角色管理页面
└── sys/ # 系统管理模块
├── notice.md # 公告管理
└── setting.md # 系统设置
每个文档文件都包含以下内容：
- 功能概述：模块或组件的主要功能
- 技术实现：使用的技术栈和实现方式
- API接口：相关的API接口文档
- 数据结构：涉及的数据结构和类型
- 使用方法：如何使用该模块或组件
- 配置选项：可配置的参数和选项
- 注意事项：开发和使用时需要注意的问题
- 示例代码：实际使用的代码示例
- 当代码发生变更时，请同步更新相应的文档
- 新增功能时，请添加对应的文档说明
- 文档应保持与代码的一致性
- 新开发者建议从根目录的
README.md开始阅读 - 根据具体需求查看对应模块的文档
- 遇到问题时可参考相关组件的文档说明
最后更新时间：2025-09-19