52 lines
2.1 KiB
Markdown
52 lines
2.1 KiB
Markdown
|
# 项目文档整理指南
|
|||
|
|
|
|||
|
|
本文档介绍了KaMiXiTong软件授权管理系统中各个文档的作用和使用方法，帮助用户快速找到所需的文档。
|
|||
|
|
|
|||
|
|
## 文档分类
|
|||
|
|
|
|||
|
|
### 1. 入门指南
|
|||
|
|
- [README.md](README.md) - 项目简介和快速开始指南
|
|||
|
|
- [PROJECT_SUMMARY.md](PROJECT_SUMMARY.md) - 项目详细总结和架构说明
|
|||
|
|
|
|||
|
|
### 2. 部署文档
|
|||
|
|
- [DEPLOYMENT.md](DEPLOYMENT.md) - MySQL数据库部署详细指南
|
|||
|
|
- [MYSQL_CONFIG_GUIDE.md](MYSQL_CONFIG_GUIDE.md) - MySQL配置与初始化指南
|
|||
|
|
|
|||
|
|
### 3. 集成文档
|
|||
|
|
- [docs/INTEGRATION.md](docs/INTEGRATION.md) - 软件授权系统集成指南
|
|||
|
|
- [docs/EXAMPLES.md](docs/EXAMPLES.md) - 使用示例和代码模板
|
|||
|
|
|
|||
|
|
### 4. API文档
|
|||
|
|
- [docs/FASTAPI.md](docs/FASTAPI.md) - FastAPI接口配置文档
|
|||
|
|
- [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md) - API部署说明
|
|||
|
|
|
|||
|
|
## 文档使用建议
|
|||
|
|
|
|||
|
|
### 新用户入门
|
|||
|
|
1. 首先阅读 [README.md](README.md) 了解项目基本功能
|
|||
|
|
2. 查看 [PROJECT_SUMMARY.md](PROJECT_SUMMARY.md) 了解系统架构和技术栈
|
|||
|
|
3. 根据需要选择部署方式，参考相应的部署文档
|
|||
|
|
|
|||
|
|
### 开发者集成
|
|||
|
|
1. 阅读 [docs/INTEGRATION.md](docs/INTEGRATION.md) 了解如何将授权验证器集成到您的软件中
|
|||
|
|
2. 参考 [docs/EXAMPLES.md](docs/EXAMPLES.md) 中的代码示例进行实际开发
|
|||
|
|
3. 如需使用FastAPI接口，查看 [docs/FASTAPI.md](docs/FASTAPI.md)
|
|||
|
|
|
|||
|
|
### 系统管理员
|
|||
|
|
1. 根据数据库类型选择相应的部署文档：
|
|||
|
|
- MySQL数据库：[DEPLOYMENT.md](DEPLOYMENT.md) 和 [MYSQL_CONFIG_GUIDE.md](MYSQL_CONFIG_GUIDE.md)
|
|||
|
|
2. 参考 [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md) 进行生产环境部署
|
|||
|
|
|
|||
|
|
## 已删除文档说明
|
|||
|
|
|
|||
|
|
以下文档已被删除，因为它们是过时的或与当前系统不相关：
|
|||
|
|
|
|||
|
|
- `DEPLOYMENT_GUIDE.md` - 账号管理系统重构部署指南（已过时）
|
|||
|
|
- `SERVER_DEPLOYMENT_GUIDE.md` - 服务器部署指南（内容已整合到其他文档中）
|
|||
|
|
- `REFACTOR_NOTES.md` - 账号管理系统重构说明（已过时）
|
|||
|
|
|
|||
|
|
## 注意事项
|
|||
|
|
|
|||
|
|
1. 所有文档均保持最新状态，与当前代码版本兼容
|
|||
|
|
2. 如在使用过程中发现问题，请及时反馈
|
|||
|
|
3. 建议收藏本文档，方便日后查阅
|