# 项目文档索引 ## 架构文档 ### 技师端 (Coach) - [技师端架构说明](architecture/coach/README.md) - 技师端整体架构设计 - 用户与技师关系 - 技师认证与审核 - API 接口规范 - 数据库设计 - 开发规范 ### 用户端 (Client) - [用户端架构说明](architecture/client/README.md) - 用户端整体架构设计 - 待补充... ### 管理端 (Admin) - [管理端架构说明](architecture/admin/README.md) - 管理端整体架构设计 - 待补充... ## 数据库文档 ### 数据库设计 - [数据库表结构](database/schemas/README.md) - 数据库物理模型设计 - 待补充... ## API 文档 ### 技师端 API - [技师端 API 文档](api/coach/README.md) - 技师端 API 接口文档 - 待补充... ### 用户端 API - [用户端 API 文档](api/client/README.md) - 用户端 API 接口文档 - 待补充... ### 管理端 API - [管理端 API 文档](api/admin/README.md) - 管理端 API 接口文档 - 待补充... ## 目录结构 ``` docs/ ├── architecture/ # 架构文档目录 │ ├── client/ # 用户端架构 │ ├── coach/ # 技师端架构 │ │ ├── README.md # 技师端架构概览 │ │ ├── auth.md # 认证相关架构 │ │ ├── api.md # API接口规范 │ │ └── database.md # 数据库设计 │ └── admin/ # 管理端架构 ├── database/ # 数据库文档 │ └── schemas/ # 数据库表结构 ├── api/ # API文档 │ ├── client/ # 用户端API │ ├── coach/ # 技师端API │ └── admin/ # 管理端API └── README.md # 文档索引 ``` ## 文档更新记录 | 日期 | 更新内容 | 更新人 | | ---------- | ------------------ | ------ | | 2024-01-xx | 初始化文档结构 | xxx | | 2024-01-xx | 添加技师端架构说明 | xxx | ## 注意事项 1. 文档更新规范: - 保持文档的及时性和准确性 - 重要更新需要在更新记录中注明 - 文档变更需要经过审核 2. 文档编写规范: - 使用 Markdown 格式 - 保持统一的文档结构 - 代码示例需要注释说明 3. 文档管理: - 定期检查文档有效性 - 及时清理过期文档 - 保持文档间的链接有效