结伴客项目文档目录
核心文档
产品需求
技术文档
开发文档
其他文档
文档维护
所有文档均使用Markdown格式编写，保持实时更新。建议阅读顺序：
- 产品需求文档 → 2. 系统架构文档 → 3. 详细设计文档 → 4. API接口文档
版本控制
文档版本与代码版本保持一致，重大变更需要更新版本历史记录。
📚 文档列表
Java微服务版本文档
| 文档 | 描述 | 最后更新 |
|---|---|---|
| 架构设计文档 | 系统整体架构设计 | 2025-09-10 |
| API接口文档 | 所有API接口详细说明 | 2025-09-10 |
| 数据库设计文档 | 数据库表结构和关系设计 | 2025-09-10 |
| 部署指南 | 项目部署和运维指南 | 2025-09-10 |
| 性能优化指南 | 系统性能优化建议 | 2025-09-10 |
| 开发指南 | 开发者入门和开发规范 | 2025-09-10 |
| 更新日志 | 版本更新和变更记录 | 2025-09-10 |
Node.js版本文档 (已废弃)
| 文档 | 描述 | 最后更新 |
|---|---|---|
| 架构设计文档 | 系统整体架构设计 | 2024-01-01 |
| API接口文档 | 所有API接口详细说明 | 2024-01-01 |
| 数据库设计文档 | 数据库表结构和关系设计 | 2024-01-01 |
| 部署指南 | 项目部署和运维指南 | 2024-01-01 |
🗂️ 文档分类
系统设计文档
开发文档
运维文档
项目管理文档
- 更新日志 - 版本变更记录、功能新增、问题修复
🚀 快速开始
1. 了解系统架构
首先阅读 架构设计文档 了解系统整体设计和技术栈。
2. 搭建开发环境
按照 开发指南 搭建本地开发环境。
3. 学习API接口
查看 API接口文档 了解系统提供的所有接口。
4. 部署系统
参考 部署指南 将系统部署到服务器。
📝 文档维护
更新流程
- 修改相应文档文件
- 提交Pull Request
- 团队审查后合并
贡献指南
欢迎提交Issue和Pull Request来改进文档。
📞 联系我们
- 📧 邮箱: support@jiebanke.com
- 🌐 官网: https://www.jiebanke.com
最后更新: 2025年9月10日 📅