forked from datawhale/whale-town-end
85d488a508
- 重新组织docs目录结构，按功能模块分类 - 新增deployment和development目录 - 更新API文档结构 - 添加客户端README文档 - 移除过时的文档文件
107 lines
4.2 KiB
Markdown
107 lines
4.2 KiB
Markdown
# 📚 Pixel Game Server 文档中心
|
||
|
||
欢迎来到 Whale Town 项目文档中心！这里包含了项目的完整文档，帮助你快速了解和使用项目。
|
||
|
||
## 📖 **文档导航**
|
||
|
||
### 🚀 **快速开始**
|
||
- [项目概述](../README.md) - 项目介绍和快速开始指南
|
||
- [架构设计](ARCHITECTURE.md) - 系统架构和设计理念
|
||
|
||
### 🔌 **API文档**
|
||
- [API接口文档](api/api-documentation.md) - 完整的API接口说明（17个接口）
|
||
- [API状态码](API_STATUS_CODES.md) - HTTP状态码和错误代码说明
|
||
- [OpenAPI规范](api/openapi.yaml) - 机器可读的API规范文件
|
||
- [API使用指南](api/README.md) - API文档使用说明
|
||
|
||
### 💻 **开发指南**
|
||
- [后端开发指南](development/backend_development_guide.md) - 后端开发规范和最佳实践
|
||
- [NestJS指南](development/nestjs_guide.md) - NestJS框架使用指南
|
||
- [命名规范](development/naming_convention.md) - 代码命名规范
|
||
- [Git提交规范](development/git_commit_guide.md) - Git提交消息规范
|
||
- [AI辅助开发规范](development/AI辅助开发规范指南.md) - AI辅助开发最佳实践
|
||
- [测试指南](development/TESTING.md) - 测试策略和规范
|
||
|
||
### 🚀 **部署运维**
|
||
- [部署指南](deployment/DEPLOYMENT.md) - 生产环境部署说明
|
||
|
||
### 📋 **项目管理**
|
||
- [贡献指南](CONTRIBUTORS.md) - 如何参与项目贡献
|
||
- [文档清理说明](DOCUMENT_CLEANUP.md) - 文档维护记录
|
||
|
||
## 🏗️ **文档结构说明**
|
||
|
||
```
|
||
docs/
|
||
├── README.md # 📚 文档中心首页
|
||
├── ARCHITECTURE.md # 🏗️ 架构文档
|
||
├── API_STATUS_CODES.md # 📋 API状态码
|
||
├── CONTRIBUTORS.md # 🤝 贡献指南
|
||
├── DOCUMENT_CLEANUP.md # 📝 文档清理说明
|
||
│
|
||
├── api/ # 🔌 API文档
|
||
│ ├── api-documentation.md # API接口文档
|
||
│ ├── openapi.yaml # OpenAPI规范
|
||
│ ├── postman-collection.json # Postman测试集合
|
||
│ └── README.md # API文档说明
|
||
│
|
||
├── development/ # 💻 开发指南
|
||
│ ├── backend_development_guide.md
|
||
│ ├── nestjs_guide.md
|
||
│ ├── naming_convention.md
|
||
│ ├── git_commit_guide.md
|
||
│ ├── AI辅助开发规范指南.md
|
||
│ └── TESTING.md
|
||
│
|
||
└── deployment/ # 🚀 部署文档
|
||
└── DEPLOYMENT.md
|
||
```
|
||
|
||
## 🎯 **文档特色**
|
||
|
||
### ✨ **业务功能模块化**
|
||
文档结构与代码架构保持一致，按业务功能组织：
|
||
- **用户认证模块** - 登录、注册、密码管理
|
||
- **用户管理模块** - 状态管理、批量操作
|
||
- **管理员模块** - 后台管理、权限控制
|
||
- **安全模块** - 频率限制、维护模式
|
||
|
||
### 📊 **完整API覆盖**
|
||
- **17个API接口** - 涵盖所有业务功能
|
||
- **交互式文档** - Swagger UI实时测试
|
||
- **标准化规范** - OpenAPI 3.0标准
|
||
- **测试集合** - Postman一键导入
|
||
|
||
### 🔧 **开发者友好**
|
||
- **规范指导** - 命名、提交、开发规范
|
||
- **AI辅助** - 提升开发效率的AI使用指南
|
||
- **测试覆盖** - 140个测试用例全覆盖
|
||
- **部署就绪** - 生产环境部署指南
|
||
|
||
## 📝 **文档维护原则**
|
||
|
||
### ✅ **保留的文档类型**
|
||
- **长期有用**：对整个项目生命周期都有价值的文档
|
||
- **参考价值**：开发、部署、维护时需要查阅的文档
|
||
- **规范指南**：团队协作和代码质量保证的规范
|
||
|
||
### ❌ **不保留的文档类型**
|
||
- **阶段性文档**：只在特定开发阶段有用的文档
|
||
- **临时记录**：会议记录、临时决策等
|
||
- **过时信息**：已经不适用的旧版本文档
|
||
|
||
### 🔄 **文档更新策略**
|
||
- **及时更新**：功能变更时同步更新相关文档
|
||
- **版本控制**：重要变更记录版本历史
|
||
- **定期审查**：定期检查文档的准确性和有效性
|
||
|
||
## 🤝 **如何贡献文档**
|
||
|
||
1. **发现问题**：发现文档错误或缺失时，请提交Issue
|
||
2. **改进文档**：按照项目规范提交Pull Request
|
||
3. **新增文档**：新功能开发时同步编写相关文档
|
||
4. **审查文档**：参与文档审查，确保质量和准确性
|
||
|
||
---
|
||
|
||
📧 **联系我们**：如有文档相关问题，请通过项目Issue或邮件联系维护团队。 |