2025-09-10 17:34:56 +08:00
|
|
|
|
# 结伴客项目文档目录
|
|
|
|
|
|
|
2025-09-18 19:52:08 +08:00
|
|
|
|
## 核心文档
|
|
|
|
|
|
|
|
|
|
|
|
### 产品需求
|
|
|
|
|
|
- [产品需求文档](./requirements.md) - 小程序核心功能需求
|
|
|
|
|
|
- [官网需求文档](./website_requirements.md) - 官方网站产品需求
|
|
|
|
|
|
|
|
|
|
|
|
### 技术文档
|
|
|
|
|
|
- [系统架构文档](./architecture.md) - 整体技术架构设计
|
|
|
|
|
|
- [详细设计文档](./detailed_design.md) - 数据库和API详细设计
|
|
|
|
|
|
- [API接口文档](./API_DOCS.md) - 完整的API接口说明
|
|
|
|
|
|
- [数据库设计](./database-design.md) - 数据库表结构和关系
|
|
|
|
|
|
|
|
|
|
|
|
### 开发文档
|
|
|
|
|
|
- [开发计划](./development_plan.md) - 项目开发排期和任务分解
|
|
|
|
|
|
- [部署指南](./DEPLOYMENT.md) - 系统部署和运维指南
|
|
|
|
|
|
- [开发规范](./DEVELOPMENT_GUIDE.md) - 代码规范和开发流程
|
|
|
|
|
|
|
|
|
|
|
|
### 其他文档
|
|
|
|
|
|
- [测试用例](./TEST_CASES.md) - 功能测试用例
|
|
|
|
|
|
- [用户手册](./USER_MANUAL.md) - 最终用户使用指南
|
|
|
|
|
|
- [常见问题](./FAQ.md) - 常见问题解答
|
|
|
|
|
|
|
|
|
|
|
|
## 文档维护
|
|
|
|
|
|
|
|
|
|
|
|
所有文档均使用Markdown格式编写，保持实时更新。建议阅读顺序：
|
|
|
|
|
|
1. 产品需求文档 → 2. 系统架构文档 → 3. 详细设计文档 → 4. API接口文档
|
|
|
|
|
|
|
|
|
|
|
|
## 版本控制
|
|
|
|
|
|
|
|
|
|
|
|
文档版本与代码版本保持一致，重大变更需要更新版本历史记录。
|
|
|
|
|
|
|
2025-09-10 17:34:56 +08:00
|
|
|
|
## 📚 文档列表
|
|
|
|
|
|
|
|
|
|
|
|
### Java微服务版本文档
|
|
|
|
|
|
|
|
|
|
|
|
| 文档 | 描述 | 最后更新 |
|
|
|
|
|
|
|------|------|----------|
|
|
|
|
|
|
| [架构设计文档](architecture-java.md) | 系统整体架构设计 | 2025-09-10 |
|
|
|
|
|
|
| [API接口文档](API_DOCS_JAVA.md) | 所有API接口详细说明 | 2025-09-10 |
|
|
|
|
|
|
| [数据库设计文档](database-design-java.md) | 数据库表结构和关系设计 | 2025-09-10 |
|
|
|
|
|
|
| [部署指南](DEPLOYMENT_JAVA.md) | 项目部署和运维指南 | 2025-09-10 |
|
|
|
|
|
|
| [性能优化指南](PERFORMANCE_OPTIMIZATION_JAVA.md) | 系统性能优化建议 | 2025-09-10 |
|
|
|
|
|
|
| [开发指南](DEVELOPMENT_GUIDE_JAVA.md) | 开发者入门和开发规范 | 2025-09-10 |
|
|
|
|
|
|
| [更新日志](CHANGELOG_JAVA.md) | 版本更新和变更记录 | 2025-09-10 |
|
|
|
|
|
|
|
|
|
|
|
|
### Node.js版本文档 (已废弃)
|
|
|
|
|
|
|
|
|
|
|
|
| 文档 | 描述 | 最后更新 |
|
|
|
|
|
|
|------|------|----------|
|
|
|
|
|
|
| [架构设计文档](architecture.md) | 系统整体架构设计 | 2024-01-01 |
|
|
|
|
|
|
| [API接口文档](API_DOCS.md) | 所有API接口详细说明 | 2024-01-01 |
|
|
|
|
|
|
| [数据库设计文档](database-design.md) | 数据库表结构和关系设计 | 2024-01-01 |
|
|
|
|
|
|
| [部署指南](DEPLOYMENT.md) | 项目部署和运维指南 | 2024-01-01 |
|
|
|
|
|
|
|
|
|
|
|
|
## 🗂️ 文档分类
|
|
|
|
|
|
|
|
|
|
|
|
### 系统设计文档
|
|
|
|
|
|
- [架构设计文档](architecture-java.md) - 系统整体架构、技术选型、组件关系
|
|
|
|
|
|
- [数据库设计文档](database-design-java.md) - 数据库表结构、ER图、索引设计
|
|
|
|
|
|
|
|
|
|
|
|
### 开发文档
|
|
|
|
|
|
- [API接口文档](API_DOCS_JAVA.md) - RESTful API详细说明、请求响应格式
|
|
|
|
|
|
- [开发指南](DEVELOPMENT_GUIDE_JAVA.md) - 开发环境搭建、编码规范、测试指南
|
|
|
|
|
|
|
|
|
|
|
|
### 运维文档
|
|
|
|
|
|
- [部署指南](DEPLOYMENT_JAVA.md) - 环境要求、部署步骤、容器化部署
|
|
|
|
|
|
- [性能优化指南](PERFORMANCE_OPTIMIZATION_JAVA.md) - JVM调优、数据库优化、缓存策略
|
|
|
|
|
|
|
|
|
|
|
|
### 项目管理文档
|
|
|
|
|
|
- [更新日志](CHANGELOG_JAVA.md) - 版本变更记录、功能新增、问题修复
|
|
|
|
|
|
|
|
|
|
|
|
## 🚀 快速开始
|
|
|
|
|
|
|
|
|
|
|
|
### 1. 了解系统架构
|
|
|
|
|
|
首先阅读 [架构设计文档](architecture-java.md) 了解系统整体设计和技术栈。
|
|
|
|
|
|
|
|
|
|
|
|
### 2. 搭建开发环境
|
|
|
|
|
|
按照 [开发指南](DEVELOPMENT_GUIDE_JAVA.md) 搭建本地开发环境。
|
|
|
|
|
|
|
|
|
|
|
|
### 3. 学习API接口
|
|
|
|
|
|
查看 [API接口文档](API_DOCS_JAVA.md) 了解系统提供的所有接口。
|
|
|
|
|
|
|
|
|
|
|
|
### 4. 部署系统
|
|
|
|
|
|
参考 [部署指南](DEPLOYMENT_JAVA.md) 将系统部署到服务器。
|
|
|
|
|
|
|
|
|
|
|
|
## 📝 文档维护
|
|
|
|
|
|
|
|
|
|
|
|
### 更新流程
|
|
|
|
|
|
1. 修改相应文档文件
|
|
|
|
|
|
2. 提交Pull Request
|
|
|
|
|
|
3. 团队审查后合并
|
|
|
|
|
|
|
|
|
|
|
|
### 贡献指南
|
|
|
|
|
|
欢迎提交Issue和Pull Request来改进文档。
|
|
|
|
|
|
|
|
|
|
|
|
## 📞 联系我们
|
|
|
|
|
|
|
|
|
|
|
|
- 📧 邮箱: support@jiebanke.com
|
|
|
|
|
|
- 🌐 官网: https://www.jiebanke.com
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
*最后更新: 2025年9月10日* 📅
|
