69 lines
1.6 KiB
Markdown
69 lines
1.6 KiB
Markdown
# 项目文档目录
|
|
|
|
本目录包含智能柜管理系统前端项目的完整技术文档。
|
|
|
|
## 文档列表
|
|
|
|
### 📋 核心文档
|
|
|
|
1. **[项目说明文档.md](./项目说明文档.md)**
|
|
- 项目概述和技术架构
|
|
- 项目结构和核心功能
|
|
- 技术栈和开发环境
|
|
|
|
2. **[开发指南.md](./开发指南.md)**
|
|
- 开发环境搭建
|
|
- 代码规范和最佳实践
|
|
- API 开发规范
|
|
- 组件开发指南
|
|
|
|
3. **[API接口文档.md](./API接口文档.md)**
|
|
- 完整的 API 接口说明
|
|
- 按业务模块分类
|
|
- 数据类型定义
|
|
- 错误码说明
|
|
|
|
4. **[部署和维护指南.md](./部署和维护指南.md)**
|
|
- 生产环境部署流程
|
|
- 系统维护操作
|
|
- 故障排除指南
|
|
- 性能优化配置
|
|
|
|
## 快速开始
|
|
|
|
### 开发人员
|
|
|
|
1. 阅读 **[项目说明文档.md](./项目说明文档.md)** 了解项目概况
|
|
2. 按照 **[开发指南.md](./开发指南.md)** 搭建开发环境
|
|
3. 参考 **[API接口文档.md](./API接口文档.md)** 进行接口开发
|
|
|
|
### 运维人员
|
|
|
|
1. 阅读 **[部署和维护指南.md](./部署和维护指南.md)**
|
|
2. 按照文档进行生产环境部署
|
|
3. 了解日常维护操作和故障排除方法
|
|
|
|
## 文档维护
|
|
|
|
### 更新流程
|
|
|
|
1. 项目有重大变更时，及时更新相关文档
|
|
2. 新增功能模块时，补充相应的 API 文档
|
|
3. 技术栈升级时，更新开发指南
|
|
|
|
### 版本控制
|
|
|
|
- 文档版本与项目版本保持一致
|
|
- 每次更新记录变更内容和日期
|
|
- 重要变更需要在文档中标注
|
|
|
|
## 联系我们
|
|
|
|
如有文档相关问题，请联系：
|
|
- 项目维护团队
|
|
- 技术负责人
|
|
|
|
---
|
|
|
|
**最后更新**: 2025-10-15
|
|
**文档版本**: 1.0 |